2016-03-16 07:13:40 -04:00
# Service dependencies
2017-05-03 17:18:13 -04:00
# You may set REDIS_URL instead for more advanced options
2016-03-14 16:39:39 -04:00
REDIS_HOST=redis
2016-03-16 07:57:01 -04:00
REDIS_PORT=6379
2017-05-04 09:53:44 -04:00
# You may set DATABASE_URL instead for more advanced options
2016-03-16 07:57:01 -04:00
DB_HOST=db
DB_USER=postgres
DB_NAME=postgres
DB_PASS=
DB_PORT=5432
2016-03-16 07:13:40 -04:00
# Federation
2017-05-19 14:55:15 -04:00
# Note: Changing LOCAL_DOMAIN or LOCAL_HTTPS at a later time will cause unwanted side effects.
# LOCAL_DOMAIN should *NOT* contain the protocol part of the domain e.g https://example.com.
LOCAL_DOMAIN=example.com
2016-03-14 16:39:39 -04:00
LOCAL_HTTPS=true
2016-03-16 07:13:40 -04:00
2017-04-14 20:15:46 -04:00
# Use this only if you need to run mastodon on a different domain than the one used for federation.
2017-05-04 22:56:28 -04:00
# 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.
2017-04-14 20:15:46 -04:00
# WEB_DOMAIN=mastodon.example.com
2016-03-16 07:13:40 -04:00
# Application secrets
2016-12-29 14:53:18 -05:00
# Generate each with the `rake secret` task (`docker-compose run --rm web rake secret` if you use docker compose)
2016-03-14 16:39:39 -04:00
PAPERCLIP_SECRET=
SECRET_KEY_BASE=
2017-01-29 07:06:58 -05:00
OTP_SECRET=
2016-03-16 07:13:40 -04:00
2016-12-06 11:19:26 -05:00
# 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
2017-04-04 11:04:44 -04:00
# Only allow registrations with the following e-mail domains
# EMAIL_DOMAIN_WHITELIST=example1.com|example2.de|etc
2016-12-06 11:19:26 -05:00
2017-04-07 06:40:26 -04:00
# Optionally change default language
# DEFAULT_LOCALE=de
2016-03-16 07:13:40 -04:00
# E-mail configuration
2017-04-07 07:43:44 -04:00
# Note: Mailgun and SparkPost (https://sparkpo.st/smtp) each have good free tiers
2017-04-17 04:41:19 -04:00
# If you want to use an SMTP server without authentication (e.g local Postfix relay)
2017-05-07 21:34:11 -04:00
# then set SMTP_AUTH_METHOD and SMTP_OPENSSL_VERIFY_MODE to 'none' and
# *comment* SMTP_LOGIN and SMTP_PASSWORD (leaving them blank is not enough).
2016-03-16 07:13:40 -04:00
SMTP_SERVER=smtp.mailgun.org
SMTP_PORT=587
SMTP_LOGIN=
SMTP_PASSWORD=
SMTP_FROM_ADDRESS=notifications@example.com
2017-04-17 04:42:29 -04:00
#SMTP_DOMAIN= # defaults to LOCAL_DOMAIN
2017-04-13 13:51:49 -04:00
#SMTP_DELIVERY_METHOD=smtp # delivery method can also be sendmail
2017-04-10 15:48:30 -04:00
#SMTP_AUTH_METHOD=plain
2017-05-02 19:03:12 -04:00
#SMTP_CA_FILE=/etc/ssl/certs/ca-certificates.crt
2017-04-10 15:48:30 -04:00
#SMTP_OPENSSL_VERIFY_MODE=peer
#SMTP_ENABLE_STARTTLS_AUTO=true
2016-11-26 09:27:05 -05:00
2017-04-14 20:07:21 -04:00
# 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
2016-11-26 09:27:05 -05:00
# Optional asset host for multi-server setups
# CDN_HOST=assets.example.com
2016-11-29 08:20:15 -05:00
# S3 (optional)
2016-12-06 11:19:26 -05:00
# S3_ENABLED=true
# S3_BUCKET=
# AWS_ACCESS_KEY_ID=
# AWS_SECRET_ACCESS_KEY=
# S3_REGION=
2017-03-23 03:44:55 -04:00
# S3_PROTOCOL=http
# S3_HOSTNAME=192.168.1.123:9000
2016-12-06 11:19:26 -05:00
2017-04-07 06:58:12 -04:00
# 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=
2017-04-19 08:18:50 -04:00
# S3_SIGNATURE_VERSION=
2017-04-07 06:58:12 -04:00
2016-12-06 11:19:26 -05:00
# Optional alias for S3 if you want to use Cloudfront or Cloudflare in front
# S3_CLOUDFRONT_HOST=
2017-01-29 07:06:58 -05:00
2017-02-03 18:34:31 -05:00
# Streaming API integration
# STREAMING_API_BASE_URL=
2017-04-08 23:46:32 -04:00
# Advanced settings
# If you need to use pgBouncer, you need to disable prepared statements:
# PREPARED_STATEMENTS=false
2017-04-16 22:32:30 -04:00
# Cluster number setting for streaming API server.
# If you comment out following line, cluster number will be `numOfCpuCores - 1`.
STREAMING_CLUSTER_NUM=1
2017-05-20 14:01:05 -04:00
# Docker mastodon user
# If you use Docker, you may want to assign UID/GID manually.
# UID=1000
# GID=1000