2 # You may set REDIS_URL instead for more advanced options
5 # You may set DATABASE_URL instead for more advanced options
13 # Note: Changing LOCAL_DOMAIN or LOCAL_HTTPS at a later time will cause unwanted side effects.
14 # LOCAL_DOMAIN should *NOT* contain the protocol part of the domain e.g https://example.com.
15 LOCAL_DOMAIN=example.com
18 # Use this only if you need to run mastodon on a different domain than the one used for federation.
19 # You can read more about this option on https://github.com/tootsuite/documentation/blob/master/Running-Mastodon/Serving_a_different_domain.md
20 # DO *NOT* USE THIS UNLESS YOU KNOW *EXACTLY* WHAT YOU ARE DOING.
21 # WEB_DOMAIN=mastodon.example.com
23 # Use this if you want to have several aliases handler@example1.com
24 # handler@example2.com etc. for the same user. LOCAL_DOMAIN should not
25 # be added. Comma separated values
26 # ALTERNATE_DOMAINS=example1.com,example2.com
29 # Generate each with the `RAILS_ENV=production bundle exec rake secret` task (`docker-compose run --rm web rake secret` if you use docker compose)
34 # VAPID keys (used for push notifications
35 # You can generate the keys using the following command (first is the private key, second is the public one)
36 # You should only generate this once per instance. If you later decide to change it, all push subscription will
37 # be invalidated, requiring the users to access the website again to resubscribe.
39 # Generate with `RAILS_ENV=production bundle exec rake mastodon:webpush:generate_vapid_key` task (`docker-compose run --rm web rake mastodon:webpush:generate_vapid_key` if you use docker compose)
41 # For more information visit https://rossta.net/blog/using-the-web-push-api-with-vapid.html
46 # Single user mode will disable registrations and redirect frontpage to the first profile
47 # SINGLE_USER_MODE=true
48 # Prevent registrations with following e-mail domains
49 # EMAIL_DOMAIN_BLACKLIST=example1.com|example2.de|etc
50 # Only allow registrations with the following e-mail domains
51 # EMAIL_DOMAIN_WHITELIST=example1.com|example2.de|etc
53 # Optionally change default language
56 # E-mail configuration
57 # Note: Mailgun and SparkPost (https://sparkpo.st/smtp) each have good free tiers
58 # If you want to use an SMTP server without authentication (e.g local Postfix relay)
59 # then set SMTP_AUTH_METHOD and SMTP_OPENSSL_VERIFY_MODE to 'none' and
60 # *comment* SMTP_LOGIN and SMTP_PASSWORD (leaving them blank is not enough).
61 SMTP_SERVER=smtp.mailgun.org
65 SMTP_FROM_ADDRESS=notifications@example.com
66 #SMTP_DOMAIN= # defaults to LOCAL_DOMAIN
67 #SMTP_DELIVERY_METHOD=smtp # delivery method can also be sendmail
68 #SMTP_AUTH_METHOD=plain
69 #SMTP_CA_FILE=/etc/ssl/certs/ca-certificates.crt
70 #SMTP_OPENSSL_VERIFY_MODE=peer
71 #SMTP_ENABLE_STARTTLS_AUTO=true
74 # 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.
75 # PAPERCLIP_ROOT_PATH=/var/lib/mastodon/public-system
76 # PAPERCLIP_ROOT_URL=/system
78 # Optional asset host for multi-server setups
79 # CDN_HOST=https://assets.example.com
85 # AWS_SECRET_ACCESS_KEY=
88 # S3_HOSTNAME=192.168.1.123:9000
90 # S3 (Minio Config (optional) Please check Minio instance for details)
94 # AWS_SECRET_ACCESS_KEY=
99 # S3_SIGNATURE_VERSION=
110 # Optional alias for S3 if you want to use Cloudfront or Cloudflare in front
111 # S3_CLOUDFRONT_HOST=
113 # Streaming API integration
114 # STREAMING_API_BASE_URL=
117 # If you need to use pgBouncer, you need to disable prepared statements:
118 # PREPARED_STATEMENTS=false
120 # Cluster number setting for streaming API server.
121 # If you comment out following line, cluster number will be `numOfCpuCores - 1`.
122 STREAMING_CLUSTER_NUM=1
124 # Docker mastodon user
125 # If you use Docker, you may want to assign UID/GID manually.