You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
 
 
 
 
 
 

272 lines
8.2 KiB

  1. # This is a sample configuration file. You can generate your configuration
  2. # with the `rake mastodon:setup` interactive setup wizard, but to customize
  3. # your setup even further, you'll need to edit it manually. This sample does
  4. # not demonstrate all available configuration options. Please look at
  5. # https://docs.joinmastodon.org/admin/config/ for the full documentation.
  6. # Federation
  7. # ----------
  8. # This identifies your server and cannot be changed safely later
  9. # ----------
  10. LOCAL_DOMAIN=example.com
  11. # Use this only if you need to run mastodon on a different domain than the one used for federation.
  12. # You can read more about this option on https://github.com/tootsuite/documentation/blob/master/Running-Mastodon/Serving_a_different_domain.md
  13. # DO *NOT* USE THIS UNLESS YOU KNOW *EXACTLY* WHAT YOU ARE DOING.
  14. # WEB_DOMAIN=mastodon.example.com
  15. # Use this if you want to have several aliases handler@example1.com
  16. # handler@example2.com etc. for the same user. LOCAL_DOMAIN should not
  17. # be added. Comma separated values
  18. # ALTERNATE_DOMAINS=example1.com,example2.com
  19. # Use HTTP proxy for outgoing request (optional)
  20. # http_proxy=http://gateway.local:8118
  21. # Access control for hidden service.
  22. # ALLOW_ACCESS_TO_HIDDEN_SERVICE=true
  23. # Authorized fetch mode (optional)
  24. # Require remote servers to authentify when fetching toots, see
  25. # https://docs.joinmastodon.org/admin/config/#authorized_fetch
  26. # AUTHORIZED_FETCH=true
  27. # Limited federation mode (optional)
  28. # Only allow federation with specific domains, see
  29. # https://docs.joinmastodon.org/admin/config/#whitelist_mode
  30. # LIMITED_FEDERATION_MODE=true
  31. # Redis
  32. # -----
  33. REDIS_HOST=localhost
  34. REDIS_PORT=6379
  35. # PostgreSQL
  36. # ----------
  37. DB_HOST=/var/run/postgresql
  38. DB_USER=mastodon
  39. DB_NAME=mastodon_production
  40. DB_PASS=
  41. DB_PORT=5432
  42. # ElasticSearch (optional)
  43. # ------------------------
  44. #ES_ENABLED=true
  45. #ES_HOST=localhost
  46. #ES_PORT=9200
  47. # Secrets
  48. # -------
  49. # Generate each with the `RAILS_ENV=production bundle exec rake secret` task (`docker-compose run --rm web bundle exec rake secret` if you use docker compose)
  50. # -------
  51. SECRET_KEY_BASE=
  52. OTP_SECRET=
  53. # Web Push
  54. # --------
  55. # Generate with `rake mastodon:webpush:generate_vapid_key` (first is the private key, second is the public one)
  56. # You should only generate this once per instance. If you later decide to change it, all push subscription will
  57. # be invalidated, requiring the users to access the website again to resubscribe.
  58. # --------
  59. VAPID_PRIVATE_KEY=
  60. VAPID_PUBLIC_KEY=
  61. # Registrations
  62. # -------------
  63. # Single user mode will disable registrations and redirect frontpage to the first profile
  64. # SINGLE_USER_MODE=true
  65. # Prevent registrations with following e-mail domains
  66. # EMAIL_DOMAIN_DENYLIST=example1.com|example2.de|etc
  67. # Only allow registrations with the following e-mail domains
  68. # EMAIL_DOMAIN_ALLOWLIST=example1.com|example2.de|etc
  69. #TODO move this
  70. # Optionally change default language
  71. # DEFAULT_LOCALE=de
  72. # Sending mail
  73. # ------------
  74. SMTP_SERVER=smtp.mailgun.org
  75. SMTP_PORT=587
  76. SMTP_LOGIN=
  77. SMTP_PASSWORD=
  78. SMTP_FROM_ADDRESS=notificatons@example.com
  79. # File storage (optional)
  80. # -----------------------
  81. # The attachment host must allow cross origin request from WEB_DOMAIN or
  82. # LOCAL_DOMAIN if WEB_DOMAIN is not set. For example, the server may have the
  83. # following header field:
  84. # Access-Control-Allow-Origin: https://192.168.1.123:9000/
  85. # -----------------------
  86. #S3_ENABLED=true
  87. #S3_BUCKET=files.example.com
  88. #AWS_ACCESS_KEY_ID=
  89. #AWS_SECRET_ACCESS_KEY=
  90. #S3_ALIAS_HOST=files.example.com
  91. # Swift (optional)
  92. # The attachment host must allow cross origin request - see the description
  93. # above.
  94. # SWIFT_ENABLED=true
  95. # SWIFT_USERNAME=
  96. # For Keystone V3, the value for SWIFT_TENANT should be the project name
  97. # SWIFT_TENANT=
  98. # SWIFT_PASSWORD=
  99. # Some OpenStack V3 providers require PROJECT_ID (optional)
  100. # SWIFT_PROJECT_ID=
  101. # Keystone V2 and V3 URLs are supported. Use a V3 URL if possible to avoid
  102. # issues with token rate-limiting during high load.
  103. # SWIFT_AUTH_URL=
  104. # SWIFT_CONTAINER=
  105. # SWIFT_OBJECT_URL=
  106. # SWIFT_REGION=
  107. # Defaults to 'default'
  108. # SWIFT_DOMAIN_NAME=
  109. # Defaults to 60 seconds. Set to 0 to disable
  110. # SWIFT_CACHE_TTL=
  111. # Optional asset host for multi-server setups
  112. # The asset host must allow cross origin request from WEB_DOMAIN or LOCAL_DOMAIN
  113. # if WEB_DOMAIN is not set. For example, the server may have the
  114. # following header field:
  115. # Access-Control-Allow-Origin: https://example.com/
  116. # CDN_HOST=https://assets.example.com
  117. # Optional list of hosts that are allowed to serve media for your instance
  118. # This is useful if you include external media in your custom CSS or about page,
  119. # or if your data storage provider makes use of redirects to other domains.
  120. # EXTRA_DATA_HOSTS=https://data.example1.com|https://data.example2.com
  121. # Optional alias for S3 (e.g. to serve files on a custom domain, possibly using Cloudfront or Cloudflare)
  122. # S3_ALIAS_HOST=
  123. # Streaming API integration
  124. # STREAMING_API_BASE_URL=
  125. # External authentication (optional)
  126. # ----------------------------------
  127. # LDAP authentication (optional)
  128. # LDAP_ENABLED=true
  129. # LDAP_HOST=localhost
  130. # LDAP_PORT=389
  131. # LDAP_METHOD=simple_tls
  132. # LDAP_BASE=
  133. # LDAP_BIND_DN=
  134. # LDAP_PASSWORD=
  135. # LDAP_UID=cn
  136. # LDAP_MAIL=mail
  137. # LDAP_SEARCH_FILTER=(|(%{uid}=%{email})(%{mail}=%{email}))
  138. # LDAP_UID_CONVERSION_ENABLED=true
  139. # LDAP_UID_CONVERSION_SEARCH=., -
  140. # LDAP_UID_CONVERSION_REPLACE=_
  141. # PAM authentication (optional)
  142. # PAM authentication uses for the email generation the "email" pam variable
  143. # and optional as fallback PAM_DEFAULT_SUFFIX
  144. # The pam environment variable "email" is provided by:
  145. # https://github.com/devkral/pam_email_extractor
  146. # PAM_ENABLED=true
  147. # Fallback email domain for email address generation (LOCAL_DOMAIN by default)
  148. # PAM_EMAIL_DOMAIN=example.com
  149. # Name of the pam service (pam "auth" section is evaluated)
  150. # PAM_DEFAULT_SERVICE=rpam
  151. # Name of the pam service used for checking if an user can register (pam "account" section is evaluated) (nil (disabled) by default)
  152. # PAM_CONTROLLED_SERVICE=rpam
  153. # Global OAuth settings (optional) :
  154. # If you have only one strategy, you may want to enable this
  155. # OAUTH_REDIRECT_AT_SIGN_IN=true
  156. # Optional CAS authentication (cf. omniauth-cas) :
  157. # CAS_ENABLED=true
  158. # CAS_URL=https://sso.myserver.com/
  159. # CAS_HOST=sso.myserver.com/
  160. # CAS_PORT=443
  161. # CAS_SSL=true
  162. # CAS_VALIDATE_URL=
  163. # CAS_CALLBACK_URL=
  164. # CAS_LOGOUT_URL=
  165. # CAS_LOGIN_URL=
  166. # CAS_UID_FIELD='user'
  167. # CAS_CA_PATH=
  168. # CAS_DISABLE_SSL_VERIFICATION=false
  169. # CAS_UID_KEY='user'
  170. # CAS_NAME_KEY='name'
  171. # CAS_EMAIL_KEY='email'
  172. # CAS_NICKNAME_KEY='nickname'
  173. # CAS_FIRST_NAME_KEY='firstname'
  174. # CAS_LAST_NAME_KEY='lastname'
  175. # CAS_LOCATION_KEY='location'
  176. # CAS_IMAGE_KEY='image'
  177. # CAS_PHONE_KEY='phone'
  178. # Optional SAML authentication (cf. omniauth-saml)
  179. # SAML_ENABLED=true
  180. # SAML_ACS_URL=http://localhost:3000/auth/auth/saml/callback
  181. # SAML_ISSUER=https://example.com
  182. # SAML_IDP_SSO_TARGET_URL=https://idp.testshib.org/idp/profile/SAML2/Redirect/SSO
  183. # SAML_IDP_CERT=
  184. # SAML_IDP_CERT_FINGERPRINT=
  185. # SAML_NAME_IDENTIFIER_FORMAT=
  186. # SAML_CERT=
  187. # SAML_PRIVATE_KEY=
  188. # SAML_SECURITY_WANT_ASSERTION_SIGNED=true
  189. # SAML_SECURITY_WANT_ASSERTION_ENCRYPTED=true
  190. # SAML_SECURITY_ASSUME_EMAIL_IS_VERIFIED=true
  191. # SAML_ATTRIBUTES_STATEMENTS_UID="urn:oid:0.9.2342.19200300.100.1.1"
  192. # SAML_ATTRIBUTES_STATEMENTS_EMAIL="urn:oid:1.3.6.1.4.1.5923.1.1.1.6"
  193. # SAML_ATTRIBUTES_STATEMENTS_FULL_NAME="urn:oid:2.16.840.1.113730.3.1.241"
  194. # SAML_ATTRIBUTES_STATEMENTS_FIRST_NAME="urn:oid:2.5.4.42"
  195. # SAML_ATTRIBUTES_STATEMENTS_LAST_NAME="urn:oid:2.5.4.4"
  196. # SAML_UID_ATTRIBUTE="urn:oid:0.9.2342.19200300.100.1.1"
  197. # SAML_ATTRIBUTES_STATEMENTS_VERIFIED=
  198. # SAML_ATTRIBUTES_STATEMENTS_VERIFIED_EMAIL=
  199. # Custom settings
  200. # ---------------
  201. # Various ways to customize Mastodon's behavior
  202. # ---------------
  203. # Maximum allowed character count
  204. MAX_TOOT_CHARS=500
  205. # Maximum number of pinned posts
  206. MAX_PINNED_TOOTS=5
  207. # Maximum allowed bio characters
  208. MAX_BIO_CHARS=500
  209. # Maximim number of profile fields allowed
  210. MAX_PROFILE_FIELDS=4
  211. # Maximum allowed display name characters
  212. MAX_DISPLAY_NAME_CHARS=30
  213. # Maximum allowed poll options
  214. MAX_POLL_OPTIONS=5
  215. # Maximum allowed poll option characters
  216. MAX_POLL_OPTION_CHARS=100
  217. # Maximum image and video/audio upload sizes
  218. # Units are in bytes
  219. # 1048576 bytes equals 1 megabyte
  220. # MAX_IMAGE_SIZE=8388608
  221. # MAX_VIDEO_SIZE=41943040
  222. # Maximum search results to display
  223. # Only relevant when elasticsearch is installed
  224. # MAX_SEARCH_RESULTS=20