Environment variables are defined in the .env file.
Their assignment takes effect according to the state of the stack:
- install
- build
- run
Variables tagged “@deprecated” are deprecated.
Name | Type | Comment |
---|---|---|
COMPOSE_FILE | run |
Define "docker-compose" files to include. |
Name | Type | Comment |
---|---|---|
COMPOSE_PROFILES | none |
Name | Type | Comment |
---|---|---|
PHRASEANET_DOCKER_REGISTRY | run |
Registry from which you pull docker images. Avalaible values:
|
PHRASEANET_DOCKER_TAG | run |
Docker images tag. |
STACK_NAME | run |
Stack Name An optionnal Name for the stack |
Name | Type | Comment |
---|---|---|
WORKER_CPU | none |
|
GATEWAY_CPU | none |
|
FPM_CPU | none |
|
WORKER_MEMORY_LIMIT | none |
|
GATEWAY_MEMORY_LIMIT | none |
|
FPM_MEMORY_LIMIT | none |
|
WORKER_MEMORY_RESERVATION | none |
|
GATEWAY_MEMORY_RESERVATION | none |
|
FPM_MEMORY_RESERVATION | none |
Name | Type | Comment |
---|---|---|
PHRASEA_NETWORK_NAME | run |
Phrasea network Name, the name of Phrasea network and see by traefik |
PHRASEA_DOMAIN | run |
|
PHRASEA_GATEWAY_IP | run |
|
PHRASEA_COMPOSE_PROJECT_NAME | run |
Name | Type | Comment |
---|---|---|
PHRASEANET_INSTALL | run |
Do an installation if Phraseanet is not installed. Avalaible values: "0" | "1" |
PHRASEANET_SETUP | run |
Apply they env variables values to config/configuration.yml file. Avalaible values: "0" | "1" |
PHRASEANET_UPGRADE | run |
Play an upgrade. Avalaible values: "0" | "1" |
PHRASEANET_MAINTENANCE | run |
Maintenance mode show an nginx unavailability message Available values: "0" | "1" 0 - for no maintenance mode 1 - for persisting maintenance mode During an upgrade, the unavailability message is automatically activated with a default message "We are performing scheduled maintenance and will be back online in a few minutes." |
PHRASEANET_MAINTENANCE_MESSAGE | run |
Customize the maintenance message this is possible to customize the displayed maintenance message. Note: space needs to be encoded with space html character, quote and double quote need to be escaped Example : PHRASEANET_MAINTENANCE_MESSAGE=" Under maintenance! More information =\"https://www.yoururl.fr\">here " |
GATEWAY_ALLOWED_IPS | run |
Activate restrictions restrictions can be based on IP and/or password configuration exemple : GATEWAY_ALLOWED_IPS=10.0.0.1,10.0.1.1 GATEWAY_DENIED_IPS=172.1.0.1,172.1.0.2 GATEWAY_USERS="user1:password1,user2:password2" |
GATEWAY_DENIED_IPS | run |
|
GATEWAY_USERS | run |
|
GATEWAY_FASTCGI_HTTPS | run |
https and reverse proxy (on/off) set to on in the case : https behind a proxy |
GATEWAY_CSP | run |
Content Security Policy (CSP) helps to detect and mitigate some types of attacks, including Cross-Site Scripting (XSS). CSP default values are included in the "Gateway" container entrypoint. Use GATEWAY_CSP env var if you want to define yours and/or override Gateway CSP values. GATEWAY_CSP="default-src 'self' 127.0.0.1 https://sockjs-eu.pusher.com:443 wss://ws-eu.pusher.com https://apiws.carrick-skills.com:8443 https://apiws.carrick-flow.com:8443 https://fonts.gstatic.com *.tiles.mapbox.com https://api.mapbox.com https://events.mapbox.com *.axept.io *.matomo.cloud *.newrelic.com *.nr-data.net https://www.googletagmanager.com *.google-analytics.com *.phrasea.io https://apiws.carrick-flow.com:8443 https://apiws.carrick-skills.com:8443 https://maxcdn.bootstrapcdn.com data: ; script-src 'unsafe-inline' 'unsafe-eval' 'self' https://www.gstatic.com *.alchemyasp.com *.axept.io *.matomo.cloud *.newrelic.com https://www.googletagmanager.com https://apiws.carrick-flow.com:8443 https://apiws.carrick-skills.com:8443 https://maxcdn.bootstrapcdn.com data: blob: ; style-src 'self' 'unsafe-inline' https://fonts.gstatic.com https://fonts.googleapis.com https://www.google.com https://www.gstatic.com https://apiws.carrick-flow.com:8443 https://apiws.carrick-skills.com:8443 https://maxcdn.bootstrapcdn.com ; img-src 'self' data: blob: *.tiles.mapbox.com https://axeptio.imgix.net *.cloudfront.net *.phrasea.io *.amazonaws.com https://apiws.carrick-flow.com:8443 https://apiws.carrick-skills.com:8443 https://maxcdn.bootstrapcdn.com https://www.gnu.org/graphics/ ; object-src 'self'; frame-ancestors 'self'" |
Name | Type | Comment |
---|---|---|
RABBITMQ_DEFAULT_USER | run |
RabbitMQ user account : create an account in RabbitMQ container and use it in Phraseanet configuration. |
RABBITMQ_DEFAULT_PASS | run |
RabbitMQ password account. |
RABBITMQ_MANAGEMENT_PORT | run |
RabbitMQ Http interface management port. |
RABBITMQ_HOSTNAME | run |
rabbit hostname, need also for the name of rabbit database dir to avoid random name after dc down/up |
Name | Type | Comment |
---|---|---|
GATEWAY_SEND_TIMEOUT | run |
Value applied to "send_timeout", "keepalive_timeout", "client_header_timeout" and "client_body_timeout" nginx settings. |
GATEWAY_PROXY_TIMEOUT | run |
Timeout for establishing a connection with a proxied server. See documentation. |
GATEWAY_FASTCGI_TIMEOUT | run |
Value applied to "fastcgi_connect_timeout", "fastcgi_read_timeout" and "fastcgi_send_timeout" nginx settings. |
Name | Type | Comment |
---|---|---|
MAX_BODY_SIZE | run |
Maximum request body size for Php and Nginx. Example "1G" |
MAX_INPUT_VARS | run |
Maximum Php input var. See max-input-vars Php documentation. |
MAX_EXECUTION_TIME | run |
Maximum Php execution time in second. See max-execution-time Php documentation. |
MAX_INPUT_TIME | run |
Maximum Php input time in second. See max-input-time Php documentation. |
REQUEST_TERMINATE_TIMEOUT | run |
Php timeout for serving a single request after which the worker process will be killed. This option should be used when the "max_execution_time" ini option does not stop script execution for some reason. A value of "0" means "off". Available units: s(econds)[default], m(inutes), h(ours), or d(ays). |
FPM_MEMORY_LIMIT | none |
Maximum amount of memory a script may consume (128MB) http://php.net/memory-limit |
PHP_CLI_MEMORY_LIMIT | none |
|
OPCACHE_ENABLED | run |
Php Opcache status. See opcache Php documentation. Avalaible values: "0" | "1" |
SESSION_CACHE_LIMITER | run |
Php session cache limiter. See session-cache-limiter Php documentation. Avalaible values: "off" | "on" |
PHP_LOG_LEVEL | run |
Php logging level. See error-reporting Php documentation. Available values: "alert" | "error" | "warning" | "notice" | "debug" |
SESSION_SAVE_HANDLER | run |
PHP Handler used to store/retrieve data. http://php.net/session.save-handler session handler can be "files" and path must be than |
SESSION_SAVE_PATH | run |
|
COOKIE_SECURE | run |
PHP session cookies to be secured only works if the application is under ssl protection |
FPM_PM_TYPE | run |
FPM Choose how the process manager will control the number of child processes. Possible Values: static - a fixed number (pm.max_children) of child processes; dynamic - the number of child processes are set dynamically based on the |
FPM_MAXCHILDREN | run |
FPM The number of child processes to be created when pm is set to 'static' and the maximum number of child processes when pm is set to 'dynamic' or 'ondemand'. |
FPM_STARTSERVERS | run |
FPM The number of child processes created on startup. Note: Used only when pm is set to 'dynamic' |
FPM_MINSPARESERVER | run |
FPM The desired minimum number of idle server processes. Note: Used only when pm is set to 'dynamic' Note: Mandatory when pm is set to 'dynamic' |
FPM_MAXSPARESERVER | run |
FPM The desired maximum number of idle server processes. Note: Used only when pm is set to 'dynamic' Note: Mandatory when pm is set to 'dynamic' |
FPM_MAX_REQUESTS | run |
FPM The number of requests each child process should execute before respawning. |
Name | Type | Comment |
---|---|---|
MYSQL_ROOT_PASSWORD | build |
MySQL root password. |
SERVER_NAME | build |
MySQL server host address. |
MYSQL_MAX_ALLOWED_PACKET | run |
MySQL maximum allowed packet. Value applied to "max_allowed_packet" MySQL server setting. |
MYSQL_MAX_CONNECTION | run |
Value applied to "max_connection" MySQL server setting. |
MYSQL_SLOW_QUERY_LOG | run |
Enable the slow query log to see queries with especially long duration. Value applied to "slow_query_log" MySQL server setting. |
MYSQL_LONG_QUERY_TIME | run |
Value applied to "long_query_time" MySQL server setting. |
MYSQL_QUERY_CACHE_LIMIT | run |
Cache only tiny result sets, so we can fit more in the query cache. Value applied to "query_cache_limit" MySQL server setting. |
MYSQL_QUERY_CACHE_SIZE | run |
Value applied to "query_cache_size" MySQL server setting. |
MYSQL_KEY_BUFFER_SIZE | run |
Value applied to "key_buffer_size" MySQL server setting. |
Name | Type | Comment |
---|---|---|
DB_BACKUP_VOLUME_PATH | run |
Path where the backuped files will be locally stored |
DB_BACKUP_MYSQL_HOST | run |
The database server host |
DB_BACKUP_MYSQL_USER | run |
The database server user |
DB_BACKUP_MYSQL_PASS | run |
The database server pass |
DB_BACKUP_MAX_BACKUPS | run |
The backup file's rotation time in days |
DB_BACKUP_INIT_BACKUP | run |
If set, create a backup when the container starts |
DB_BACKUP_INIT_RESTORE_LATEST | run |
If set, restores latest backup. |
#DB_BACKUP_CRON_TIME | run |
Every day at 03:00 |
DB_BACKUP_CRON_TIME | none |
|
DB_BACKUP_GZIP_LEVEL | run |
Make it small |
Name | Type | Comment |
---|---|---|
PHRASEANET_CACHE_TYPE | run |
Cache setting type can be "redis" or "arraycache" |
PHRASEANET_CACHE_HOST | run |
|
PHRASEANET_CACHE_PORT | run |
|
PHRASEANET_SESSION_TYPE | run |
PHP session management |
PHRASEANET_SESSION_HOST | run |
|
PHRASEANET_SESSION_PORT | run |
Name | Type | Comment |
---|---|---|
ENV_SET_PHRASEANET_PROJECT_NAME | run |
Application title displayed on Phraseanet homepage. Available values:
|
PHRASEANET_PROJECT_NAME | run |
Application title displayed on Phraseanet homepage. Depend on "ENV_SET_PHRASEANET_PROJECT_NAME" variable value. |
PHRASEANET_HOSTNAME | run |
Application static url is made by combining PHRASEANET_SCHEME, PHRASEANET_HOSTNAME and PHRASEANET_APP_PORT An non declarative variable is generated for other uses needed for deploiment (helm for exemple) Domain name used by traefik in Phrasea stack |
PHRASEANET_SCHEME | run |
|
PHRASEANET_APP_PORT | run |
|
PHRASEANET_ADMIN_ACCOUNT_ID | run |
Variables below used to define the first user / email couple : Phraseanet root account ID. If this variable is filled in, "PHRASEANET_ADMIN_ACCOUNT_PASSWORD" variable value will override targeted account ID password each time Phraseanet is started. |
PHRASEANET_ADMIN_ACCOUNT_EMAIL | run |
|
PHRASEANET_ADMIN_ACCOUNT_PASSWORD | run |
|
PHRASEANET_DOWNLOAD_ASYNC | run |
Use Pusher to enable async download. |
PHRASEANET_USER_SESSION_IDLE | run |
User Session duration settings |
PHRASEANET_USER_SESSION_LIFETIME | none |
Name | Type | Comment |
---|---|---|
PHRASEANET_DB_HOST | install |
|
PHRASEANET_DB_PORT | install |
|
PHRASEANET_DB_USER | install |
|
PHRASEANET_DB_PASSWORD | install |
Name | Type | Comment |
---|---|---|
INSTALL_DB_TEMPLATE | install |
|
INSTALL_APPBOX | install |
|
INSTALL_DATABOX | install |
Name | Type | Comment |
---|---|---|
PHRASEANET_AVAILABLE_LANGUAGE | run |
Available languages (list of language code separated by comma). |
PHRASEANET_DEFAULT_LANGUAGE | run |
Default language code. |
Name | Type | Comment |
---|---|---|
PHRASEANET_FFMPEG_TIMEOUT | run |
|
PHRASEANET_FFPROBE_TIMEOUT | run |
|
PHRASEANET_GS_TIMEOUT | run |
|
PHRASEANET_MP4BOX_TIMEOUT | run |
|
PHRASEANET_SWFTOOLS_TIMEOUT | run |
|
PHRASEANET_UNOCON_TIMEOUT | run |
|
PHRASEANET_EXIFTOOL_TIMEOUT | run |
Name | Type | Comment |
---|---|---|
PHRASEANET_RABBITMQ_HOST | run |
|
PHRASEANET_RABBITMQ_PORT | run |
|
PHRASEANET_RABBITMQ_SSL | run |
|
PHRASEANET_RABBITMQ_VHOST | run |
|
PHRASEANET_RABBITMQ_HEARTBEAT | run |
Name | Type | Comment |
---|---|---|
PHRASEANET_ELASTICSEARCH_HOST | install |
They env variables are only used during installation process, edit configuration.yml file or use phraseanet admin GUI to modify them |
PHRASEANET_ELASTICSEARCH_PORT | install |
|
PHRASEANET_ELASTICSEARCH_INDEX | install |
|
PHRASEANET_ELASTICSEARCH_SHARD | install |
|
PHRASEANET_ELASTICSEARCH_REPLICAS | install |
|
PHRASEANET_ELASTICSEARCH_MINSCORE | install |
|
PHRASEANET_ELASTICSEARCH_HIGHLIGHT | install |
|
PHRASEANET_ELASTICSEARCH_MAXRESULTWINDOW | install |
|
PHRASEANET_ELASTICSEARCH_POPULATEORDER | install |
|
PHRASEANET_ELASTICSEARCH_ACTIVETAB | install |
|
PHRASEANET_ELASTICSEARCH_FACET_BASE | install |
|
PHRASEANET_ELASTICSEARCH_FACET_COLLECTION | install |
|
PHRASEANET_ELASTICSEARCH_FACET_DOCTYPE | install |
|
PHRASEANET_ELASTICSEARCH_FACET_ORIENTATION | install |
Name | Type | Comment |
---|---|---|
PHRASEANET_TRUSTED_PROXIES | run |
|
PHRASEANET_DEBUG_ALLOWED_IP | run |
|
PHRASEANET_SUBNET_IPS | run |
Name | Type | Comment |
---|---|---|
PHRASEANET_API_ENABLED | run |
|
PHRASEANET_API_SSL | run |
|
PHRASEANET_API_AUTH_TOKEN_HEADER_ONLY | run |
Name | Type | Comment |
---|---|---|
PHRASEANET_MAPBOX_ACTIVATE | run |
|
PHRASEANET_MAPBOX_TOKEN | run |
|
PHRASEANET_MAPBOX_KIND | run |
Name | Type | Comment |
---|---|---|
PHRASEANET_EMITTER_EMAIL | run |
|
PHRASEANET_MAIL_OBJECT_PREFIX | run |
Name | Type | Comment |
---|---|---|
PHRASEANET_SMTP_ENABLED | run |
Available values:
|
PHRASEANET_SMTP_HOST | run |
|
PHRASEANET_SMTP_PORT | run |
|
PHRASEANET_SMTP_AUTH_ENABLED | run |
|
PHRASEANET_SMTP_SECURE_MODE | run |
|
PHRASEANET_SMTP_USER | run |
|
PHRASEANET_SMTP_PASSWORD | run |
Name | Type | Comment |
---|---|---|
PHRASEANET_EXPLODE_WORKER | run |
Define how many process are launched in the "worker" container:
|
PHRASEANET_WORKERS_LAUNCH_METHOD | run |
When PHRASEANET_EXPLODE_WORKER=1, it define the method for launching Phraseanet workers process. Available values :
|
PHRASEANET_WORKER_assetsIngest | run |
|
PHRASEANET_WORKER_createRecord | run |
|
PHRASEANET_WORKER_deleteRecord | run |
|
PHRASEANET_WORKER_editRecord | run |
|
PHRASEANET_WORKER_exportMail | run |
|
PHRASEANET_WORKER_downloadAsync | run |
|
PHRASEANET_WORKER_exposeUpload | run |
|
PHRASEANET_WORKER_ftp | run |
|
PHRASEANET_WORKER_mainQueue | run |
|
PHRASEANET_WORKER_populateIndex | run |
|
PHRASEANET_WORKER_pullAssets | run |
|
PHRASEANET_WORKER_recordsActions | run |
|
PHRASEANET_WORKER_subdefCreation | run |
|
PHRASEANET_WORKER_subtitle | run |
|
PHRASEANET_WORKER_validationReminder | run |
|
PHRASEANET_WORKER_webhook | run |
|
PHRASEANET_WORKER_writeMetadatas | run |
|
PHRASEANET_WORKER_shareBasket | run |
Name | Type | Comment |
---|---|---|
LC_MESSAGES | run |
|
LC_COLLATE | run |
|
LC_IDENTIFICATION | run |
|
LANG | run |
|
LC_MEASUREMENT | run |
|
LC_CTYPE | run |
|
LC_TIME | run |
|
LC_NAME | run |
Name | Type | Comment |
---|---|---|
PHRASEANET_CONFIG_DIR | run |
|
PHRASEANET_LOGS_DIR | run |
|
PHRASEANET_DATA_DIR | run |
|
PHRASEANET_DB_DIR | run |
|
PHRASEANET_ELASTICSEARCH_DIR | run |
|
PHRASEANET_THUMBNAILS_DIR | run |
|
PHRASEANET_CUSTOM_DIR | run |
|
PHRASEANET_PLUGINS_DIR | run |
|
PHRASEANET_TMP_DIR | run |
|
PHRASEANET_CACHE_DIR | run |
|
PHRASEANET_DOWNLOAD_DIR | run |
|
PHRASEANET_LAZARET_DIR | run |
|
PHRASEANET_CAPTION_DIR | run |
|
PHRASEANET_WORKER_TMP | run |
|
PHRASEANET_BACKUP_DIR | run |
|
PHRASEANET_FTP_DIR | run |
Name | Type | Comment |
---|---|---|
PHRASEANET_PLUGINS | build |
|
PHRASEANET_SSH_PRIVATE_KEY | build |
Name | Type | Comment |
---|---|---|
IMAGEMAGICK_POLICY_VERSION | run |
|
IMAGEMAGICK_POLICY_WIDTH | run |
|
IMAGEMAGICK_POLICY_HEIGHT | run |
|
IMAGEMAGICK_POLICY_MAP | run |
|
IMAGEMAGICK_POLICY_MEMORY | run |
|
IMAGEMAGICK_POLICY_AREA | run |
|
IMAGEMAGICK_POLICY_DISK | run |
|
IMAGEMAGICK_POLICY_TEMPORARY_PATH | run |
Name | Type | Comment |
---|---|---|
NEWRELIC_ENABLED | run |
Enable (or not) the "New Relic" agent for plateform monitoring. |
NEWRELIC_LICENSE_KEY | run |
|
NEWRELIC_APP_NAME | run |
Name | Type | Comment |
---|---|---|
PHRASEANET_PHPMYADMIN_PORT | run |
"PhpMyAdmin" http port mapping. |
MAILHOG_GUI_PORT | run |
"Mailhog" http port mapping. |
Name | Type | Comment |
---|---|---|
XDEBUG_ENABLED | run |
|
XDEBUG_PROFILER_ENABLED | run |
|
IDE_KEY | run |
|
XDEBUG_REMOTE_HOST | run |
|
PHP_IDE_CONFIG=serverName | run |
|
PHRASEANET_FTP_DIR | run |
For dev or testing export ftp-server |
Name | Type | Comment |
---|---|---|
SSH_AUTH_SOCK | run |
For dev who don't have SSH_AUTH_SOCK (avoid an empty volume name) |
PHRASEANET_K8S_NAMESPACE | run |
Kubernet context needs full pod hosname on nginx reverse proxing This is need for PHraseanet SAML context on K8S |
SAML_ALLOW_DEBUG | run |
SAML Service provider setting simplesamlphp as service provider for Phraseanet must be associated to a plugin on docker-compose staxk add the profile phraseanet-saml-sp |
SAML_PHRASEANET_HOST | run |
|
SAML_SP_CONFIG_DIR | run |
|
SAML_SP_AUTHSOURCES | run |
|
SAML_SP_CERT_DIR | run |
|
SAML_IDP_METADATA_CONFIG | run |
|
SAML_IDP_METADATA_LOCAL_CONFIG_DIR | run |