2020-07-04 04:01:39 +09:00
# This is a sample configuration file. You can generate your configuration
2024-07-05 17:54:45 +09:00
# with the `bundle exec rails mastodon:setup` interactive setup wizard, but to customize
2020-07-04 04:01:39 +09:00
# your setup even further, you'll need to edit it manually. This sample does
# not demonstrate all available configuration options. Please look at
2020-07-13 05:11:31 +09:00
# https://docs.joinmastodon.org/admin/config/ for the full documentation.
2016-03-16 20:13:40 +09:00
2021-10-25 23:34:15 +09:00
# Note that this file accepts slightly different syntax depending on whether
# you are using `docker-compose` or not. In particular, if you use
# `docker-compose`, the value of each declared variable will be taken verbatim,
# including surrounding quotes.
# See: https://github.com/mastodon/mastodon/issues/16895
2016-03-16 20:13:40 +09:00
# Federation
2020-07-04 04:01:39 +09:00
# ----------
# This identifies your server and cannot be changed safely later
# ----------
2018-02-04 13:42:13 +09:00
LOCAL_DOMAIN=example.com
2017-12-22 10:17:59 +09:00
2017-04-15 09:15:46 +09:00
# Use this only if you need to run mastodon on a different domain than the one used for federation.
2022-11-01 17:38:05 +09:00
# You can read more about this option on https://docs.joinmastodon.org/admin/config/#web-domain
2017-05-05 11:56:28 +09:00
# DO *NOT* USE THIS UNLESS YOU KNOW *EXACTLY* WHAT YOU ARE DOING.
2017-04-15 09:15:46 +09:00
# WEB_DOMAIN=mastodon.example.com
2017-05-22 22:40:04 +09: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
2020-07-06 02:35:56 +09:00
# Use HTTP proxy for outgoing request (optional)
# http_proxy=http://gateway.local:8118
# Access control for hidden service.
# ALLOW_ACCESS_TO_HIDDEN_SERVICE=true
# Authorized fetch mode (optional)
# Require remote servers to authentify when fetching toots, see
# https://docs.joinmastodon.org/admin/config/#authorized_fetch
# AUTHORIZED_FETCH=true
# Limited federation mode (optional)
# Only allow federation with specific domains, see
# https://docs.joinmastodon.org/admin/config/#whitelist_mode
# LIMITED_FEDERATION_MODE=true
2020-07-04 04:01:39 +09:00
# Redis
# -----
REDIS_HOST=localhost
REDIS_PORT=6379
2020-07-06 02:35:56 +09:00
2020-07-04 04:01:39 +09:00
# PostgreSQL
# ----------
DB_HOST=/var/run/postgresql
DB_USER=mastodon
DB_NAME=mastodon_production
DB_PASS=
DB_PORT=5432
2020-07-06 02:35:56 +09:00
2021-11-26 16:30:02 +09:00
# Elasticsearch (optional)
2020-07-04 04:01:39 +09:00
# ------------------------
2020-07-06 02:35:56 +09:00
#ES_ENABLED=true
#ES_HOST=localhost
#ES_PORT=9200
2021-10-25 00:20:03 +09:00
# Authentication for ES (optional)
2021-10-26 03:28:51 +09:00
#ES_USER=elastic
#ES_PASS=password
2020-07-04 04:01:39 +09:00
# Secrets
# -------
2024-07-07 04:02:42 +09:00
# Generate each with the `RAILS_ENV=production bundle exec rails secret` task (`docker-compose run --rm web bundle exec rails secret` if you use docker compose)
2020-07-04 04:01:39 +09:00
# -------
2016-03-15 05:39:39 +09:00
SECRET_KEY_BASE=
2017-01-29 21:06:58 +09:00
OTP_SECRET=
2016-03-16 20:13:40 +09:00
2020-07-06 02:35:56 +09:00
2020-07-04 04:01:39 +09:00
# Web Push
# --------
2024-07-07 04:02:42 +09:00
# Generate with `bundle exec rails mastodon:webpush:generate_vapid_key` (first is the private key, second is the public one)
2017-07-14 05:15:32 +09:00
# 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.
2020-07-04 04:01:39 +09:00
# --------
2017-07-14 05:15:32 +09:00
VAPID_PRIVATE_KEY=
VAPID_PUBLIC_KEY=
2020-07-06 02:35:56 +09:00
2016-12-07 01:19:26 +09:00
# Registrations
2020-07-06 02:35:56 +09:00
# -------------
2016-12-07 01:19:26 +09:00
# Single user mode will disable registrations and redirect frontpage to the first profile
# SINGLE_USER_MODE=true
2020-07-06 02:35:56 +09:00
2016-12-07 01:19:26 +09:00
# Prevent registrations with following e-mail domains
2020-07-01 06:20:21 +09:00
# EMAIL_DOMAIN_DENYLIST=example1.com|example2.de|etc
2020-07-06 02:35:56 +09:00
2017-04-05 00:04:44 +09:00
# Only allow registrations with the following e-mail domains
2020-07-01 06:20:21 +09:00
# EMAIL_DOMAIN_ALLOWLIST=example1.com|example2.de|etc
2016-12-07 01:19:26 +09:00
2020-07-06 02:35:56 +09:00
#TODO move this
2017-04-07 19:40:26 +09:00
# Optionally change default language
# DEFAULT_LOCALE=de
2020-07-06 02:35:56 +09:00
2020-07-04 04:01:39 +09:00
# Sending mail
# ------------
2022-12-16 02:42:08 +09:00
SMTP_SERVER=
2016-03-16 20:13:40 +09:00
SMTP_PORT=587
SMTP_LOGIN=
SMTP_PASSWORD=
2022-03-07 06:51:40 +09:00
SMTP_FROM_ADDRESS=notifications@example.com
2016-11-29 22:20:15 +09:00
2020-02-06 19:25:18 +09:00
2020-07-04 04:01:39 +09:00
# File storage (optional)
# -----------------------
2018-05-29 07:43:47 +09:00
# The attachment host must allow cross origin request from WEB_DOMAIN or
# LOCAL_DOMAIN if WEB_DOMAIN is not set. For example, the server may have the
# following header field:
# Access-Control-Allow-Origin: https://192.168.1.123:9000/
2020-07-06 02:35:56 +09:00
# -----------------------
#S3_ENABLED=true
#S3_BUCKET=files.example.com
#AWS_ACCESS_KEY_ID=
#AWS_SECRET_ACCESS_KEY=
#S3_ALIAS_HOST=files.example.com
2019-09-23 22:37:45 +09:00
2017-09-06 19:13:00 +09:00
# Swift (optional)
2018-05-29 07:43:47 +09:00
# The attachment host must allow cross origin request - see the description
# above.
2017-09-06 19:13:00 +09:00
# SWIFT_ENABLED=true
# SWIFT_USERNAME=
2017-09-11 22:11:13 +09:00
# For Keystone V3, the value for SWIFT_TENANT should be the project name
2017-09-06 19:13:00 +09:00
# SWIFT_TENANT=
# SWIFT_PASSWORD=
2018-05-07 09:28:28 +09:00
# Some OpenStack V3 providers require PROJECT_ID (optional)
# SWIFT_PROJECT_ID=
2017-09-11 22:11:13 +09: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 19:13:00 +09:00
# SWIFT_AUTH_URL=
# SWIFT_CONTAINER=
# SWIFT_OBJECT_URL=
2017-09-11 22:11:13 +09:00
# SWIFT_REGION=
# Defaults to 'default'
# SWIFT_DOMAIN_NAME=
# Defaults to 60 seconds. Set to 0 to disable
# SWIFT_CACHE_TTL=
2017-09-06 19:13:00 +09:00
2020-07-06 02:35:56 +09:00
# Optional asset host for multi-server setups
# The asset host must allow cross origin request from WEB_DOMAIN or LOCAL_DOMAIN
# if WEB_DOMAIN is not set. For example, the server may have the
# following header field:
# Access-Control-Allow-Origin: https://example.com/
# CDN_HOST=https://assets.example.com
# Optional list of hosts that are allowed to serve media for your instance
# This is useful if you include external media in your custom CSS or about page,
# or if your data storage provider makes use of redirects to other domains.
# EXTRA_DATA_HOSTS=https://data.example1.com|https://data.example2.com
2018-08-25 20:27:08 +09:00
# Optional alias for S3 (e.g. to serve files on a custom domain, possibly using Cloudfront or Cloudflare)
# S3_ALIAS_HOST=
2017-01-29 21:06:58 +09:00
2017-02-04 08:34:31 +09:00
# Streaming API integration
# STREAMING_API_BASE_URL=
2017-04-09 12:46:32 +09:00
2019-06-02 21:50:51 +09:00
2020-07-06 02:35:56 +09:00
# External authentication (optional)
# ----------------------------------
2018-03-02 16:14:34 +09: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
2019-12-02 02:52:21 +09:00
# LDAP_MAIL=mail
# LDAP_SEARCH_FILTER=(|(%{uid}=%{email})(%{mail}=%{email}))
2019-12-01 15:21:28 +09:00
# LDAP_UID_CONVERSION_ENABLED=true
# LDAP_UID_CONVERSION_SEARCH=., -
# LDAP_UID_CONVERSION_REPLACE=_
2018-03-02 16:14:34 +09:00
2018-02-04 23:05:53 +09:00
# PAM authentication (optional)
2018-02-23 07:41:21 +09: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 23:05:53 +09:00
# PAM_ENABLED=true
2018-03-20 04:09:26 +09:00
# Fallback email domain for email address generation (LOCAL_DOMAIN by default)
# PAM_EMAIL_DOMAIN=example.com
2018-02-04 23:05:53 +09:00
# Name of the pam service (pam "auth" section is evaluated)
# PAM_DEFAULT_SERVICE=rpam
2018-03-03 03:02:50 +09: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 23:05:53 +09:00
# PAM_CONTROLLED_SERVICE=rpam
2018-02-23 09:16:17 +09: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 13:42:13 +09: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
2019-12-24 02:12:22 +09:00
# SAML_ACS_URL=http://localhost:3000/auth/auth/saml/callback
# SAML_ISSUER=https://example.com
2018-02-04 13:42:13 +09: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-23 07:31:25 +09:00
# SAML_SECURITY_ASSUME_EMAIL_IS_VERIFIED=true
2018-02-04 13:42:13 +09: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"
2018-03-07 14:19:10 +09:00
# SAML_ATTRIBUTES_STATEMENTS_FULL_NAME="urn:oid:2.16.840.1.113730.3.1.241"
# SAML_ATTRIBUTES_STATEMENTS_FIRST_NAME="urn:oid:2.5.4.42"
# SAML_ATTRIBUTES_STATEMENTS_LAST_NAME="urn:oid:2.5.4.4"
2018-02-04 13:42:13 +09:00
# SAML_UID_ATTRIBUTE="urn:oid:0.9.2342.19200300.100.1.1"
2018-02-23 07:31:25 +09:00
# SAML_ATTRIBUTES_STATEMENTS_VERIFIED=
# SAML_ATTRIBUTES_STATEMENTS_VERIFIED_EMAIL=
2018-04-25 09:14:49 +09:00
2020-01-23 08:43:54 +09:00
2020-07-06 02:35:56 +09:00
# Custom settings
# ---------------
# Various ways to customize Mastodon's behavior
# ---------------
2022-11-01 17:38:05 +09:00
2020-07-06 02:35:56 +09:00
# Maximum allowed character count
MAX_TOOT_CHARS=500
2020-01-23 08:43:54 +09:00
2024-02-07 04:23:36 +09:00
# Maximum allowed hashtags to follow in a feed column
# Note that setting this value higher may cause significant
# database load
MAX_FEED_HASHTAGS=4
2020-07-06 02:35:56 +09:00
# Maximum number of pinned posts
MAX_PINNED_TOOTS=5
# Maximum allowed bio characters
MAX_BIO_CHARS=500
# Maximim number of profile fields allowed
MAX_PROFILE_FIELDS=4
# Maximum allowed display name characters
MAX_DISPLAY_NAME_CHARS=30
2021-01-24 03:15:27 +09:00
# Maximum allowed poll options
MAX_POLL_OPTIONS=5
# Maximum allowed poll option characters
MAX_POLL_OPTION_CHARS=100
2023-11-08 09:43:47 +09:00
# Maximum number of emoji reactions per toot and user (minimum 1)
MAX_REACTIONS=1
2020-07-06 02:35:56 +09:00
# Maximum image and video/audio upload sizes
# Units are in bytes
# 1048576 bytes equals 1 megabyte
# MAX_IMAGE_SIZE=8388608
# MAX_VIDEO_SIZE=41943040
# Maximum search results to display
# Only relevant when elasticsearch is installed
# MAX_SEARCH_RESULTS=20
2021-04-25 19:02:41 +09:00
2022-11-02 17:20:47 +09:00
# Maximum hashtags to display
# Customize the number of hashtags shown in 'Explore'
# MAX_TRENDING_TAGS=10
2021-04-25 19:02:41 +09:00
# Maximum custom emoji file sizes
# If undefined or smaller than MAX_EMOJI_SIZE, the value
# of MAX_EMOJI_SIZE will be used for MAX_REMOTE_EMOJI_SIZE
# Units are in bytes
2022-07-18 05:58:41 +09:00
# MAX_EMOJI_SIZE=262144
# MAX_REMOTE_EMOJI_SIZE=262144
2022-01-25 03:06:19 +09:00
# Optional hCaptcha support
# HCAPTCHA_SECRET_KEY=
# HCAPTCHA_SITE_KEY=
2022-07-07 10:14:28 +09:00
# IP and session retention
# -----------------------
# Make sure to modify the scheduling of ip_cleanup_scheduler in config/sidekiq.yml
# to be less than daily if you lower IP_RETENTION_PERIOD below two days (172800).
# -----------------------
IP_RETENTION_PERIOD=31556952
SESSION_RETENTION_PERIOD=31556952