Configurations

The application's default behaviour can be altered with configuration settings. This document provides a quick overview about it.

Websocket Max Message Size

QuickRetro uses Websockets for communication. This configuration setting controls the max allowed size in bytes for all data sent through the websocket.

In src/config.toml, update the value for max_message_size_bytes

[websocket]
# Maximum message size (in bytes) allowed from peer for the websocket connection (also used by frontend)
max_message_size_bytes = 1024

Auto-Delete Duration

By default, data is deleted within 2 days in Redis. This can be changed by making the below modification.
In the src/config.toml file, update the value for auto_delete_duration

[data]
# Format: <number><unit>
# Units: s=seconds, m=minutes, h=hours, d=days
# Examples: "50s" for 50 seconds, "5m" for 5 minutes, "2h" for 2 hours, "7d" for 7 days
auto_delete_duration = "2d"

Max Category Text Length and Max Text Length

Available from v1.6.0v1.6.3

In src/config.toml file, control the number of characters allowed for each column name by setting max_category_text_length
Set the limit for number of characters allowed for Board name, Team name, Nickname with max_text_length
Default is 80 for both.

[data]
# Maximum number of characters allowed for each category name (also used by frontend)
max_category_text_length = 80
# Maximum number of characters allowed for board name, team name, nickname (also used by frontend)
max_text_length = 80

IMPORTANT

Changing this also impacts the value defined in Websocket Max Message Size section. Ensure that whatever value is set, the websocket message/payload size doesn't exceed from what has been defined in mentioned section.

Allowed Origins

Update the allowed_origins config setting in src/config.toml to add some degree of protection to the websocket connection.
You will typically update this setting when self-hosting.

[server]
# When self-hosting, add your domain to allowed_origins list.
# For e.g. if you are hosting your site at https://example.com, allowed_origins will look like -
# allowed_origins = [
#     "https://example.com"
# ]
allowed_origins = [
    "http://localhost:8080",
    "https://localhost:8080",
    "http://localhost:5173",
    "https://localhost",
    "https://quickretro.app",
    "https://demo.quickretro.app"
]

Running in a different Port

By default, the app starts at port 8080
To run in a different port, for e.g. 9090, change the value of ENV variable named PORT in .env file

PORT=9090
REDIS_CONNSTR=<YOUR_REDIS_CONNECTION_STRING>
TURNSTILE_ENABLED=true
TURNSTILE_SITE_KEY=<YOUR_SITE_KEY>
TURNSTILE_SECRET_KEY=<YOUR_SECRET_KEY>

Whitelist the new port, by changing the default port (or adding new entries in the list) in the Allowed Origins section in the src/config.toml file

[server]
# When self-hosting, add your domain to allowed_origins list.
# For e.g. if you are hosting your site at https://example.com, allowed_origins will look like -
# allowed_origins = [
#     "https://example.com"
# ]
allowed_origins = [
    "http://localhost:9090",
    "https://localhost:9090",
    "http://localhost:5173",
    "https://localhost",
    "https://quickretro.app",
    "https://demo.quickretro.app"
]

This is enough to run the app in port 9090 using docker compose.

Connect frontend app to new port during development

During development, you may need to run the Vue frontend outside the docker container. While the above change works when the app is built and run entirely in a docker container with Docker Compose, the Vue frontend won't automatically connect to the newly changed port 9090 running inside the docker container.

Change value of VITE env variable VITE*API_BASE_URL in src/frontend/.env to make the frontend(_running outside of docker*) connect to backend(running inside docker container with new port 9090 exposed to host).

VITE_SHOW_CONSOLE_LOGS=false
VITE_TURNSTILE_SCRIPT_URL=https://challenges.cloudflare.com/turnstile/v0/api.js
VITE_API_BASE_URL=http://localhost:9090

TIP

The repo has some examples with CaddyFile, which uses 8080. If using CaddyServer, remember to update it to 9090 as well.

Connecting to Redis

The Go app always attempts to connect to Redis when its starts. It errors out if connecting to Redis fails. The app looks for an ENV variable named REDIS_CONNSTR for the connection details.

The Redis ACL username and password can be passed as part of the url to REDIS_CONNSTR.

Enable Cloudflare Turnstile

Turnstile is a smart CAPTCHA alternative from Cloudflare used to prevent bots. It is disabled by default for the Create board page.

To enable it, set the TURNSTILE_ENABLED, TURNSTILE_SITE_KEY and TURNSTILE_SECRET_KEY environment variables.

PORT=8080
REDIS_CONNSTR=<YOUR_REDIS_CONNECTION_STRING>
TURNSTILE_ENABLED=true
TURNSTILE_SITE_KEY=<YOUR_SITE_KEY>
TURNSTILE_SECRET_KEY=<YOUR_SECRET_KEY>

TIP

You need to register with Cloudflare to get TURNSTILE_SITE_KEY and TURNSTILE_SECRET_KEY. Visit Cloudflare for more details.

Content limit notification delay

Available from v1.6.3

Set a reasonable value to content_editable_invalid_debounce_ms in src/config.toml to prevent the user from getting bombarded with notification messages on every keystroke, when content limit is breached in Cards or Comments

[frontend]
# Delay (in milliseconds) before showing "message size limit reached" notification for cards/comments
content_editable_invalid_debounce_ms = 500

Typing indicators

Available from v1.6.3

Enable and control a "User is typing" indicator that appears as a pulse animation on a User's avatar in the Dashboard's right panel with the below settings.

What each setting does is defined in comments in src/config.toml

# ---------------------------------------------------------------------------------------------------
# Typing Activity Notifications
# Controls the real-time "user is typing" activity indicator shown on avatars during a retro session.
# ---------------------------------------------------------------------------------------------------
[typing_activity]
# Enable or disable typing activity notifications globally (also used by frontend)
enabled = true
# Automatically disable dispatch of "typing" events in the frontend when
# the number of other active users(excluding current user) in a board exceeds this value.
# Set to 0 (or a negative value) to disable this limit. (only used by frontend)
auto_disable_after_count = 15
# Minimum time (in milliseconds) between consecutive "typing" events emitted by the same client. (only used by frontend)
# This acts as a throttle to:
# - Reduce WebSocket noise
# - Prevent excessive broadcasts while a user is actively typing for a long time
emit_throttle_ms = 3000
# Time (in milliseconds) after which the typing indicator is automatically cleared if no new typing event is received. (only used by frontend)
display_timeout_ms = 2000

Frequently Asked Questions

How do I change the default port?

Update the PORT env variable via .env file, and update allowed_origins in config.toml to include your new port.

How can I prevent bots from creating boards?

Enable the Cloudflare Turnstile integration by providing the required site key and secret key in your environment variables.