Skip to content

Instantly share code, notes, and snippets.

@jippi
Created June 9, 2024 20:02
Show Gist options
  • Save jippi/83e221409f25e43d9dde6f943dd5ad9c to your computer and use it in GitHub Desktop.
Save jippi/83e221409f25e43d9dde6f943dd5ad9c to your computer and use it in GitHub Desktop.

.env file Documentation

app

APP_NAME

The name/title for your site (See Documentation)

Defined at: .env.example:23

Validation: required

APP_DOMAIN

Application domain used for routing. (e.g., pixelfed.org) (See Documentation)

Defined at: .env.example:30

Validation: required,fqdn

APP_URL

This URL is used by the console to properly generate URLs when using the Artisan command line tool. You should set this to the root of your application so that it is used when running Artisan tasks. (See Documentation)

Defined at: .env.example:37

Validation: required,http_url

ADMIN_DOMAIN

Application domains used for routing. (See Documentation)

Defined at: .env.example:43

Validation: required,fqdn

APP_ENV

This value determines the “environment” your application is currently running in. This may determine how you prefer to configure various services your application utilizes. (See Documentation)

Defined at: .env.example:51

Validation: required,oneof='production,dev,staging'

APP_DEBUG

When your application is in debug mode, detailed error messages with stack traces will be shown on every error that occurs within your application.

If disabled, a simple generic error page is shown. (See Documentation)

Defined at: .env.example:61

Validation: required,boolean

OPEN_REGISTRATION

Enable/disable new local account registrations. (See Documentation)

Defined at: .env.example:68

Validation: required,boolean

ENFORCE_EMAIL_VERIFICATION

Require email verification before a new user can do anything. (See Documentation)

Defined at: .env.example:75

Validation: required,boolean

PF_MAX_USERS

Allow a maximum number of user accounts. (See Documentation)

Defined at: .env.example:82

Validation: required,number

PF_ENFORCE_MAX_USERS

Enforce the maximum number of user accounts

Defined at: .env.example:88

Validation: boolean

OAUTH_ENABLED (See Documentation)

Defined at: .env.example:93

Validation: required,boolean

APP_TIMEZONE

! Do not edit your timezone once the service is running - or things will break! (See Documentation)

Defined at: .env.example:101

Validation: required,timezone

APP_LOCALE

The application locale determines the default locale that will be used by the translation service provider. You are free to set this value to any of the locales which will be supported by the application. (See Documentation)

Defined at: .env.example:109

Validation: required

APP_FALLBACK_LOCALE

The fallback locale determines the locale to use when the current one is not available.

You may change the value to correspond to any of the language folders that are provided through your application. (See Documentation)

Defined at: .env.example:118

Validation: required

LIMIT_ACCOUNT_SIZE (See Documentation)

Defined at: .env.example:122

Validation: required,boolean

MAX_ACCOUNT_SIZE

Update the max account size, the per user limit of files in kB. (See Documentation)

Defined at: .env.example:129

Validation: required,number

MAX_PHOTO_SIZE

Update the max photo size, in kB. (See Documentation)

Defined at: .env.example:136

Validation: required,number

MAX_ALBUM_LENGTH

The max number of photos allowed per post. (See Documentation)

Defined at: .env.example:143

Validation: required,number

MAX_AVATAR_SIZE

Update the max avatar size, in kB. (See Documentation)

Defined at: .env.example:150

Validation: required,number

MAX_CAPTION_LENGTH

Change the caption length limit for new local posts. (See Documentation)

Defined at: .env.example:157

Validation: required,number

MAX_BIO_LENGTH

Change the bio length limit for user profiles. (See Documentation)

Defined at: .env.example:164

Validation: required,number

MAX_NAME_LENGTH

Change the length limit for user names. (See Documentation)

Defined at: .env.example:171

Validation: required,number

PF_OPTIMIZE_IMAGES

Resize and optimize image uploads. (See Documentation)

Defined at: .env.example:178

Validation: required,boolean

IMAGE_QUALITY

Set the image optimization quality, must be a value between 1-100. (See Documentation)

Defined at: .env.example:185

Validation: required,number

PF_OPTIMIZE_VIDEOS

Resize and optimize video uploads. (See Documentation)

Defined at: .env.example:192

Validation: required,boolean

ACCOUNT_DELETION

Enable account deletion. (See Documentation)

Defined at: .env.example:199

Validation: required,boolean

ACCOUNT_DELETE_AFTER

Set account deletion queue after X days, set to false to delete accounts immediately. (See Documentation)

Defined at: .env.example:206

Validation: required,boolean

INSTANCE_DESCRIPTION (See Documentation)

Defined at: .env.example:211

Validation: required

INSTANCE_PUBLIC_HASHTAGS (See Documentation)

Defined at: .env.example:216

Validation: required,boolean

INSTANCE_CONTACT_EMAIL

The public e-mail address people can use to contact you by (See Documentation)

Defined at: .env.example:223

Validation: required,ne=__CHANGE_ME__,email

INSTANCE_PUBLIC_LOCAL_TIMELINE (See Documentation)

Defined at: .env.example:228

Validation: required,boolean

BANNED_USERNAMES (See Documentation)

Defined at: .env.example:232

STORIES_ENABLED (See Documentation)

Defined at: .env.example:237

Validation: required,boolean

RESTRICTED_INSTANCE

Level is hardcoded to 1. (See Documentation)

Defined at: .env.example:244

Validation: required,boolean

MEDIA_EXIF_DATABASE (See Documentation)

Defined at: .env.example:249

Validation: required,boolean

IMAGE_DRIVER

Pixelfed supports GD or ImageMagick to process images.

Possible values:

Defined at: .env.example:260

Validation: required,oneof=gd imagick

TRUST_PROXIES

Set trusted proxy IP addresses.

Both IPv4 and IPv6 addresses are supported, along with CIDR notation.

The “*” character is syntactic sugar within TrustedProxy to trust any proxy that connects directly to your server, a requirement when you cannot know the address of your proxy (e.g. if using Rackspace balancers).

The “**” character is syntactic sugar within TrustedProxy to trust not just any proxy that connects directly to your server, but also proxies that connect to those proxies, and all the way back until you reach the original source IP. It will mean that $request->getClientIp() always gets the originating client IP, no matter how many proxies that client’s request has subsequently passed through. (See Documentation)

Defined at: .env.example:279

Validation: required

CACHE_DRIVER

This option controls the default cache connection that gets used while using this caching library.

This connection is used when another is not explicitly specified when executing a given caching function.

Possible values:

Defined at: .env.example:296

Validation: required,oneof=apc array database file memcached redis

CACHE_PREFIX (See Documentation)

Defined at: .env.example:301

Validation: required

BROADCAST_DRIVER

This option controls the default broadcaster that will be used by the framework when an event needs to be broadcast.

Possible values:

Defined at: .env.example:314

Validation: required,oneof=pusher redis log null

RESTRICT_HTML_TYPES (See Documentation)

Defined at: .env.example:319

Validation: required,boolean

PASSPORT_PRIVATE_KEY (See Documentation)

Defined at: .env.example:323

Validation: required

PASSPORT_PUBLIC_KEY (See Documentation)

Defined at: .env.example:327

Validation: required

database

DB_VERSION

Database version to use (as Docker tag) (See Documentation)

Defined at: .env.example:337

Validation: required

DB_CONNECTION

Here you may specify which of the database connections below you wish to use as your default connection for all database work.

Of course you may use many connections at once using the database library.

Possible values:

Defined at: .env.example:353

Validation: required,oneof=sqlite mysql pgsql sqlsrv

Defined at: .env.example:357

Validation: required,hostname

DB_USERNAME (See Documentation)

Defined at: .env.example:361

Validation: required

DB_PASSWORD

The password to your database. Please make it secure. Use a site like https://pwgen.io/ to generate it (See Documentation)

Defined at: .env.example:368

Validation: required

DB_DATABASE (See Documentation)

Defined at: .env.example:372

Validation: required

DB_PORT

Use "3306" for MySQL/MariaDB and "5432" for PostgreeSQL (See Documentation)

Defined at: .env.example:378

Validation: required,number

DB_APPLY_NEW_MIGRATIONS_AUTOMATICALLY

Automatically run [artisan migrate --force] if new migrations are detected.

Defined at: .env.example:382

Validation: required,boolean

mail

MAIL_DRIVER

Laravel supports both SMTP and PHP’s “mail” function as drivers for the sending of e-mail. You may specify which one you’re using throughout your application here.

Possible values:

"smtp" (default) "sendmail" "mailgun" "mandrill" "ses" "sparkpost" "log" "array" (See Documentation)

Defined at: .env.example:405

Validation: required,oneof=smtp sendmail mailgun mandrill ses sparkpost log array

MAIL_HOST

The host address of the SMTP server used by your applications.

A default option is provided that is compatible with the Mailgun mail service which will provide reliable deliveries. (See Documentation)

Defined at: .env.example:414

Validation: required_with=MAIL_DRIVER,fqdn

MAIL_PORT

This is the SMTP port used by your application to deliver e-mails to users of the application.

Like the host we have set this value to stay compatible with the Mailgun e-mail application by default. (See Documentation)

Defined at: .env.example:423

Validation: required_with=MAIL_DRIVER,number

MAIL_FROM_ADDRESS

Here, you may specify a name and address that is used globally for all e-mails that are sent by your application.

You may wish for all e-mails sent by your application to be sent from the same address. (See Documentation)

Defined at: .env.example:432

Validation: required_with=MAIL_DRIVER,email,ne=__CHANGE_ME__

MAIL_FROM_NAME

The 'name' you send e-mail from (See Documentation)

Defined at: .env.example:439

Validation: required_with=MAIL_DRIVER

MAIL_USERNAME

If your SMTP server requires a username for authentication, you should set it here.

This will get used to authenticate with your server on connection. You may also set the “password” value below this one. (See Documentation)

Defined at: .env.example:449

Validation: required_with=MAIL_DRIVER

MAIL_PASSWORD (See Documentation)

Defined at: .env.example:454

Validation: required_with=MAIL_DRIVER

MAIL_ENCRYPTION

Here you may specify the encryption protocol that should be used when the application send e-mail messages.

A sensible default using the transport layer security protocol should provide great security. (See Documentation)

Defined at: .env.example:463

Validation: required_with=MAIL_DRIVER

redis

REDIS_CLIENT (See Documentation)

Defined at: .env.example:472

Validation: required

REDIS_SCHEME (See Documentation)

Defined at: .env.example:477

Validation: required

REDIS_HOST (See Documentation)

Defined at: .env.example:482

Validation: required

REDIS_PASSWORD (See Documentation)

Defined at: .env.example:487

Validation: omitempty

REDIS_PORT (See Documentation)

Defined at: .env.example:492

Validation: required,number

REDIS_DATABASE (See Documentation)

Defined at: .env.example:497

Validation: required,number

experiments

EXP_TOP

Text only posts (alpha). (See Documentation)

Defined at: .env.example:508

Validation: required,boolean

EXP_POLLS

Poll statuses (alpha). (See Documentation)

Defined at: .env.example:515

Validation: required,boolean

EXP_CPT

Cached public timeline for larger instances (beta). (See Documentation)

Defined at: .env.example:522

Validation: required,boolean

EXP_EMC

Enforce Mastodon API Compatibility (alpha). (See Documentation)

Defined at: .env.example:529

Validation: required,boolean

ActivityPub

ACTIVITY_PUB (See Documentation)

Defined at: .env.example:538

Validation: required,boolean

AP_REMOTE_FOLLOW (See Documentation)

Defined at: .env.example:543

Validation: required,boolean

AP_SHAREDINBOX (See Documentation)

Defined at: .env.example:548

Validation: required,boolean

Defined at: .env.example:553

Validation: required,boolean

AP_OUTBOX (See Documentation)

Defined at: .env.example:558

Validation: required,boolean

Federation

ATOM_FEEDS (See Documentation)

Defined at: .env.example:567

Validation: required,boolean

Defined at: .env.example:572

Validation: required,boolean

WEBFINGER (See Documentation)

Defined at: .env.example:577

Validation: required,boolean

Storage

PF_ENABLE_CLOUD

Store media on object storage like S3, Digital Ocean Spaces, Rackspace (See Documentation)

Defined at: .env.example:588

Validation: required,boolean

FILESYSTEM_CLOUD

Many applications store files both locally and in the cloud.

For this reason, you may specify a default “cloud” driver here. This driver will be bound as the Cloud disk implementation in the container. (See Documentation)

Defined at: .env.example:598

Validation: required_with=PF_ENABLE_CLOUD

MEDIA_DELETE_LOCAL_AFTER_CLOUD (See Documentation)

Defined at: .env.example:603

Validation: required_with=PF_ENABLE_CLOUD,boolean

AWS_ACCESS_KEY_ID (See Documentation)

Defined at: .env.example:607

Validation: required_if=FILESYSTEM_CLOUD s3

AWS_SECRET_ACCESS_KEY (See Documentation)

Defined at: .env.example:611

Validation: required_if=FILESYSTEM_CLOUD s3

AWS_DEFAULT_REGION (See Documentation)

Defined at: .env.example:615

Validation: required_if=FILESYSTEM_CLOUD s3

AWS_BUCKET (See Documentation)

Defined at: .env.example:619

Validation: required_if=FILESYSTEM_CLOUD s3

Defined at: .env.example:623

Validation: required_if=FILESYSTEM_CLOUD s3

AWS_ENDPOINT (See Documentation)

Defined at: .env.example:627

Validation: required_if=FILESYSTEM_CLOUD s3

AWS_USE_PATH_STYLE_ENDPOINT (See Documentation)

Defined at: .env.example:631

Validation: required_if=FILESYSTEM_CLOUD s3

COSTAR

CS_BLOCKED_DOMAINS

Comma-separated list of domains to block. (See Documentation)

Defined at: .env.example:642

Validation: ``

CS_CW_DOMAINS

Comma-separated list of domains to add warnings. (See Documentation)

Defined at: .env.example:649

Validation: ``

CS_UNLISTED_DOMAINS

Comma-separated list of domains to remove from public timelines. (See Documentation)

Defined at: .env.example:656

Validation: ``

CS_BLOCKED_KEYWORDS

Comma-separated list of keywords to block. (See Documentation)

Defined at: .env.example:663

Validation: ``

CS_CW_KEYWORDS

Comma-separated list of keywords to add warnings. (See Documentation)

Defined at: .env.example:670

Validation: ``

CS_UNLISTED_KEYWORDS

Comma-separated list of keywords to remove from public timelines. (See Documentation)

Defined at: .env.example:677

Validation: ``

CS_BLOCKED_ACTOR (See Documentation)

Defined at: .env.example:682

Validation: ``

CS_CW_ACTOR (See Documentation)

Defined at: .env.example:687

Validation: ``

CS_UNLISTED_ACTOR (See Documentation)

Defined at: .env.example:692

Validation: ``

logging

LOG_CHANNEL

Possible values:

  • "stack" (default)
  • "single"
  • "daily"
  • "slack"
  • "stderr"
  • "syslog"
  • "errorlog"
  • "null"
  • "emergency"
  • "media"

Defined at: .env.example:713

Validation: required,oneof=stack single daily slack stderr syslog errorlog null emergency media

LOG_LEVEL

Used by single, stderr and syslog. (See Documentation)

Defined at: .env.example:720

Validation: required,boolean

LOG_STDERR_FORMATTER

Used by stderr. (See Documentation)

Defined at: .env.example:727

Validation: required

LOG_SLACK_WEBHOOK_URL

Used by slack. (See Documentation)

Defined at: .env.example:734

Validation: required,http_url

queue

QUEUE_DRIVER

Possible values:

Defined at: .env.example:751

Validation: required,oneof=sync database beanstalkd sqs redis null

Defined at: .env.example:756

Validation: required_if=QUEUE_DRIVER sqs

SQS_SECRET (See Documentation)

Defined at: .env.example:761

Validation: required_if=QUEUE_DRIVER sqs

SQS_PREFIX (See Documentation)

Defined at: .env.example:766

Validation: required_if=QUEUE_DRIVER sqs

SQS_QUEUE (See Documentation)

Defined at: .env.example:771

Validation: required_if=QUEUE_DRIVER sqs

SQS_REGION (See Documentation)

Defined at: .env.example:776

Validation: required_if=QUEUE_DRIVER sqs

session

SESSION_DRIVER

This option controls the default session “driver” that will be used on requests.

By default, we will use the lightweight native driver but you may specify any of the other wonderful drivers provided here.

Possible values:

  • "file"
  • "cookie"
  • "database" (default)
  • "apc"
  • "memcached"
  • "redis"
  • "array"

Defined at: .env.example:797

Validation: required,oneof=file cookie database apc memcached redis array

SESSION_LIFETIME

Here you may specify the number of minutes that you wish the session to be allowed to remain idle before it expires.

If you want them to immediately expire on the browser closing, set that option. (See Documentation)

Defined at: .env.example:806

Validation: required,number

SESSION_DOMAIN

Here you may change the domain of the cookie used to identify a session in your application.

This will determine which domains the cookie is available to in your application.

A sensible default has been set. (See Documentation)

Defined at: .env.example:817

Validation: required,domain

horizon

HORIZON_PREFIX

This prefix will be used when storing all Horizon data in Redis.

You may modify the prefix when you are running multiple installations of Horizon on the same server so that they don’t have problems. (See Documentation)

Defined at: .env.example:831

Validation: required

HORIZON_DARKMODE (See Documentation)

Defined at: .env.example:836

Validation: required,boolean

HORIZON_MEMORY_LIMIT

This value (in MB) describes the maximum amount of memory (in MB) the Horizon worker may consume before it is terminated and restarted.

You should set this value according to the resources available to your server.

Defined at: .env.example:845

Validation: required,number

HORIZON_BALANCE_STRATEGY (See Documentation)

Defined at: .env.example:849

Validation: required

HORIZON_MIN_PROCESSES (See Documentation)

Defined at: .env.example:853

Validation: required,number

HORIZON_MAX_PROCESSES (See Documentation)

Defined at: .env.example:857

Validation: required,number

HORIZON_SUPERVISOR_MEMORY (See Documentation)

Defined at: .env.example:861

Validation: required,number

HORIZON_SUPERVISOR_TRIES (See Documentation)

Defined at: .env.example:865

Validation: required,number

HORIZON_SUPERVISOR_NICE (See Documentation)

Defined at: .env.example:869

Validation: required,number

HORIZON_SUPERVISOR_TIMEOUT (See Documentation)

Defined at: .env.example:873

Validation: required,number

docker shared

APP_KEY

A random 32-character string to be used as an encryption key.

!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! ! NOTE: This will be auto-generated by Docker during bootstrap !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!

This key is used by the Illuminate encrypter service and should be set to a random, 32 character string, otherwise these encrypted strings will not be safe. (See Documentation)

Defined at: .env.example:890

Validation: required

DOCKER_ALL_CONTAINER_NAME_PREFIX

Prefix for container names (without any dash at the end)

Defined at: .env.example:894

Validation: required

DOCKER_ALL_DEFAULT_HEALTHCHECK_INTERVAL

How often Docker health check should run for all services

Can be overridden by individual [DOCKER_*_HEALTHCHECK_INTERVAL] settings further down

Defined at: .env.example:902

Validation: required

DOCKER_ALL_HOST_ROOT_PATH

Path (relative to the docker-compose.yml) or absolute (/some/other/path) where containers will all data will be stored (data, config, overrides)

Defined at: .env.example:909

Validation: required,dir

DOCKER_ALL_HOST_DATA_ROOT_PATH

Path (relative to the docker-compose.yml) or absolute (/some/other/path) where containers will store their data

Defined at: .env.example:915

Validation: required,dir

DOCKER_ALL_HOST_CONFIG_ROOT_PATH

Path (relative to the docker-compose.yml) or absolute (/some/other/path) where containers will store their confguration

Defined at: .env.example:921

Validation: required,dir

DOCKER_APP_HOST_OVERRIDES_PATH

Path (relative to the docker-compose.yml) or absolute (/some/other/path) where containers will store overrides

Defined at: .env.example:927

Validation: required,dir

TZ

Set timezone used by all containers - these must be in sync.

! Do not edit your timezone once the service is running - or things will break! (See Documentation)

Defined at: .env.example:935

Validation: required,timezone

docker app

DOCKER_APP_RELEASE

The docker tag prefix to use for pulling images, can be one of

  • latest
  • staging
  • edge
  • branch-
  • pr-

Combined with [DOCKER_APP_RUNTIME] and [PHP_VERSION] configured elsewhere in this file, the final Docker tag is computed.

Defined at: .env.example:953

Validation: required

DOCKER_APP_PHP_VERSION

The PHP version to use for [web] and [worker] container

Any version published on https://hub.docker.com/_/php should work

Example:

  • 8.1
  • 8.2
  • 8.2.14
  • latest

Do NOT use the full Docker tag (e.g. "8.3.2RC1-fpm-bullseye") only the version part. The rest of the full tag is derived from the [DOCKER_APP_RUNTIME] and [PHP_DEBIAN_RELEASE] settings

Defined at: .env.example:970

Validation: required

DOCKER_APP_RUNTIME

The container runtime to use. (See Documentation)

Defined at: .env.example:976

Validation: required,oneof=apache nginx fpm

DOCKER_APP_DEBIAN_RELEASE

The Debian release variant to use of the [php] Docker image

Examlpe: [bookworm] or [bullseye]

Defined at: .env.example:982

Validation: required,oneof=bookwork bullseye

DOCKER_APP_BASE_TYPE

The [php] Docker image base type (See Documentation)

Defined at: .env.example:988

Validation: required,oneof=apache fpm cli

DOCKER_APP_IMAGE

Image to pull the Pixelfed Docker images from.

Example values:

  • "ghcr.io/pixelfed/pixelfed" to pull from GitHub
  • "pixelfed/pixelfed" to pull from DockerHub
  • "your/fork" to pull from a custom fork

Defined at: .env.example:999

Validation: required

DOCKER_APP_TAG

Pixelfed version (image tag) to pull from the registry. (See Documentation)

Defined at: .env.example:1005

Validation: required

DOCKER_APP_HOST_STORAGE_PATH

Path (on host system) where the [app] + [worker] container will write its [storage] data (e.g uploads/images/profile pictures etc.).

Path is relative (./some/other/path) to the docker-compose.yml or absolute (/some/other/path)

Defined at: .env.example:1012

Validation: required,dir

DOCKER_APP_HOST_CACHE_PATH

Path (on host system) where the [app] + [worker] container will write its [cache] data.

Path is relative (./some/other/path) to the docker-compose.yml or absolute (/some/other/path)

Defined at: .env.example:1019

Validation: required,dir

DOCKER_APP_RUN_ONE_TIME_SETUP_TASKS

Automatically run "One-time setup tasks" commands.

If you are migrating to this docker-compose setup or have manually run the "One time seutp" tasks (https://docs.pixelfed.org/running-pixelfed/installation/#setting-up-services) you can set this to "0" to prevent them from running.

Otherwise, leave it at "1" to have them run once.

Defined at: .env.example:1029

Validation: required,boolean

DOCKER_APP_ENSURE_OWNERSHIP_PATHS

A space-seperated list of paths (inside the container) to recursively [chown] to the container user/group id (UID/GID) in case of permission issues.

! You should not leave this on permanently, at it can significantly slow down startup ! time for the container, and during normal operations there should never be permission ! issues. Please report a bug if you see behavior requiring this to be permanently on

Example: "/var/www/storage /var/www/bootstrap/cache"

Defined at: .env.example:1040

Validation: required

DOCKER_APP_ENTRYPOINT_DEBUG

Enable Docker Entrypoint debug mode (will call [set -x] in bash scripts) by setting this to "1"

Defined at: .env.example:1045

Validation: required,boolean

DOCKER_APP_APT_PACKAGES_EXTRA

List of extra APT packages (separated by space) to install when building locally using [docker compose build]. (See Documentation)

Defined at: .env.example:1052

Validation: required

DOCKER_APP_PHP_PECL_EXTENSIONS_EXTRA

List of extra PECL extensions (separated by space) to install when building locally using [docker compose build]. (See Documentation)

Defined at: .env.example:1059

Validation: required

DOCKER_APP_PHP_EXTENSIONS_EXTRA

List of extra PHP extensions (separated by space) to install when building locally using [docker compose build]. (See Documentation)

Defined at: .env.example:1066

Validation: required

DOCKER_APP_PHP_MEMORY_LIMIT (See Documentation)

Defined at: .env.example:1071

Validation: required

docker redis

DOCKER_REDIS_VERSION

Redis version to use as Docker tag (See Documentation)

Defined at: .env.example:1081

Validation: required

DOCKER_REDIS_HOST_DATA_PATH

Path (on host system) where the [redis] container will store its data

Path is relative (./some/other/path) to the docker-compose.yml or absolute (/some/other/path)

Defined at: .env.example:1087

Validation: required,dir

DOCKER_REDIS_HOST_PORT

Port that Redis will listen on outside the container (e.g. the host machine)

Defined at: .env.example:1091

Validation: required,number

DOCKER_REDIS_CONFIG_FILE

The filename that Redis should store its config file within

NOTE: The file MUST exists (even empty) before enabling this setting!

Use a command like [touch "${DOCKER_ALL_HOST_CONFIG_ROOT_PATH}/redis/redis.conf"] to create it.

Defined at: .env.example:1101

Validation: required

DOCKER_REDIS_HEALTHCHECK_INTERVAL

How often Docker health check should run for [redis] service

Defined at: .env.example:1107

Validation: required

docker db

DOCKER_DB_IMAGE

Docker image for the DB service

Defined at: .env.example:1115

Validation: required

DOCKER_DB_COMMAND

Command to pass to the [db] server container

Defined at: .env.example:1119

Validation: required

DOCKER_DB_PROFILE

Set this to a non-empty value (e.g. "disabled") to disable the [db] service

Defined at: .env.example:1122

DOCKER_DB_HOST_DATA_PATH

Path (on host system) where the [db] container will store its data

Path is relative (./some/other/path) to the docker-compose.yml or absolute (/some/other/path)

Defined at: .env.example:1128

Validation: required,dir

DOCKER_DB_CONTAINER_DATA_PATH

Path (inside the container) where the [db] will store its data.

Path MUST be absolute.

For MySQL this should be [/var/lib/mysql] For PostgreSQL this should be [/var/lib/postgresql/data]

Defined at: .env.example:1137

Validation: required

DOCKER_DB_HOST_PORT

Port that the database will listen on OUTSIDE the container (e.g. the host machine)

Use "3306" for MySQL/MariaDB and "5432" for PostgreeSQL

Defined at: .env.example:1143

Validation: required,number

DOCKER_DB_CONTAINER_PORT

Port that the database will listen on INSIDE the container

Use "3306" for MySQL/MariaDB and "5432" for PostgreeSQL

Defined at: .env.example:1149

Validation: required,number

DOCKER_DB_HEALTHCHECK_INTERVAL

How often Docker health check should run for [db] service

Defined at: .env.example:1153

Validation: required

docker web

DOCKER_WEB_PROFILE

Set this to a non-empty value (e.g. "disabled") to disable the [web] service

Defined at: .env.example:1161

Validation: required

DOCKER_WEB_PORT_EXTERNAL_HTTP

Port to expose [web] container will listen on outside the container (e.g. the host machine) for HTTP traffic only

Defined at: .env.example:1165

Validation: required,number

DOCKER_WEB_HEALTHCHECK_INTERVAL

How often Docker health check should run for [web] service

Defined at: .env.example:1169

Validation: required

docker worker

DOCKER_WORKER_PROFILE

Set this to a non-empty value (e.g. "disabled") to disable the [worker] service

Defined at: .env.example:1177

Validation: required

DOCKER_WORKER_HEALTHCHECK_INTERVAL

How often Docker health check should run for [worker] service

Defined at: .env.example:1181

Validation: required

docker proxy

DOCKER_PROXY_VERSION

The version of nginx-proxy to use (See Documentation)

Defined at: .env.example:1191

Validation: required

DOCKER_PROXY_PROFILE

Set this to a non-empty value (e.g. "disabled") to disable the [proxy] and [proxy-acme] service

Defined at: .env.example:1194

DOCKER_PROXY_ACME_PROFILE

Set this to a non-empty value (e.g. "disabled") to disable the [proxy-acme] service

Defined at: .env.example:1197

DOCKER_PROXY_HEALTHCHECK_INTERVAL

How often Docker health check should run for [proxy] service

Defined at: .env.example:1201

Validation: required

DOCKER_PROXY_HOST_PORT_HTTP

Port that the [proxy] will listen on outside the container (e.g. the host machine) for HTTP traffic

Defined at: .env.example:1205

Validation: required,number

DOCKER_PROXY_HOST_PORT_HTTPS

Port that the [proxy] will listen on outside the container (e.g. the host machine) for HTTPS traffic

Defined at: .env.example:1209

Validation: required,number

DOCKER_PROXY_HOST_DOCKER_SOCKET_PATH

Path to the Docker socket on the host

Defined at: .env.example:1213

Validation: required,file

DOCKER_PROXY_LETSENCRYPT_HOST

The host to request LetsEncrypt certificate for

Defined at: .env.example:1217

Validation: required,fqdn

DOCKER_PROXY_LETSENCRYPT_EMAIL

The e-mail to use for Lets Encrypt certificate requests.

Defined at: .env.example:1221

Validation: required,email

DOCKER_PROXY_LETSENCRYPT_TEST

Lets Encrypt staging/test servers for certificate requests.

Setting this to any value will change to letsencrypt test servers.

Defined at: .env.example:1226

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment