diff --git a/docs/en_US/container_deployment.rst b/docs/en_US/container_deployment.rst index c697c0adb..627d2c3b6 100644 --- a/docs/en_US/container_deployment.rst +++ b/docs/en_US/container_deployment.rst @@ -31,17 +31,17 @@ Environment Variables The container will accept the following variables at startup: -*PGADMIN_DEFAULT_EMAIL* +**PGADMIN_DEFAULT_EMAIL** This is the email address used when setting up the initial administrator account to login to pgAdmin. This variable is required and must be set at launch time. -*PGADMIN_DEFAULT_PASSWORD* +**PGADMIN_DEFAULT_PASSWORD** This is the password used when setting up the initial administrator account to login to pgAdmin. This variable is required and must be set at launch time. -*PGADMIN_ENABLE_TLS* +**PGADMIN_ENABLE_TLS** Default: @@ -53,7 +53,7 @@ When TLS is enabled, a certificate and key must be provided. Typically these should be stored on the host file system and mounted from the container. The expected paths are /certs/server.crt and /certs/server.key -*PGADMIN_LISTEN_ADDRESS* +**PGADMIN_LISTEN_ADDRESS** Default: [::] @@ -61,21 +61,21 @@ Specify the local address that the servers listens on. The default should work for most users - in IPv4-only environments, this may need to be set to 127.0.0.1. -*PGADMIN_LISTEN_PORT* +**PGADMIN_LISTEN_PORT** Default: 80 or 443 (if TLS is enabled) Allows the port that the server listens on to be set to a specific value rather than using the default. -*PGADMIN_SERVER_JSON_FILE* +**PGADMIN_SERVER_JSON_FILE** Default: /pgadmin4/servers.json Override the default file path for the server definition list. See the /pgadmin4/servers.json mapped file below for more information. -*GUNICORN_THREADS* +**GUNICORN_THREADS** Default: 25 @@ -83,7 +83,7 @@ Adjust the number of threads the Gunicorn server uses to handle incoming requests. This should typically be left as-is, except in highly loaded systems where it may be increased. -*PGADMIN_CONFIG_* +**PGADMIN_CONFIG_** This is a variable prefix that can be used to override any of the configuration options in pgAdmin's *config.py* file. Add the *PGADMIN_CONFIG_* prefix to any @@ -105,21 +105,21 @@ The following files or directories can be mapped from the container onto the host machine to allow configuration to be customised and shared between instances: -*/var/lib/pgadmin* +**/var/lib/pgadmin** This is the working directory in which pgAdmin stores session data, user files, configuration files, and it's configuration database. Mapping this directory onto the host machine gives you an easy way to maintain configuration between invocations of the container. -*/pgadmin4/config_local.py* +**/pgadmin4/config_local.py** This file can be used to override configuration settings in pgAdmin. Settings found in config.py can be overridden with deployment specific values if required. Settings in config_local.py will also override anything specified in the container environment through *PGADMIN_CONFIG_* prefixed variables. -*/pgadmin4/servers.json* +**/pgadmin4/servers.json** If this file is mapped, server definitions found in it will be loaded at launch time. This allows connection information to be pre-loaded into the instance of @@ -127,11 +127,11 @@ pgAdmin in the container. Note that server definitions are only loaded on first launch, i.e. when the configuration database is created, and not on subsequent launches using the same configuration database. -*/certs/server.cert* +**/certs/server.cert** If TLS is enabled, this file will be used as the servers TLS certificate. -*/certs/server.key* +**/certs/server.key** If TLS is enabled, this file will be used as the key file for the servers TLS certificate.