2016-03-16 11:13:40 +00:00
# Service dependencies
2017-05-03 22:18:13 +01:00
# You may set REDIS_URL instead for more advanced options
2017-09-22 05:44:39 +01:00
# You may also set REDIS_NAMESPACE to share Redis between multiple Mastodon servers
2016-03-14 20:39:39 +00:00
REDIS_HOST=redis
2016-03-16 11:57:01 +00:00
REDIS_PORT=6379
2017-05-04 14:53:44 +01:00
# You may set DATABASE_URL instead for more advanced options
2016-03-16 11:57:01 +00:00
DB_HOST=db
DB_USER=postgres
DB_NAME=postgres
DB_PASS=
DB_PORT=5432
2018-02-09 22:04:47 +00:00
# Optional ElasticSearch configuration
# ES_ENABLED=true
# ES_HOST=localhost
# ES_PORT=9200
2016-03-16 11:13:40 +00:00
# Federation
2017-12-22 01:17:59 +00:00
# Note: Changing LOCAL_DOMAIN at a later time will cause unwanted side effects, including breaking all existing federation.
2017-05-19 19:55:15 +01:00
# LOCAL_DOMAIN should *NOT* contain the protocol part of the domain e.g https://example.com.
2018-02-04 04:42:13 +00:00
LOCAL_DOMAIN=example.com
2017-12-22 01:17:59 +00:00
# Changing LOCAL_HTTPS in production is no longer supported. (Mastodon will always serve https:// links)
2016-03-16 11:13:40 +00:00
2017-04-15 01:15:46 +01:00
# Use this only if you need to run mastodon on a different domain than the one used for federation.
2017-05-05 03:56:28 +01: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-15 01:15:46 +01:00
# WEB_DOMAIN=mastodon.example.com
2017-05-22 14:40:04 +01:00
# Use this if you want to have several aliases handler@example1.com
# handler@example2.com etc. for the same user. LOCAL_DOMAIN should not
# be added. Comma separated values
# ALTERNATE_DOMAINS=example1.com,example2.com
2016-03-16 11:13:40 +00:00
# Application secrets
2017-09-05 11:13:25 +01:00
# Generate each with the `RAILS_ENV=production bundle exec rake secret` task (`docker-compose run --rm web rake secret` if you use docker compose)
2016-03-14 20:39:39 +00:00
SECRET_KEY_BASE=
2017-01-29 12:06:58 +00:00
OTP_SECRET=
2016-03-16 11:13:40 +00:00
2017-07-13 21:15:32 +01:00
# VAPID keys (used for push notifications
# You can generate the keys using the following command (first is the private key, second is the public one)
# You should only generate this once per instance. If you later decide to change it, all push subscription will
# be invalidated, requiring the users to access the website again to resubscribe.
#
2017-09-05 11:13:25 +01:00
# 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)
2017-07-13 21:15:32 +01:00
#
# For more information visit https://rossta.net/blog/using-the-web-push-api-with-vapid.html
VAPID_PRIVATE_KEY=
VAPID_PUBLIC_KEY=
2016-12-06 16:19:26 +00: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 16:04:44 +01:00
# Only allow registrations with the following e-mail domains
# EMAIL_DOMAIN_WHITELIST=example1.com|example2.de|etc
2016-12-06 16:19:26 +00:00
2017-04-07 11:40:26 +01:00
# Optionally change default language
# DEFAULT_LOCALE=de
2016-03-16 11:13:40 +00:00
# E-mail configuration
2017-04-07 12:43:44 +01:00
# Note: Mailgun and SparkPost (https://sparkpo.st/smtp) each have good free tiers
2017-04-17 09:41:19 +01:00
# If you want to use an SMTP server without authentication (e.g local Postfix relay)
2018-02-04 04:42:13 +00:00
# then set SMTP_AUTH_METHOD and SMTP_OPENSSL_VERIFY_MODE to 'none' and
2017-05-08 02:34:11 +01:00
# *comment* SMTP_LOGIN and SMTP_PASSWORD (leaving them blank is not enough).
2016-03-16 11:13:40 +00:00
SMTP_SERVER=smtp.mailgun.org
SMTP_PORT=587
SMTP_LOGIN=
SMTP_PASSWORD=
SMTP_FROM_ADDRESS=notifications@example.com
2017-04-17 09:42:29 +01:00
#SMTP_DOMAIN= # defaults to LOCAL_DOMAIN
2017-04-13 18:51:49 +01:00
#SMTP_DELIVERY_METHOD=smtp # delivery method can also be sendmail
2017-04-10 20:48:30 +01:00
#SMTP_AUTH_METHOD=plain
2017-05-03 00:03:12 +01:00
#SMTP_CA_FILE=/etc/ssl/certs/ca-certificates.crt
2017-04-10 20:48:30 +01:00
#SMTP_OPENSSL_VERIFY_MODE=peer
#SMTP_ENABLE_STARTTLS_AUTO=true
2017-08-01 14:00:29 +01:00
#SMTP_TLS=true
2016-11-26 14:27:05 +00:00
2017-04-15 01:07:21 +01: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 14:27:05 +00:00
# Optional asset host for multi-server setups
2017-05-30 17:39:28 +01:00
# CDN_HOST=https://assets.example.com
2016-11-29 13:20:15 +00:00
# S3 (optional)
2016-12-06 16:19:26 +00:00
# S3_ENABLED=true
# S3_BUCKET=
# AWS_ACCESS_KEY_ID=
# AWS_SECRET_ACCESS_KEY=
# S3_REGION=
2017-03-23 07:44:55 +00:00
# S3_PROTOCOL=http
# S3_HOSTNAME=192.168.1.123:9000
2016-12-06 16:19:26 +00:00
2017-04-07 11:58:12 +01: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 13:18:50 +01:00
# S3_SIGNATURE_VERSION=
2017-04-07 11:58:12 +01:00
2017-09-06 11:13:00 +01:00
# Swift (optional)
# SWIFT_ENABLED=true
# SWIFT_USERNAME=
2017-09-11 14:11:13 +01:00
# For Keystone V3, the value for SWIFT_TENANT should be the project name
2017-09-06 11:13:00 +01:00
# SWIFT_TENANT=
# SWIFT_PASSWORD=
2017-09-11 14:11:13 +01:00
# Keystone V2 and V3 URLs are supported. Use a V3 URL if possible to avoid
# issues with token rate-limiting during high load.
2017-09-06 11:13:00 +01:00
# SWIFT_AUTH_URL=
# SWIFT_CONTAINER=
# SWIFT_OBJECT_URL=
2017-09-11 14:11:13 +01:00
# SWIFT_REGION=
# Defaults to 'default'
# SWIFT_DOMAIN_NAME=
# Defaults to 60 seconds. Set to 0 to disable
# SWIFT_CACHE_TTL=
2017-09-06 11:13:00 +01:00
2016-12-06 16:19:26 +00:00
# Optional alias for S3 if you want to use Cloudfront or Cloudflare in front
# S3_CLOUDFRONT_HOST=
2017-01-29 12:06:58 +00:00
2017-02-03 23:34:31 +00:00
# Streaming API integration
# STREAMING_API_BASE_URL=
2017-04-09 04:46:32 +01:00
# Advanced settings
# If you need to use pgBouncer, you need to disable prepared statements:
# PREPARED_STATEMENTS=false
2017-04-17 03:32:30 +01: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 19:01:05 +01:00
# Docker mastodon user
# If you use Docker, you may want to assign UID/GID manually.
# UID=1000
# GID=1000
2018-02-04 04:42:13 +00:00
2018-03-02 07:14:34 +00:00
# LDAP authentication (optional)
# LDAP_ENABLED=true
# LDAP_HOST=localhost
# LDAP_PORT=389
# LDAP_METHOD=simple_tls
# LDAP_BASE=
# LDAP_BIND_DN=
# LDAP_PASSWORD=
# LDAP_UID=cn
2018-02-04 14:05:53 +00:00
# PAM authentication (optional)
2018-02-22 22:41:21 +00:00
# PAM authentication uses for the email generation the "email" pam variable
# and optional as fallback PAM_DEFAULT_SUFFIX
# The pam environment variable "email" is provided by:
# https://github.com/devkral/pam_email_extractor
2018-02-04 14:05:53 +00:00
# PAM_ENABLED=true
2018-02-22 22:41:21 +00:00
# Fallback Suffix for email address generation (nil by default)
2018-02-04 14:05:53 +00:00
# PAM_DEFAULT_SUFFIX=pam
# Name of the pam service (pam "auth" section is evaluated)
# PAM_DEFAULT_SERVICE=rpam
2018-03-02 18:02:50 +00:00
# Name of the pam service used for checking if an user can register (pam "account" section is evaluated) (nil (disabled) by default)
2018-02-04 14:05:53 +00:00
# PAM_CONTROLLED_SERVICE=rpam
2018-02-23 00:16:17 +00:00
# Global OAuth settings (optional) :
# If you have only one strategy, you may want to enable this
# OAUTH_REDIRECT_AT_SIGN_IN=true
2018-02-04 04:42:13 +00:00
# Optional CAS authentication (cf. omniauth-cas) :
# CAS_ENABLED=true
# CAS_URL=https://sso.myserver.com/
# CAS_HOST=sso.myserver.com/
# CAS_PORT=443
# CAS_SSL=true
# CAS_VALIDATE_URL=
# CAS_CALLBACK_URL=
# CAS_LOGOUT_URL=
# CAS_LOGIN_URL=
# CAS_UID_FIELD='user'
# CAS_CA_PATH=
# CAS_DISABLE_SSL_VERIFICATION=false
# CAS_UID_KEY='user'
# CAS_NAME_KEY='name'
# CAS_EMAIL_KEY='email'
# CAS_NICKNAME_KEY='nickname'
# CAS_FIRST_NAME_KEY='firstname'
# CAS_LAST_NAME_KEY='lastname'
# CAS_LOCATION_KEY='location'
# CAS_IMAGE_KEY='image'
# CAS_PHONE_KEY='phone'
# Optional SAML authentication (cf. omniauth-saml)
# SAML_ENABLED=true
# SAML_ACS_URL=
2018-02-25 23:24:55 +00:00
# SAML_ISSUER=http://localhost:3000/auth/auth/saml/callback
2018-02-04 04:42:13 +00:00
# SAML_IDP_SSO_TARGET_URL=https://idp.testshib.org/idp/profile/SAML2/Redirect/SSO
# SAML_IDP_CERT=
# SAML_IDP_CERT_FINGERPRINT=
# SAML_NAME_IDENTIFIER_FORMAT=
# SAML_CERT=
# SAML_PRIVATE_KEY=
# SAML_SECURITY_WANT_ASSERTION_SIGNED=true
# SAML_SECURITY_WANT_ASSERTION_ENCRYPTED=true
2018-02-22 22:31:25 +00:00
# SAML_SECURITY_ASSUME_EMAIL_IS_VERIFIED=true
2018-02-04 04:42:13 +00:00
# SAML_ATTRIBUTES_STATEMENTS_UID="urn:oid:0.9.2342.19200300.100.1.1"
# SAML_ATTRIBUTES_STATEMENTS_EMAIL="urn:oid:1.3.6.1.4.1.5923.1.1.1.6"
# SAML_ATTRIBUTES_STATEMENTS_FULL_NAME="urn:oid:2.5.4.42"
# SAML_UID_ATTRIBUTE="urn:oid:0.9.2342.19200300.100.1.1"
2018-02-22 22:31:25 +00:00
# SAML_ATTRIBUTES_STATEMENTS_VERIFIED=
# SAML_ATTRIBUTES_STATEMENTS_VERIFIED_EMAIL=