Skip to main content
Version: 3.17

Environment Variables

Docker Compose​

COMPOSE_PROJECT_NAME​

Project name for Docker Compose (used as prefix for containers/networks)

  • Default Value: ps

COMPOSE_FILE​

  • Default Value: docker-compose.yml

PHRASEA_DOMAIN​

Main domain for Phrasea services

  • Default Value: "${PHRASEA_DOMAIN:-phrasea.local}"

DATABOX_WORKER_REPLICAS​

Worker replicas

  • Default Value: 1

REGISTRY_NAMESPACE​

  • Default Value: alchemyfr/ps-

DOCKER_TAG​

Phrasea Docker image TAG

  • Default Value: latest

TRUSTED_PROXIES​

  • Default Value: 127.0.0.1,REMOTE_ADDR

SOKETI_APP_ID​

  • Default Value: phrasea

SOKETI_KEY​

⚠️ This variable must be set/changed. Please ensure to set it to a secure value in production environments.

  • Default Value: __CHANGE_ME_hJBgAG4vnPrT58Ty

SOKETI_SECRET​

⚠️ This variable must be set/changed. Please ensure to set it to a secure value in production environments.

  • Default Value: __CHANGE_ME_A8PRgk5qpfLxkfLU

Development Environment Settings​

LOCAL_DIR​

Working directory inside the dev container Path inside dev containers for mounting source code

  • Default Value: phrasea

DEV_MODE​

Enables some features for debugging applications

  • Default Value: false

DEV_PHP_MEMORY_LIMIT​

Increase PHP memory limit for dev environment

  • Default Value: 128M

DB_DEV_PORT​

  • Default Value: 5432

XDEBUG_SESSION​

  • Default Value: PHPSTORM

SSH_AUTH_SOCK​

For dev who don't have SSH_AUTH_SOCK (avoid an empty volume name)

  • Default Value: /dev/null

VERIFY_SSL​

  • Default Value: true

Traefik Reverse Proxy Settings​

TRAEFIK_IMAGE​

Traefik Docker image

  • Default Value: traefik:3.2.1

HTTPS_PORT_PREFIX​

HTTPS port prefix for URLs (leave empty for default 443, include ':' otherwise)

  • Default Value: ${HTTPS_PORT_PREFIX:-}
  • Example: :8443

TRAEFIK_HTTPS_PORT​

HTTPS port for Traefik reverse proxy

  • Default Value: 443

TRAEFIK_HTTP_PORT​

HTTP port for Traefik reverse proxy

  • Default Value: 80

TRAEFIK_PROVIDERS_FILE_FILENAME​

Traefik dynamic config file path

  • Default Value: /etc/traefik/dynamic_conf.yaml

LETS_ENCRYPT_ENABLED​

Enable Let's Encrypt for automatic SSL certificates

  • Type: boolean
  • Default Value: Unset

LETS_ENCRYPT_CONTACT_EMAIL​

Email for Let's Encrypt registration

  • Default Value: contact@acme.com

LETS_ENCRYPT_PROVIDER​

  • Default Value: Unset
  • Example: gandi, ovh, route53

LETS_ENCRYPT_CA_SERVER​

CA server URL (use staging for testing)

  • Default Value: https://acme-staging-v02.api.letsencrypt.org/directory
  • Example: https://acme-v02.api.letsencrypt.org/directory

LEGO_GANDIV5_API_KEY​

  • Default Value: Unset

LEGO_AWS_ACCESS_KEY_ID​

route53

  • Default Value: Unset

Security Settings​

ADMIN_BASIC_AUTH_USER​

Basic Auth for Traefik dashboard Generate with: echo $(htpasswd -nb admin 'my-secret-password')

⚠️ This variable must be set/changed. Please ensure to set it to a secure value in production environments.

  • Default Value: 'admin:$apr1$NQnkSxTR$EvypdHPASANYEW5F4et7a/'
  • Default raw secret: gG2dLohfNrfcSeRHivm3

EXPOSE_ALLOWED_FRAME_ANCESTORS​

CSP

  • Default Value: Unset

Application Settings​

APP_ENV​

Symfony env var

  • Default Value: prod

DISPLAY_SERVICES_MENU​

  • Type: boolean
  • Default Value: true

UPLOAD_MAX_FILE_SIZE​

  • Default Value: 4G

Service URLs​

DASHBOARD_CLIENT_URL​

Base URLs for services (auto-generated using PHRASEA_DOMAIN and HTTPS_PORT_PREFIX) Dashboard client URL

  • Default Value: https://dashboard.${PHRASEA_DOMAIN}${HTTPS_PORT_PREFIX}

S3_ENDPOINT​

MinIO S3 endpoint

  • Default Value: https://minio.${PHRASEA_DOMAIN}${HTTPS_PORT_PREFIX}

UPLOADER_API_URL​

Uploader API URL

  • Default Value: https://api-uploader.${PHRASEA_DOMAIN}${HTTPS_PORT_PREFIX}

EXPOSE_API_URL​

Expose API URL

  • Default Value: https://api-expose.${PHRASEA_DOMAIN}${HTTPS_PORT_PREFIX}

DATABOX_API_URL​

Databox API URL

  • Default Value: https://api-databox.${PHRASEA_DOMAIN}${HTTPS_PORT_PREFIX}

DATABOX_CLIENT_URL​

Databox client URL

  • Default Value: https://databox.${PHRASEA_DOMAIN}${HTTPS_PORT_PREFIX}

EXPOSE_CLIENT_URL​

Expose client URL

  • Default Value: https://expose.${PHRASEA_DOMAIN}${HTTPS_PORT_PREFIX}

UPLOADER_CLIENT_URL​

Uploader client URL

  • Default Value: https://uploader.${PHRASEA_DOMAIN}${HTTPS_PORT_PREFIX}

ZIPPY_URL​

Zippy URL

  • Default Value: https://zippy.${PHRASEA_DOMAIN}${HTTPS_PORT_PREFIX}

MINIO_CONSOLE_URL​

MinIO console URL

  • Default Value: https://minio-console.${PHRASEA_DOMAIN}${HTTPS_PORT_PREFIX}

MAILHOG_URL​

MailHog URL

  • Default Value: https://mailhog.${PHRASEA_DOMAIN}${HTTPS_PORT_PREFIX}

PGADMIN_URL​

pgAdmin URL

  • Default Value: https://pgadmin.${PHRASEA_DOMAIN}${HTTPS_PORT_PREFIX}

PHPMYADMIN_URL​

phpMyAdmin URL

  • Default Value: https://pma.${PHRASEA_DOMAIN}${HTTPS_PORT_PREFIX}

RABBITMQ_CONSOLE_URL​

RabbitMQ console URL

  • Default Value: https://rabbitmq-console.${PHRASEA_DOMAIN}${HTTPS_PORT_PREFIX}

TRAEFIK_CONSOLE_URL​

Traefik console URL

  • Default Value: https://traefik-console.${PHRASEA_DOMAIN}${HTTPS_PORT_PREFIX}

SOKETI_USAGE_URL​

Soketi usage URL

  • Default Value: https://soketi-usage.${PHRASEA_DOMAIN}${HTTPS_PORT_PREFIX}/usage

ELASTICHQ_URL​

ElasticHQ URL

  • Default Value: https://elastichq.${PHRASEA_DOMAIN}${HTTPS_PORT_PREFIX}

DATABOX_INDEXER_URL​

Databox indexer URL

  • Default Value: https://databox-indexer.${PHRASEA_DOMAIN}${HTTPS_PORT_PREFIX}

REPORT_API_URL​

Report API URL

  • Default Value: http://report-api

KEYCLOAK_URL​

  • Default Value: "${KEYCLOAK_URL:-https://keycloak.$PHRASEA_DOMAIN$HTTPS_PORT_PREFIX}"

Dashboard Settings​

DASHBOARD_CLIENT_ID​

  • Default Value: dashboard-app

S3-Compatible Storage Settings​

S3_USE_PATH_STYLE_ENDPOINT​

  • Default Value: true

S3_ACCESS_KEY​

⚠️ This variable must be set/changed. Please ensure to set it to a secure value in production environments.

  • Default Value: __CHANGE_ME_LDb7v4BfKXE5vTnslDvNyeWMlMmi

S3_SECRET_KEY​

⚠️ This variable must be set/changed. Please ensure to set it to a secure value in production environments.

  • Default Value: __CHANGE_ME_ZFA0x96WHJztksXrKUHYUA

S3_PATH_PREFIX​

Can be used to support a single CloudFront distribution with multiple origins

  • Default Value: Unset

Authentication and Identity Provider Settings​

AUTO_CONNECT_IDP​

Auto redirect to identity provider when coming from a client app

  • Default Value: Unset

KEYCLOAK_REALM_NAME​

  • Default Value: "${KEYCLOAK_REALM_NAME:-phrasea}"

KEYCLOAK_DB_NAME​

  • Default Value: keycloak

KEYCLOAK_ADMIN_PASSWORD​

⚠️ This variable must be set/changed. Please ensure to set it to a secure value in production environments.

  • Default Value: __CHANGE_ME_rTLDzTAFiFIQiHDm

DEFAULT_ADMIN_USERNAME​

  • Default Value: phrasea-admin

DEFAULT_ADMIN_EMAIL​

⚠️ This variable must be set/changed. Please ensure to set it to a secure value in production environments.

  • Default Value: Unset

DEFAULT_ADMIN_PASSWORD​

⚠️ This variable must be set/changed. Please ensure to set it to a secure value in production environments.

  • Default Value: __CHANGE_ME_CAZ7B1ZP4os2kZPL

KC_LOGIN_CSS_BACKGROUND​

  • Default Value: "#f1f1f1"
  • Example: url(https://static.com/pattern.jpg) #f1f1f1 no-repeat center center fixed

KC_LOGIN_CSS_LOGO_BACKGROUND​

  • Default Value: "url('../../img/logo.png') no-repeat 40% 65%"

KC_REALM_SUPPORTED_LOCALES​

  • Default Value: fr,en

KC_REALM_HTML_DISPLAY_NAME​

  • Default Value: '<div class="kc-logo-text"><span>Phrasea Auth</span></div>'

KEYCLOAK2_DB_NAME​

for second Identity Provider

  • Default Value: keycloak2

KEYCLOAK2_ADMIN_PASSWORD​

⚠️ This variable must be set/changed. Please ensure to set it to a secure value in production environments.

  • Default Value: __CHANGE_ME_wijk8OdBY4MW4rTc

SAML_URL​

SAML IDP Test 1

  • Default Value: https://saml-idp.${PHRASEA_DOMAIN}/simplesaml

SAML2_URL​

SAML IDP Test 2

  • Default Value: https://saml-idp2.${PHRASEA_DOMAIN}/simplesaml

Databox Service Settings​

DATABOX_WORKER_CPU_LIMIT​

  • Default Value: 2

IMAGICK_VERSION​

ImageMagick settings

  • Default Value: 3.8.0

DATABOX_S3_BUCKET_NAME​

  • Default Value: databox

DATABOX_CLOUD_FRONT_URL​

  • Default Value: Unset

DATABOX_SECRETS_PUBLIC_KEY​

⚠️ This variable must be set/changed. Please ensure to set it to a secure value in production environments.

  • Default Value: j0J1OtLTd78OVhVMEQwd+98EusYkAdN8VNhHIENLlWI=

DATABOX_ALLOWED_FILE_TYPES​

Allowed file types for Databox

  • Default Value: 'image/*(.jpg,.jpeg,.bmp,.tif,.gif,.png,.heic,.webp,.svg,.psd,.psb),application/*(.pdf,.doc,.docx,.xls,.xlsx,.odt,.psd,.psb),video/*(.mpg,.mpeg,.mov,.avi,.mp3,.mp2,.mp4,.m4v,.m4a,.mkv,.hevc)audio/*(.aac,.aiff,.wav)'

DATABOX_CLIENT_ID​

OAuth client ID for Databox service

  • Default Value: databox-app

DATABOX_ADMIN_CLIENT_ID​

  • Default Value: databox-admin

DATABOX_ADMIN_CLIENT_SECRET​

⚠️ This variable must be set/changed. Please ensure to set it to a secure value in production environments.

  • Default Value: __CHANGE_ME_cli3nt_s3cr3t

Uploader Service Settings​

UPLOADER_CLIENT_ID​

OAuth client ID

  • Default Value: uploader-app

UPLOADER_S3_BUCKET_NAME​

  • Default Value: uploader-deposit

UPLOADER_ADMIN_CLIENT_ID​

  • Default Value: uploader-admin

UPLOADER_ADMIN_CLIENT_SECRET​

⚠️ This variable must be set/changed. Please ensure to set it to a secure value in production environments.

  • Default Value: __CHANGE_ME_cli3nt_s3cr3t

Expose Service Settings​

EXPOSE_ADMIN_CLIENT_ID​

For admin OAuth clients

  • Default Value: expose-admin

EXPOSE_ADMIN_CLIENT_SECRET​

⚠️ This variable must be set/changed. Please ensure to set it to a secure value in production environments.

  • Default Value: __CHANGE_ME_cli3nt_s3cr3t

EXPOSE_CLIENT_ID​

OAuth client ID for Expose service

  • Default Value: expose-app

EXPOSE_S3_BUCKET_NAME​

  • Default Value: expose

MAPBOX_TOKEN​

  • Default Value: define-me

RabbitMQ Message Broker Settings​

RABBITMQ_IMAGE​

RabbitMQ Docker image

  • Default Value: rabbitmq:3.13.7-management

RABBITMQ_USER​

⚠️ This variable must be set/changed. Please ensure to set it to a secure value in production environments.

  • Default Value: __CHANGE_ME_3b1wnDcU3z

RABBITMQ_PASSWORD​

⚠️ This variable must be set/changed. Please ensure to set it to a secure value in production environments.

  • Default Value: __CHANGE_ME_klvA23rVuZY2

Soketi WebSocket Server Settings​

SOKETI_IMAGE​

Soketi Docker image

  • Default Value: quay.io/soketi/soketi:330e1a60197d2b5798a3b3a2bcd211ec124148d8-16-alpine

MinIO S3 Settings​

MINIO_IMAGE​

MinIO Docker image

  • Default Value: minio/minio:RELEASE.2021-11-24T23-19-33Z.hotfix.1d85a4563

Database Settings​

POSTGRES_IMAGE​

PostgreSQL Docker image

  • Default Value: postgres:14.4-alpine

POSTGRES_USER​

⚠️ This variable must be set/changed. Please ensure to set it to a secure value in production environments.

  • Default Value: __CHANGE_ME_QmkpoE6I42px1

POSTGRES_PASSWORD​

⚠️ This variable must be set/changed. Please ensure to set it to a secure value in production environments.

  • Default Value: __CHANGE_ME_n0EQbOzeEQC1

PGADMIN_DEFAULT_EMAIL​

don't use .local in email https://github.com/pgadmin-org/pgadmin4/issues/6222

  • Default Value: admin@phrasea.io

PGADMIN_DEFAULT_PASSWORD​

⚠️ This variable must be set/changed. Please ensure to set it to a secure value in production environments.

  • Default Value: __CHANGE_ME_eTRPkJOyniPHmZ

DATABOX_DB_NAME​

  • Default Value: databox

MARIADB_HOST​

  • Default Value: mariadb

MARIADB_ROOT_PASSWORD​

⚠️ This variable must be set/changed. Please ensure to set it to a secure value in production environments.

  • Default Value: __CHANGE_ME_9s0EQbeEn0EQbQC1

MARIADB_USER​

⚠️ This variable must be set/changed. Please ensure to set it to a secure value in production environments.

  • Default Value: __CHANGE_ME_oBiOsCDSY

MARIADB_PASSWORD​

⚠️ This variable must be set/changed. Please ensure to set it to a secure value in production environments.

  • Default Value: __CHANGE_ME_pfdir56eEQC1

REPORT_DB_NAME​

  • Default Value: report

Redis Cache Settings​

REDIS_IMAGE​

Redis Docker image

  • Default Value: redis:7.4.1-alpine3.20

Mail Service Settings​

MAIL_FROM​

  • Default Value: noreply@${PHRASEA_DOMAIN}

Novu Notification Service Settings​

NOVU_VERSION​

  • Default Value: 2.3.0

NOVU_REDIS_HOST​

  • Default Value: redis

NOVU_JWT_SECRET​

⚠️ This variable must be set/changed. Please ensure to set it to a secure value in production environments.

  • Default Value: __CHANGE_ME_8Gt1eIKSWgd7Ex5UMJTmkA

NOVU_SECRET_KEY​

⚠️ This variable must be set/changed. Please ensure to set it to a secure value in production environments.

  • Default Value: __CHANGE_ME_8djg5x5MJTmkA

NOVU_STORE_ENCRYPTION_KEY​

⚠️ This variable must be set/changed. Please ensure to set it to a secure value in production environments.

  • Default Value: __CHANGE_ME_y8cPSNUNvomVxLgdQVp7

NOVU_MONGO_MAX_POOL_SIZE​

  • Default Value: 200

MONGO_INITDB_ROOT_USERNAME​

  • Default Value: root

NOVU_DASHBOARD_USERNAME​

  • Default Value: admin@alchemy.fr

NOVU_DASHBOARD_PASSWORD​

⚠️ This variable must be set/changed. Please ensure to set it to a secure value in production environments.

  • Default Value: __CHANGE_ME_7_a^

Configurator Service Settings​

CONFIGURATOR_DB_NAME​

  • Default Value: configurator

Matomo Analytics Settings​

MATOMO_MYSQL_ROOT_PASSWORD​

⚠️ This variable must be set/changed. Please ensure to set it to a secure value in production environments.

  • Default Value: __CHANGE_ME_JDQm8ooetgjd6q8

MATOMO_DATABASE_PASSWORD​

⚠️ This variable must be set/changed. Please ensure to set it to a secure value in production environments.

  • Default Value: __CHANGE_ME_DyFTHnJO0smgU

MATOMO_SUPER_USER_PASSWORD​

⚠️ This variable must be set/changed. Please ensure to set it to a secure value in production environments.

  • Default Value: __CHANGE_ME_zBpJUAYDTu8

Elasticsearch Settings​

ELASTICSEARCH_IMAGE​

Elasticsearch Docker image

  • Default Value: elasticsearch:7.17.28

Report Service Settings​

ELK_VERSION​

  • Default Value: 7.11.2

Zippy Service Settings​

ZIPPY_CLIENT_ID​

  • Default Value: client

Phraseanet Integration Settings​

PHRASEANET_DOMAIN​

  • Default Value: "${PHRASEANET_DOMAIN:-phraseanet.$PHRASEA_DOMAIN}"

Databox Indexer Settings​

INDEXER_DATABOX_CLIENT_ID​

  • Default Value: indexer

INDEXER_DATABOX_CLIENT_SECRET​

⚠️ This variable must be set/changed. Please ensure to set it to a secure value in production environments.

  • Default Value: __CHANGE_ME_ad9m88kd8rih5

Monitoring and Sentry Settings​

NEWRELIC_ENABLED​

  • Default Value: Unset

PHP_SENTRY_DSN​

  • Default Value: Unset

Uncategorized​

AUTH_DB_NAME (deprecated)​

  • Default Value: auth

cypress​

CYPRESS_BROWSER​

  • Default Value: chrome