Skip to main content

Configure your deployment

Edit .env in your deployment directory. Use the supplied template for the supported variables and initial values. Quote values that contain spaces or shell characters.

Credentials and secrets​

Set DOCKER_REGISTRY_USERNAME, DOCKER_REGISTRY_SECRET, and LICENSE_KEY from your setup email. Replace SESSION_SECRET, MYSQL_PASSWORD, and MYSQL_ROOT_PASSWORD before the first start. Generate a separate value for each secret:

openssl rand -hex 32

Keep SESSION_SECRET stable across updates. Restrict access to the environment file:

chmod 600 .env

Changing a database password in .env does not update an existing MySQL account. Change both together.

Domain and HTTPS​

DOMAIN_NAME=regex101.example.com
OAUTH_ORIGIN=https://regex101.example.com

Use a hostname without a scheme or path for DOMAIN_NAME. If you enable sign-in, set OAUTH_ORIGIN to the HTTPS origin that users open.

Configure HTTPS at your reverse proxy or load balancer. Forward requests to regex101 on HTTP port 80. If your proxy setup requires it, set TRUST_PROXY to the trusted proxy addresses or CIDR ranges.

Versions and storage​

IMAGE_TAG selects the application release. Use a specific release tag for repeatable deployments. Keep the supplied MYSQL_IMAGE_TAG and REDIS_IMAGE_TAG unless you plan a separate database upgrade.

MYSQL_DATA_DIR selects the database directory. Relative paths resolve from your deployment directory. Preserve that directory and your configuration during updates. See Backups.

Optional settings​

VariablePurpose
OAUTH_*Configure sign-in.
SESSION_TTL_MSSet the session duration in milliseconds. The default is 30 days.
API_BODY_LIMIT_MBSet the API request limit from 1 to 16 MB. The default is 10 MB.
MINIMAL_INTERFACE=trueHide header action buttons and new-release notifications.
DISABLED_FEATURESDisable selected features.
ENTERPRISE_RELEASE_MANIFEST_URLSet the destination for version checks.
LICENSE_FILESet the host path to your offline license file.

To connect your AI provider, follow Configure AI Assistant.

Apply a configuration change​

To apply changes with images already on the host, run:

docker compose up -d --pull never --force-recreate

If LICENSE_FILE is set, include its override:

docker compose -f docker-compose.yml -f docker-compose.license-file.yml \
up -d --pull never --force-recreate

Then verify service state with docker compose ps. To install a new release, follow Updates.