forked from mirrors/catstodon
4d22d03fab
* Add additional documentation and warnings to the WEB_DOMAIN setting. This feature is largely undocumented, and quite a number of users have shot them in the feet already despite the warning. Added a bit of documentation and expanded the warning until we have a mechanism for dealing with conflicting user URIs. * Change WEB_DOMAIN comments to point to the extensive online documentation
95 lines
3.1 KiB
Text
95 lines
3.1 KiB
Text
# Service dependencies
|
|
# You may set REDIS_URL instead for more advanced options
|
|
REDIS_HOST=redis
|
|
REDIS_PORT=6379
|
|
# You may set DATABASE_URL instead for more advanced options
|
|
DB_HOST=db
|
|
DB_USER=postgres
|
|
DB_NAME=postgres
|
|
DB_PASS=
|
|
DB_PORT=5432
|
|
|
|
# Federation
|
|
LOCAL_DOMAIN=example.com
|
|
LOCAL_HTTPS=true
|
|
|
|
# Use this only if you need to run mastodon on a different domain than the one used for federation.
|
|
# You can read more about this option on https://github.com/tootsuite/documentation/blob/master/Running-Mastodon/Serving_a_different_domain.md
|
|
# DO *NOT* USE THIS UNLESS YOU KNOW *EXACTLY* WHAT YOU ARE DOING.
|
|
# WEB_DOMAIN=mastodon.example.com
|
|
|
|
# Application secrets
|
|
# Generate each with the `rake secret` task (`docker-compose run --rm web rake secret` if you use docker compose)
|
|
PAPERCLIP_SECRET=
|
|
SECRET_KEY_BASE=
|
|
OTP_SECRET=
|
|
|
|
# Registrations
|
|
# Single user mode will disable registrations and redirect frontpage to the first profile
|
|
# SINGLE_USER_MODE=true
|
|
# Prevent registrations with following e-mail domains
|
|
# EMAIL_DOMAIN_BLACKLIST=example1.com|example2.de|etc
|
|
# Only allow registrations with the following e-mail domains
|
|
# EMAIL_DOMAIN_WHITELIST=example1.com|example2.de|etc
|
|
|
|
# Optionally change default language
|
|
# DEFAULT_LOCALE=de
|
|
|
|
# E-mail configuration
|
|
# Note: Mailgun and SparkPost (https://sparkpo.st/smtp) each have good free tiers
|
|
# If you want to use an SMTP server without authentication (e.g local Postfix relay)
|
|
# then set SMTP_AUTH_METHOD to 'none' and *comment* SMTP_LOGIN and SMTP_PASSWORD.
|
|
# Leaving them blank is not enough for authentication method 'none'.
|
|
SMTP_SERVER=smtp.mailgun.org
|
|
SMTP_PORT=587
|
|
SMTP_LOGIN=
|
|
SMTP_PASSWORD=
|
|
SMTP_FROM_ADDRESS=notifications@example.com
|
|
#SMTP_DOMAIN= # defaults to LOCAL_DOMAIN
|
|
#SMTP_DELIVERY_METHOD=smtp # delivery method can also be sendmail
|
|
#SMTP_AUTH_METHOD=plain
|
|
#SMTP_CA_FILE=/etc/ssl/certs/ca-certificates.crt
|
|
#SMTP_OPENSSL_VERIFY_MODE=peer
|
|
#SMTP_ENABLE_STARTTLS_AUTO=true
|
|
|
|
|
|
# Optional user upload path and URL (images, avatars). Default is :rails_root/public/system. If you set this variable, you are responsible for making your HTTP server (eg. nginx) serve these files.
|
|
# PAPERCLIP_ROOT_PATH=/var/lib/mastodon/public-system
|
|
# PAPERCLIP_ROOT_URL=/system
|
|
|
|
# Optional asset host for multi-server setups
|
|
# CDN_HOST=assets.example.com
|
|
|
|
# S3 (optional)
|
|
# S3_ENABLED=true
|
|
# S3_BUCKET=
|
|
# AWS_ACCESS_KEY_ID=
|
|
# AWS_SECRET_ACCESS_KEY=
|
|
# S3_REGION=
|
|
# S3_PROTOCOL=http
|
|
# S3_HOSTNAME=192.168.1.123:9000
|
|
|
|
# S3 (Minio Config (optional) Please check Minio instance for details)
|
|
# S3_ENABLED=true
|
|
# S3_BUCKET=
|
|
# AWS_ACCESS_KEY_ID=
|
|
# AWS_SECRET_ACCESS_KEY=
|
|
# S3_REGION=
|
|
# S3_PROTOCOL=https
|
|
# S3_HOSTNAME=
|
|
# S3_ENDPOINT=
|
|
# S3_SIGNATURE_VERSION=
|
|
|
|
# Optional alias for S3 if you want to use Cloudfront or Cloudflare in front
|
|
# S3_CLOUDFRONT_HOST=
|
|
|
|
# Streaming API integration
|
|
# STREAMING_API_BASE_URL=
|
|
|
|
# Advanced settings
|
|
# If you need to use pgBouncer, you need to disable prepared statements:
|
|
# PREPARED_STATEMENTS=false
|
|
|
|
# Cluster number setting for streaming API server.
|
|
# If you comment out following line, cluster number will be `numOfCpuCores - 1`.
|
|
STREAMING_CLUSTER_NUM=1
|