Skip to content

Instantly share code, notes, and snippets.

@jippi

jippi/docs.md

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.
Download ZIP

Revisions

  1. jippi created this gist Jun 9, 2024.
    1,492 changes: 1,492 additions & 0 deletions docs.md
    View file
    Original file line number Diff line number Diff line change
    @@ -0,0 +1,1492 @@
    # .env file Documentation

    ## app

    ### APP_NAME

    The name/title for your site ([*See Documentation*](https://docs.pixelfed.org/technical-documentation/config/#app_name-1))

    Defined at: [.env.example:23](https://github.com/jippi/dottie/blob/main/.env.example#L19)

    Validation: `required`

    ### APP_DOMAIN

    Application domain used for routing. (e.g., pixelfed.org) ([*See Documentation*](https://docs.pixelfed.org/technical-documentation/config/#app_domain))

    Defined at: [.env.example:30](https://github.com/jippi/dottie/blob/main/.env.example#L25)

    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*](https://docs.pixelfed.org/technical-documentation/config/#app_url))

    Defined at: [.env.example:37](https://github.com/jippi/dottie/blob/main/.env.example#L32)

    Validation: `required,http_url`

    ### ADMIN_DOMAIN

    Application domains used for routing. ([*See Documentation*](https://docs.pixelfed.org/technical-documentation/config/#admin_domain))

    Defined at: [.env.example:43](https://github.com/jippi/dottie/blob/main/.env.example#L39)

    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*](https://docs.pixelfed.org/technical-documentation/config/#app_env))

    Defined at: [.env.example:51](https://github.com/jippi/dottie/blob/main/.env.example#L45)

    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*](https://docs.pixelfed.org/technical-documentation/config/#app_debug))

    Defined at: [.env.example:61](https://github.com/jippi/dottie/blob/main/.env.example#L53)

    Validation: `required,boolean`

    ### OPEN_REGISTRATION

    Enable/disable new local account registrations. ([*See Documentation*](https://docs.pixelfed.org/technical-documentation/config/#open_registration))

    Defined at: [.env.example:68](https://github.com/jippi/dottie/blob/main/.env.example#L63)

    Validation: `required,boolean`

    ### ENFORCE_EMAIL_VERIFICATION

    Require email verification before a new user can do anything. ([*See Documentation*](https://docs.pixelfed.org/technical-documentation/config/#enforce_email_verification))

    Defined at: [.env.example:75](https://github.com/jippi/dottie/blob/main/.env.example#L70)

    Validation: `required,boolean`

    ### PF_MAX_USERS

    Allow a maximum number of user accounts. ([*See Documentation*](https://docs.pixelfed.org/technical-documentation/config/#pf_max_users))

    Defined at: [.env.example:82](https://github.com/jippi/dottie/blob/main/.env.example#L77)

    Validation: `required,number`

    ### PF_ENFORCE_MAX_USERS

    Enforce the maximum number of user accounts

    Defined at: [.env.example:88](https://github.com/jippi/dottie/blob/main/.env.example#L84)

    Validation: `boolean`

    ### OAUTH_ENABLED ([*See Documentation*](https://docs.pixelfed.org/technical-documentation/config/#oauth_enabled))

    Defined at: [.env.example:93](https://github.com/jippi/dottie/blob/main/.env.example#L90)

    Validation: `required,boolean`

    ### APP_TIMEZONE

    ! Do not edit your timezone once the service is running - or things will break! ([*See Documentation*](https://docs.pixelfed.org/technical-documentation/config/#app_timezone))

    Defined at: [.env.example:101](https://github.com/jippi/dottie/blob/main/.env.example#L95)

    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*](https://docs.pixelfed.org/technical-documentation/config/#app_locale))

    Defined at: [.env.example:109](https://github.com/jippi/dottie/blob/main/.env.example#L103)

    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*](https://docs.pixelfed.org/technical-documentation/config/#app_fallback_locale))

    Defined at: [.env.example:118](https://github.com/jippi/dottie/blob/main/.env.example#L111)

    Validation: `required`

    ### LIMIT_ACCOUNT_SIZE ([*See Documentation*](https://docs.pixelfed.org/technical-documentation/config/#limit_account_size))

    Defined at: [.env.example:122](https://github.com/jippi/dottie/blob/main/.env.example#L120)

    Validation: `required,boolean`

    ### MAX_ACCOUNT_SIZE

    Update the max account size, the per user limit of files in kB. ([*See Documentation*](https://docs.pixelfed.org/technical-documentation/config/#max_account_size-kb))

    Defined at: [.env.example:129](https://github.com/jippi/dottie/blob/main/.env.example#L124)

    Validation: `required,number`

    ### MAX_PHOTO_SIZE

    Update the max photo size, in kB. ([*See Documentation*](https://docs.pixelfed.org/technical-documentation/config/#max_photo_size-kb))

    Defined at: [.env.example:136](https://github.com/jippi/dottie/blob/main/.env.example#L131)

    Validation: `required,number`

    ### MAX_ALBUM_LENGTH

    The max number of photos allowed per post. ([*See Documentation*](https://docs.pixelfed.org/technical-documentation/config/#max_album_length))

    Defined at: [.env.example:143](https://github.com/jippi/dottie/blob/main/.env.example#L138)

    Validation: `required,number`

    ### MAX_AVATAR_SIZE

    Update the max avatar size, in kB. ([*See Documentation*](https://docs.pixelfed.org/technical-documentation/config/#max_avatar_size-kb))

    Defined at: [.env.example:150](https://github.com/jippi/dottie/blob/main/.env.example#L145)

    Validation: `required,number`

    ### MAX_CAPTION_LENGTH

    Change the caption length limit for new local posts. ([*See Documentation*](https://docs.pixelfed.org/technical-documentation/config/#max_caption_length))

    Defined at: [.env.example:157](https://github.com/jippi/dottie/blob/main/.env.example#L152)

    Validation: `required,number`

    ### MAX_BIO_LENGTH

    Change the bio length limit for user profiles. ([*See Documentation*](https://docs.pixelfed.org/technical-documentation/config/#max_bio_length))

    Defined at: [.env.example:164](https://github.com/jippi/dottie/blob/main/.env.example#L159)

    Validation: `required,number`

    ### MAX_NAME_LENGTH

    Change the length limit for user names. ([*See Documentation*](https://docs.pixelfed.org/technical-documentation/config/#max_name_length))

    Defined at: [.env.example:171](https://github.com/jippi/dottie/blob/main/.env.example#L166)

    Validation: `required,number`

    ### PF_OPTIMIZE_IMAGES

    Resize and optimize image uploads. ([*See Documentation*](https://docs.pixelfed.org/technical-documentation/config/#pf_optimize_images))

    Defined at: [.env.example:178](https://github.com/jippi/dottie/blob/main/.env.example#L173)

    Validation: `required,boolean`

    ### IMAGE_QUALITY

    Set the image optimization quality, must be a value between 1-100. ([*See Documentation*](https://docs.pixelfed.org/technical-documentation/config/#image_quality))

    Defined at: [.env.example:185](https://github.com/jippi/dottie/blob/main/.env.example#L180)

    Validation: `required,number`

    ### PF_OPTIMIZE_VIDEOS

    Resize and optimize video uploads. ([*See Documentation*](https://docs.pixelfed.org/technical-documentation/config/#pf_optimize_videos))

    Defined at: [.env.example:192](https://github.com/jippi/dottie/blob/main/.env.example#L187)

    Validation: `required,boolean`

    ### ACCOUNT_DELETION

    Enable account deletion. ([*See Documentation*](https://docs.pixelfed.org/technical-documentation/config/#account_deletion))

    Defined at: [.env.example:199](https://github.com/jippi/dottie/blob/main/.env.example#L194)

    Validation: `required,boolean`

    ### ACCOUNT_DELETE_AFTER

    Set account deletion queue after X days, set to false to delete accounts immediately. ([*See Documentation*](https://docs.pixelfed.org/technical-documentation/config/#account_delete_after))

    Defined at: [.env.example:206](https://github.com/jippi/dottie/blob/main/.env.example#L201)

    Validation: `required,boolean`

    ### INSTANCE_DESCRIPTION ([*See Documentation*](https://docs.pixelfed.org/technical-documentation/config/#instance_description))

    Defined at: [.env.example:211](https://github.com/jippi/dottie/blob/main/.env.example#L208)

    Validation: `required`

    ### INSTANCE_PUBLIC_HASHTAGS ([*See Documentation*](https://docs.pixelfed.org/technical-documentation/config/#instance_public_hashtags))

    Defined at: [.env.example:216](https://github.com/jippi/dottie/blob/main/.env.example#L213)

    Validation: `required,boolean`

    ### INSTANCE_CONTACT_EMAIL

    The public e-mail address people can use to contact you by ([*See Documentation*](https://docs.pixelfed.org/technical-documentation/config/#instance_contact_email))

    Defined at: [.env.example:223](https://github.com/jippi/dottie/blob/main/.env.example#L218)

    Validation: `required,ne=__CHANGE_ME__,email`

    ### INSTANCE_PUBLIC_LOCAL_TIMELINE ([*See Documentation*](https://docs.pixelfed.org/technical-documentation/config/#instance_public_local_timeline))

    Defined at: [.env.example:228](https://github.com/jippi/dottie/blob/main/.env.example#L225)

    Validation: `required,boolean`

    ### BANNED_USERNAMES ([*See Documentation*](https://docs.pixelfed.org/technical-documentation/config/#banned_usernames))

    Defined at: [.env.example:232](https://github.com/jippi/dottie/blob/main/.env.example#L230)

    ### STORIES_ENABLED ([*See Documentation*](https://docs.pixelfed.org/technical-documentation/config/#stories_enabled))

    Defined at: [.env.example:237](https://github.com/jippi/dottie/blob/main/.env.example#L234)

    Validation: `required,boolean`

    ### RESTRICTED_INSTANCE

    Level is hardcoded to 1. ([*See Documentation*](https://docs.pixelfed.org/technical-documentation/config/#restricted_instance))

    Defined at: [.env.example:244](https://github.com/jippi/dottie/blob/main/.env.example#L239)

    Validation: `required,boolean`

    ### MEDIA_EXIF_DATABASE ([*See Documentation*](https://docs.pixelfed.org/technical-documentation/config/#media_exif_database))

    Defined at: [.env.example:249](https://github.com/jippi/dottie/blob/main/.env.example#L246)

    Validation: `required,boolean`

    ### IMAGE_DRIVER

    Pixelfed supports GD or ImageMagick to process images.

    Possible values:
    - "gd" (default)
    - "imagick" ([*See Documentation*](https://docs.pixelfed.org/technical-documentation/config/#image_driver))

    Defined at: [.env.example:260](https://github.com/jippi/dottie/blob/main/.env.example#L251)

    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*](https://docs.pixelfed.org/technical-documentation/config/#trust_proxies))

    Defined at: [.env.example:279](https://github.com/jippi/dottie/blob/main/.env.example#L262)

    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:
    - "apc"
    - "array"
    - "database"
    - "file" (default)
    - "memcached"
    - "redis" ([*See Documentation*](https://docs.pixelfed.org/technical-documentation/config/#cache_driver))

    Defined at: [.env.example:296](https://github.com/jippi/dottie/blob/main/.env.example#L281)

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

    ### CACHE_PREFIX ([*See Documentation*](https://docs.pixelfed.org/technical-documentation/config/#cache_prefix))

    Defined at: [.env.example:301](https://github.com/jippi/dottie/blob/main/.env.example#L298)

    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:
    - "pusher"
    - "redis"
    - "log"
    - "null" (default) ([*See Documentation*](https://docs.pixelfed.org/technical-documentation/config/#broadcast_driver))

    Defined at: [.env.example:314](https://github.com/jippi/dottie/blob/main/.env.example#L303)

    Validation: `required,oneof=pusher redis log null`

    ### RESTRICT_HTML_TYPES ([*See Documentation*](https://docs.pixelfed.org/technical-documentation/config/#restrict_html_types))

    Defined at: [.env.example:319](https://github.com/jippi/dottie/blob/main/.env.example#L316)

    Validation: `required,boolean`

    ### PASSPORT_PRIVATE_KEY ([*See Documentation*](https://docs.pixelfed.org/technical-documentation/config/#passport_private_key))

    Defined at: [.env.example:323](https://github.com/jippi/dottie/blob/main/.env.example#L321)

    Validation: `required`

    ### PASSPORT_PUBLIC_KEY ([*See Documentation*](https://docs.pixelfed.org/technical-documentation/config/#passport_public_key))

    Defined at: [.env.example:327](https://github.com/jippi/dottie/blob/main/.env.example#L325)

    Validation: `required`

    ## database

    ### DB_VERSION

    Database version to use (as Docker tag) ([*See Documentation*](https://hub.docker.com/_/mariadb))

    Defined at: [.env.example:337](https://github.com/jippi/dottie/blob/main/.env.example#L333)

    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:

    - "sqlite"
    - "mysql" (default)
    - "pgsql"
    - "sqlsrv" ([*See Documentation*](https://docs.pixelfed.org/technical-documentation/config/#db_connection))

    Defined at: [.env.example:353](https://github.com/jippi/dottie/blob/main/.env.example#L339)

    Validation: `required,oneof=sqlite mysql pgsql sqlsrv`

    ### DB_HOST ([*See Documentation*](https://docs.pixelfed.org/technical-documentation/config/#db_host))

    Defined at: [.env.example:357](https://github.com/jippi/dottie/blob/main/.env.example#L355)

    Validation: `required,hostname`

    ### DB_USERNAME ([*See Documentation*](https://docs.pixelfed.org/technical-documentation/config/#db_username))

    Defined at: [.env.example:361](https://github.com/jippi/dottie/blob/main/.env.example#L359)

    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*](https://docs.pixelfed.org/technical-documentation/config/#db_password))

    Defined at: [.env.example:368](https://github.com/jippi/dottie/blob/main/.env.example#L363)

    Validation: `required`

    ### DB_DATABASE ([*See Documentation*](https://docs.pixelfed.org/technical-documentation/config/#db_database))

    Defined at: [.env.example:372](https://github.com/jippi/dottie/blob/main/.env.example#L370)

    Validation: `required`

    ### DB_PORT

    Use "3306" for MySQL/MariaDB and "5432" for PostgreeSQL ([*See Documentation*](https://docs.pixelfed.org/technical-documentation/config/#db_port))

    Defined at: [.env.example:378](https://github.com/jippi/dottie/blob/main/.env.example#L374)

    Validation: `required,number`

    ### DB_APPLY_NEW_MIGRATIONS_AUTOMATICALLY

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

    Defined at: [.env.example:382](https://github.com/jippi/dottie/blob/main/.env.example#L380)

    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*](https://docs.pixelfed.org/technical-documentation/config/#mail_driver))

    Defined at: [.env.example:405](https://github.com/jippi/dottie/blob/main/.env.example#L388)

    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*](https://docs.pixelfed.org/technical-documentation/config/#mail_host))

    Defined at: [.env.example:414](https://github.com/jippi/dottie/blob/main/.env.example#L407)

    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*](https://docs.pixelfed.org/technical-documentation/config/#mail_port))

    Defined at: [.env.example:423](https://github.com/jippi/dottie/blob/main/.env.example#L416)

    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*](https://docs.pixelfed.org/technical-documentation/config/#mail_from_address))

    Defined at: [.env.example:432](https://github.com/jippi/dottie/blob/main/.env.example#L425)

    Validation: `required_with=MAIL_DRIVER,email,ne=__CHANGE_ME__`

    ### MAIL_FROM_NAME

    The 'name' you send e-mail from ([*See Documentation*](https://docs.pixelfed.org/technical-documentation/config/#mail_from_name))

    Defined at: [.env.example:439](https://github.com/jippi/dottie/blob/main/.env.example#L434)

    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*](https://docs.pixelfed.org/technical-documentation/config/#mail_username))

    Defined at: [.env.example:449](https://github.com/jippi/dottie/blob/main/.env.example#L441)

    Validation: `required_with=MAIL_DRIVER`

    ### MAIL_PASSWORD ([*See Documentation*](https://docs.pixelfed.org/technical-documentation/config/#mail_password))

    Defined at: [.env.example:454](https://github.com/jippi/dottie/blob/main/.env.example#L451)

    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*](https://docs.pixelfed.org/technical-documentation/config/#mail_encryption))

    Defined at: [.env.example:463](https://github.com/jippi/dottie/blob/main/.env.example#L456)

    Validation: `required_with=MAIL_DRIVER`

    ## redis

    ### REDIS_CLIENT ([*See Documentation*](https://docs.pixelfed.org/technical-documentation/config/#redis_client))

    Defined at: [.env.example:472](https://github.com/jippi/dottie/blob/main/.env.example#L469)

    Validation: `required`

    ### REDIS_SCHEME ([*See Documentation*](https://docs.pixelfed.org/technical-documentation/config/#redis_scheme))

    Defined at: [.env.example:477](https://github.com/jippi/dottie/blob/main/.env.example#L474)

    Validation: `required`

    ### REDIS_HOST ([*See Documentation*](https://docs.pixelfed.org/technical-documentation/config/#redis_host))

    Defined at: [.env.example:482](https://github.com/jippi/dottie/blob/main/.env.example#L479)

    Validation: `required`

    ### REDIS_PASSWORD ([*See Documentation*](https://docs.pixelfed.org/technical-documentation/config/#redis_password))

    Defined at: [.env.example:487](https://github.com/jippi/dottie/blob/main/.env.example#L484)

    Validation: `omitempty`

    ### REDIS_PORT ([*See Documentation*](https://docs.pixelfed.org/technical-documentation/config/#redis_port))

    Defined at: [.env.example:492](https://github.com/jippi/dottie/blob/main/.env.example#L489)

    Validation: `required,number`

    ### REDIS_DATABASE ([*See Documentation*](https://docs.pixelfed.org/technical-documentation/config/#redis_database))

    Defined at: [.env.example:497](https://github.com/jippi/dottie/blob/main/.env.example#L494)

    Validation: `required,number`

    ## experiments

    ### EXP_TOP

    Text only posts (alpha). ([*See Documentation*](https://docs.pixelfed.org/technical-documentation/config/#exp_top))

    Defined at: [.env.example:508](https://github.com/jippi/dottie/blob/main/.env.example#L503)

    Validation: `required,boolean`

    ### EXP_POLLS

    Poll statuses (alpha). ([*See Documentation*](https://docs.pixelfed.org/technical-documentation/config/#exp_polls))

    Defined at: [.env.example:515](https://github.com/jippi/dottie/blob/main/.env.example#L510)

    Validation: `required,boolean`

    ### EXP_CPT

    Cached public timeline for larger instances (beta). ([*See Documentation*](https://docs.pixelfed.org/technical-documentation/config/#exp_cpt))

    Defined at: [.env.example:522](https://github.com/jippi/dottie/blob/main/.env.example#L517)

    Validation: `required,boolean`

    ### EXP_EMC

    Enforce Mastodon API Compatibility (alpha). ([*See Documentation*](https://docs.pixelfed.org/technical-documentation/config/#exp_emc))

    Defined at: [.env.example:529](https://github.com/jippi/dottie/blob/main/.env.example#L524)

    Validation: `required,boolean`

    ## ActivityPub

    ### ACTIVITY_PUB ([*See Documentation*](https://docs.pixelfed.org/technical-documentation/config/#activity_pub))

    Defined at: [.env.example:538](https://github.com/jippi/dottie/blob/main/.env.example#L535)

    Validation: `required,boolean`

    ### AP_REMOTE_FOLLOW ([*See Documentation*](https://docs.pixelfed.org/technical-documentation/config/#ap_remote_follow))

    Defined at: [.env.example:543](https://github.com/jippi/dottie/blob/main/.env.example#L540)

    Validation: `required,boolean`

    ### AP_SHAREDINBOX ([*See Documentation*](https://docs.pixelfed.org/technical-documentation/config/#ap_sharedinbox))

    Defined at: [.env.example:548](https://github.com/jippi/dottie/blob/main/.env.example#L545)

    Validation: `required,boolean`

    ### AP_INBOX ([*See Documentation*](https://docs.pixelfed.org/technical-documentation/config/#ap_inbox))

    Defined at: [.env.example:553](https://github.com/jippi/dottie/blob/main/.env.example#L550)

    Validation: `required,boolean`

    ### AP_OUTBOX ([*See Documentation*](https://docs.pixelfed.org/technical-documentation/config/#ap_outbox))

    Defined at: [.env.example:558](https://github.com/jippi/dottie/blob/main/.env.example#L555)

    Validation: `required,boolean`

    ## Federation

    ### ATOM_FEEDS ([*See Documentation*](https://docs.pixelfed.org/technical-documentation/config/#atom_feeds))

    Defined at: [.env.example:567](https://github.com/jippi/dottie/blob/main/.env.example#L564)

    Validation: `required,boolean`

    ### NODEINFO ([*See Documentation*](https://docs.pixelfed.org/technical-documentation/config/#nodeinfo))

    Defined at: [.env.example:572](https://github.com/jippi/dottie/blob/main/.env.example#L569)

    Validation: `required,boolean`

    ### WEBFINGER ([*See Documentation*](https://docs.pixelfed.org/technical-documentation/config/#webfinger))

    Defined at: [.env.example:577](https://github.com/jippi/dottie/blob/main/.env.example#L574)

    Validation: `required,boolean`

    ## Storage

    ### PF_ENABLE_CLOUD

    Store media on object storage like S3, Digital Ocean Spaces, Rackspace ([*See Documentation*](https://docs.pixelfed.org/technical-documentation/config/#pf_enable_cloud))

    Defined at: [.env.example:588](https://github.com/jippi/dottie/blob/main/.env.example#L583)

    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*](https://docs.pixelfed.org/technical-documentation/config/#filesystem_cloud))

    Defined at: [.env.example:598](https://github.com/jippi/dottie/blob/main/.env.example#L590)

    Validation: `required_with=PF_ENABLE_CLOUD`

    ### MEDIA_DELETE_LOCAL_AFTER_CLOUD ([*See Documentation*](https://docs.pixelfed.org/technical-documentation/config/#media_delete_local_after_cloud))

    Defined at: [.env.example:603](https://github.com/jippi/dottie/blob/main/.env.example#L600)

    Validation: `required_with=PF_ENABLE_CLOUD,boolean`

    ### AWS_ACCESS_KEY_ID ([*See Documentation*](https://docs.pixelfed.org/technical-documentation/config/#aws_access_key_id))

    Defined at: [.env.example:607](https://github.com/jippi/dottie/blob/main/.env.example#L605)

    Validation: `required_if=FILESYSTEM_CLOUD s3`

    ### AWS_SECRET_ACCESS_KEY ([*See Documentation*](https://docs.pixelfed.org/technical-documentation/config/#aws_secret_access_key))

    Defined at: [.env.example:611](https://github.com/jippi/dottie/blob/main/.env.example#L609)

    Validation: `required_if=FILESYSTEM_CLOUD s3`

    ### AWS_DEFAULT_REGION ([*See Documentation*](https://docs.pixelfed.org/technical-documentation/config/#aws_default_region))

    Defined at: [.env.example:615](https://github.com/jippi/dottie/blob/main/.env.example#L613)

    Validation: `required_if=FILESYSTEM_CLOUD s3`

    ### AWS_BUCKET ([*See Documentation*](https://docs.pixelfed.org/technical-documentation/config/#aws_bucket))

    Defined at: [.env.example:619](https://github.com/jippi/dottie/blob/main/.env.example#L617)

    Validation: `required_if=FILESYSTEM_CLOUD s3`

    ### AWS_URL ([*See Documentation*](https://docs.pixelfed.org/technical-documentation/config/#aws_url))

    Defined at: [.env.example:623](https://github.com/jippi/dottie/blob/main/.env.example#L621)

    Validation: `required_if=FILESYSTEM_CLOUD s3`

    ### AWS_ENDPOINT ([*See Documentation*](https://docs.pixelfed.org/technical-documentation/config/#aws_endpoint))

    Defined at: [.env.example:627](https://github.com/jippi/dottie/blob/main/.env.example#L625)

    Validation: `required_if=FILESYSTEM_CLOUD s3`

    ### AWS_USE_PATH_STYLE_ENDPOINT ([*See Documentation*](https://docs.pixelfed.org/technical-documentation/config/#aws_use_path_style_endpoint))

    Defined at: [.env.example:631](https://github.com/jippi/dottie/blob/main/.env.example#L629)

    Validation: `required_if=FILESYSTEM_CLOUD s3`

    ## COSTAR

    ### CS_BLOCKED_DOMAINS

    Comma-separated list of domains to block. ([*See Documentation*](https://docs.pixelfed.org/technical-documentation/config/#cs_blocked_domains))

    Defined at: [.env.example:642](https://github.com/jippi/dottie/blob/main/.env.example#L637)

    Validation: ``

    ### CS_CW_DOMAINS

    Comma-separated list of domains to add warnings. ([*See Documentation*](https://docs.pixelfed.org/technical-documentation/config/#cs_cw_domains))

    Defined at: [.env.example:649](https://github.com/jippi/dottie/blob/main/.env.example#L644)

    Validation: ``

    ### CS_UNLISTED_DOMAINS

    Comma-separated list of domains to remove from public timelines. ([*See Documentation*](https://docs.pixelfed.org/technical-documentation/config/#cs_unlisted_domains))

    Defined at: [.env.example:656](https://github.com/jippi/dottie/blob/main/.env.example#L651)

    Validation: ``

    ### CS_BLOCKED_KEYWORDS

    Comma-separated list of keywords to block. ([*See Documentation*](https://docs.pixelfed.org/technical-documentation/config/#cs_blocked_keywords))

    Defined at: [.env.example:663](https://github.com/jippi/dottie/blob/main/.env.example#L658)

    Validation: ``

    ### CS_CW_KEYWORDS

    Comma-separated list of keywords to add warnings. ([*See Documentation*](https://docs.pixelfed.org/technical-documentation/config/#cs_cw_keywords))

    Defined at: [.env.example:670](https://github.com/jippi/dottie/blob/main/.env.example#L665)

    Validation: ``

    ### CS_UNLISTED_KEYWORDS

    Comma-separated list of keywords to remove from public timelines. ([*See Documentation*](https://docs.pixelfed.org/technical-documentation/config/#cs_unlisted_keywords))

    Defined at: [.env.example:677](https://github.com/jippi/dottie/blob/main/.env.example#L672)

    Validation: ``

    ### CS_BLOCKED_ACTOR ([*See Documentation*](https://docs.pixelfed.org/technical-documentation/config/#cs_blocked_actor))

    Defined at: [.env.example:682](https://github.com/jippi/dottie/blob/main/.env.example#L679)

    Validation: ``

    ### CS_CW_ACTOR ([*See Documentation*](https://docs.pixelfed.org/technical-documentation/config/#cs_cw_actor))

    Defined at: [.env.example:687](https://github.com/jippi/dottie/blob/main/.env.example#L684)

    Validation: ``

    ### CS_UNLISTED_ACTOR ([*See Documentation*](https://docs.pixelfed.org/technical-documentation/config/#cs_unlisted_actor))

    Defined at: [.env.example:692](https://github.com/jippi/dottie/blob/main/.env.example#L689)

    Validation: ``

    ## logging

    ### LOG_CHANNEL

    Possible values:

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

    Defined at: [.env.example:713](https://github.com/jippi/dottie/blob/main/.env.example#L698)

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

    ### LOG_LEVEL

    Used by single, stderr and syslog. ([*See Documentation*](https://docs.pixelfed.org/technical-documentation/config/#log_level))

    Defined at: [.env.example:720](https://github.com/jippi/dottie/blob/main/.env.example#L715)

    Validation: `required,boolean`

    ### LOG_STDERR_FORMATTER

    Used by stderr. ([*See Documentation*](https://docs.pixelfed.org/technical-documentation/config/#log_stderr_formatter))

    Defined at: [.env.example:727](https://github.com/jippi/dottie/blob/main/.env.example#L722)

    Validation: `required`

    ### LOG_SLACK_WEBHOOK_URL

    Used by slack. ([*See Documentation*](https://docs.pixelfed.org/technical-documentation/config/#log_slack_webhook_url))

    Defined at: [.env.example:734](https://github.com/jippi/dottie/blob/main/.env.example#L729)

    Validation: `required,http_url`

    ## queue

    ### QUEUE_DRIVER

    Possible values:
    - "sync" (default)
    - "database"
    - "beanstalkd"
    - "sqs"
    - "redis"
    - "null" ([*See Documentation*](https://docs.pixelfed.org/technical-documentation/config/#queue_driver))

    Defined at: [.env.example:751](https://github.com/jippi/dottie/blob/main/.env.example#L740)

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

    ### SQS_KEY ([*See Documentation*](https://docs.pixelfed.org/technical-documentation/config/#sqs_key))

    Defined at: [.env.example:756](https://github.com/jippi/dottie/blob/main/.env.example#L753)

    Validation: `required_if=QUEUE_DRIVER sqs`

    ### SQS_SECRET ([*See Documentation*](https://docs.pixelfed.org/technical-documentation/config/#sqs_secret))

    Defined at: [.env.example:761](https://github.com/jippi/dottie/blob/main/.env.example#L758)

    Validation: `required_if=QUEUE_DRIVER sqs`

    ### SQS_PREFIX ([*See Documentation*](https://docs.pixelfed.org/technical-documentation/config/#sqs_prefix))

    Defined at: [.env.example:766](https://github.com/jippi/dottie/blob/main/.env.example#L763)

    Validation: `required_if=QUEUE_DRIVER sqs`

    ### SQS_QUEUE ([*See Documentation*](https://docs.pixelfed.org/technical-documentation/config/#sqs_queue))

    Defined at: [.env.example:771](https://github.com/jippi/dottie/blob/main/.env.example#L768)

    Validation: `required_if=QUEUE_DRIVER sqs`

    ### SQS_REGION ([*See Documentation*](https://docs.pixelfed.org/technical-documentation/config/#sqs_region))

    Defined at: [.env.example:776](https://github.com/jippi/dottie/blob/main/.env.example#L773)

    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](https://github.com/jippi/dottie/blob/main/.env.example#L782)

    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*](https://docs.pixelfed.org/technical-documentation/config/#session_lifetime))

    Defined at: [.env.example:806](https://github.com/jippi/dottie/blob/main/.env.example#L799)

    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*](https://docs.pixelfed.org/technical-documentation/config/#session_domain))

    Defined at: [.env.example:817](https://github.com/jippi/dottie/blob/main/.env.example#L808)

    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*](https://docs.pixelfed.org/technical-documentation/config/#horizon_prefix))

    Defined at: [.env.example:831](https://github.com/jippi/dottie/blob/main/.env.example#L823)

    Validation: `required`

    ### HORIZON_DARKMODE ([*See Documentation*](https://docs.pixelfed.org/technical-documentation/config/#horizon_darkmode))

    Defined at: [.env.example:836](https://github.com/jippi/dottie/blob/main/.env.example#L833)

    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](https://github.com/jippi/dottie/blob/main/.env.example#L838)

    Validation: `required,number`

    ### HORIZON_BALANCE_STRATEGY ([*See Documentation*](https://docs.pixelfed.org/technical-documentation/config/#horizon_balance_strategy))

    Defined at: [.env.example:849](https://github.com/jippi/dottie/blob/main/.env.example#L847)

    Validation: `required`

    ### HORIZON_MIN_PROCESSES ([*See Documentation*](https://docs.pixelfed.org/technical-documentation/config/#horizon_min_processes))

    Defined at: [.env.example:853](https://github.com/jippi/dottie/blob/main/.env.example#L851)

    Validation: `required,number`

    ### HORIZON_MAX_PROCESSES ([*See Documentation*](https://docs.pixelfed.org/technical-documentation/config/#horizon_max_processes))

    Defined at: [.env.example:857](https://github.com/jippi/dottie/blob/main/.env.example#L855)

    Validation: `required,number`

    ### HORIZON_SUPERVISOR_MEMORY ([*See Documentation*](https://docs.pixelfed.org/technical-documentation/config/#horizon_supervisor_memory))

    Defined at: [.env.example:861](https://github.com/jippi/dottie/blob/main/.env.example#L859)

    Validation: `required,number`

    ### HORIZON_SUPERVISOR_TRIES ([*See Documentation*](https://docs.pixelfed.org/technical-documentation/config/#horizon_supervisor_tries))

    Defined at: [.env.example:865](https://github.com/jippi/dottie/blob/main/.env.example#L863)

    Validation: `required,number`

    ### HORIZON_SUPERVISOR_NICE ([*See Documentation*](https://docs.pixelfed.org/technical-documentation/config/#horizon_supervisor_nice))

    Defined at: [.env.example:869](https://github.com/jippi/dottie/blob/main/.env.example#L867)

    Validation: `required,number`

    ### HORIZON_SUPERVISOR_TIMEOUT ([*See Documentation*](https://docs.pixelfed.org/technical-documentation/config/#horizon_supervisor_timeout))

    Defined at: [.env.example:873](https://github.com/jippi/dottie/blob/main/.env.example#L871)

    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*](https://docs.pixelfed.org/technical-documentation/config/#app_key))

    Defined at: [.env.example:890](https://github.com/jippi/dottie/blob/main/.env.example#L879)

    Validation: `required`

    ### DOCKER_ALL_CONTAINER_NAME_PREFIX

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

    Defined at: [.env.example:894](https://github.com/jippi/dottie/blob/main/.env.example#L892)

    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](https://github.com/jippi/dottie/blob/main/.env.example#L896)

    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](https://github.com/jippi/dottie/blob/main/.env.example#L904)

    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](https://github.com/jippi/dottie/blob/main/.env.example#L911)

    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](https://github.com/jippi/dottie/blob/main/.env.example#L917)

    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](https://github.com/jippi/dottie/blob/main/.env.example#L923)

    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*](https://www.php.net/manual/en/timezones.php))

    Defined at: [.env.example:935](https://github.com/jippi/dottie/blob/main/.env.example#L929)

    Validation: `required,timezone`

    ## docker app

    ### DOCKER_APP_RELEASE

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

    * latest
    * <some semver release>
    * staging
    * edge
    * branch-<some branch name>
    * pr-<some merge request id>

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

    Defined at: [.env.example:953](https://github.com/jippi/dottie/blob/main/.env.example#L941)

    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](https://github.com/jippi/dottie/blob/main/.env.example#L955)

    Validation: `required`

    ### DOCKER_APP_RUNTIME

    The container runtime to use. ([*See Documentation*](https://docs.pixelfed.org/running-pixelfed/docker/runtimes.html))

    Defined at: [.env.example:976](https://github.com/jippi/dottie/blob/main/.env.example#L972)

    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](https://github.com/jippi/dottie/blob/main/.env.example#L978)

    Validation: `required,oneof=bookwork bullseye`

    ### DOCKER_APP_BASE_TYPE

    The [php] Docker image base type ([*See Documentation*](https://docs.pixelfed.org/running-pixelfed/docker/runtimes.html))

    Defined at: [.env.example:988](https://github.com/jippi/dottie/blob/main/.env.example#L984)

    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](https://github.com/jippi/dottie/blob/main/.env.example#L990)

    Validation: `required`

    ### DOCKER_APP_TAG

    Pixelfed version (image tag) to pull from the registry. ([*See Documentation*](https://github.com/pixelfed/pixelfed/pkgs/container/pixelfed))

    Defined at: [.env.example:1005](https://github.com/jippi/dottie/blob/main/.env.example#L1001)

    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](https://github.com/jippi/dottie/blob/main/.env.example#L1007)

    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](https://github.com/jippi/dottie/blob/main/.env.example#L1014)

    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](https://github.com/jippi/dottie/blob/main/.env.example#L1021)

    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](https://github.com/jippi/dottie/blob/main/.env.example#L1031)

    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](https://github.com/jippi/dottie/blob/main/.env.example#L1042)

    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*](https://github.com/pixelfed/pixelfed/blob/dev/docker/customizing.md))

    Defined at: [.env.example:1052](https://github.com/jippi/dottie/blob/main/.env.example#L1047)

    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*](https://github.com/pixelfed/pixelfed/blob/dev/docker/customizing.md))

    Defined at: [.env.example:1059](https://github.com/jippi/dottie/blob/main/.env.example#L1054)

    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*](https://github.com/pixelfed/pixelfed/blob/dev/docker/customizing.md))

    Defined at: [.env.example:1066](https://github.com/jippi/dottie/blob/main/.env.example#L1061)

    Validation: `required`

    ### DOCKER_APP_PHP_MEMORY_LIMIT ([*See Documentation*](https://www.php.net/manual/en/ini.core.php#ini.memory-limit))

    Defined at: [.env.example:1071](https://github.com/jippi/dottie/blob/main/.env.example#L1068)

    Validation: `required`

    ## docker redis

    ### DOCKER_REDIS_VERSION

    Redis version to use as Docker tag ([*See Documentation*](https://hub.docker.com/_/redis))

    Defined at: [.env.example:1081](https://github.com/jippi/dottie/blob/main/.env.example#L1077)

    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](https://github.com/jippi/dottie/blob/main/.env.example#L1083)

    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](https://github.com/jippi/dottie/blob/main/.env.example#L1089)

    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](https://github.com/jippi/dottie/blob/main/.env.example#L1093)

    Validation: `required`

    ### DOCKER_REDIS_HEALTHCHECK_INTERVAL

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

    Defined at: [.env.example:1107](https://github.com/jippi/dottie/blob/main/.env.example#L1103)

    Validation: `required`

    ## docker db

    ### DOCKER_DB_IMAGE

    Docker image for the DB service

    Defined at: [.env.example:1115](https://github.com/jippi/dottie/blob/main/.env.example#L1113)

    Validation: `required`

    ### DOCKER_DB_COMMAND

    Command to pass to the [db] server container

    Defined at: [.env.example:1119](https://github.com/jippi/dottie/blob/main/.env.example#L1117)

    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](https://github.com/jippi/dottie/blob/main/.env.example#L1121)

    ### 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](https://github.com/jippi/dottie/blob/main/.env.example#L1124)

    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](https://github.com/jippi/dottie/blob/main/.env.example#L1130)

    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](https://github.com/jippi/dottie/blob/main/.env.example#L1139)

    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](https://github.com/jippi/dottie/blob/main/.env.example#L1145)

    Validation: `required,number`

    ### DOCKER_DB_HEALTHCHECK_INTERVAL

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

    Defined at: [.env.example:1153](https://github.com/jippi/dottie/blob/main/.env.example#L1151)

    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](https://github.com/jippi/dottie/blob/main/.env.example#L1159)

    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](https://github.com/jippi/dottie/blob/main/.env.example#L1163)

    Validation: `required,number`

    ### DOCKER_WEB_HEALTHCHECK_INTERVAL

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

    Defined at: [.env.example:1169](https://github.com/jippi/dottie/blob/main/.env.example#L1167)

    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](https://github.com/jippi/dottie/blob/main/.env.example#L1175)

    Validation: `required`

    ### DOCKER_WORKER_HEALTHCHECK_INTERVAL

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

    Defined at: [.env.example:1181](https://github.com/jippi/dottie/blob/main/.env.example#L1179)

    Validation: `required`

    ## docker proxy

    ### DOCKER_PROXY_VERSION

    The version of nginx-proxy to use ([*See Documentation*](https://hub.docker.com/r/nginxproxy/nginx-proxy))

    Defined at: [.env.example:1191](https://github.com/jippi/dottie/blob/main/.env.example#L1187)

    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](https://github.com/jippi/dottie/blob/main/.env.example#L1193)

    ### 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](https://github.com/jippi/dottie/blob/main/.env.example#L1196)

    ### DOCKER_PROXY_HEALTHCHECK_INTERVAL

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

    Defined at: [.env.example:1201](https://github.com/jippi/dottie/blob/main/.env.example#L1199)

    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](https://github.com/jippi/dottie/blob/main/.env.example#L1203)

    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](https://github.com/jippi/dottie/blob/main/.env.example#L1207)

    Validation: `required,number`

    ### DOCKER_PROXY_HOST_DOCKER_SOCKET_PATH

    Path to the Docker socket on the *host*

    Defined at: [.env.example:1213](https://github.com/jippi/dottie/blob/main/.env.example#L1211)

    Validation: `required,file`

    ### DOCKER_PROXY_LETSENCRYPT_HOST

    The host to request LetsEncrypt certificate for

    Defined at: [.env.example:1217](https://github.com/jippi/dottie/blob/main/.env.example#L1215)

    Validation: `required,fqdn`

    ### DOCKER_PROXY_LETSENCRYPT_EMAIL

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

    Defined at: [.env.example:1221](https://github.com/jippi/dottie/blob/main/.env.example#L1219)

    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](https://github.com/jippi/dottie/blob/main/.env.example#L1223)