3 This file describe the configuration, it is recommended to edit the relevant *.secret.exs file instead of the others founds in the ``config`` directory.
4 If you run Pleroma with ``MIX_ENV=prod`` the file is ``prod.secret.exs``, otherwise it is ``dev.secret.exs``.
7 * `uploader`: Select which `Pleroma.Uploaders` to use
8 * `filters`: List of `Pleroma.Upload.Filter` to use.
9 * `link_name`: When enabled Pleroma will add a `name` parameter to the url of the upload, for example `https://instance.tld/media/corndog.png?name=corndog.png`. This is needed to provide the correct filename in Content-Disposition headers when using filters like `Pleroma.Upload.Filter.Dedupe`
10 * `base_url`: The base URL to access a user-uploaded file. Useful when you want to proxy the media files via another host.
11 * `proxy_remote`: If you\'re using a remote uploader, Pleroma will proxy media requests instead of redirecting to it.
12 * `proxy_opts`: Proxy options, see `Pleroma.ReverseProxy` documentation.
14 Note: `strip_exif` has been replaced by `Pleroma.Upload.Filter.Mogrify`.
16 ## Pleroma.Uploaders.Local
17 * `uploads`: Which directory to store the user-uploads in, relative to pleroma’s working directory
19 ## Pleroma.Upload.Filter.Mogrify
21 * `args`: List of actions for the `mogrify` command like `"strip"` or `["strip", "auto-orient", {"impode", "1"}]`.
23 ## Pleroma.Upload.Filter.Dedupe
25 No specific configuration.
27 ## Pleroma.Upload.Filter.AnonymizeFilename
29 This filter replaces the filename (not the path) of an upload. For complete obfuscation, add
30 `Pleroma.Upload.Filter.Dedupe` before AnonymizeFilename.
32 * `text`: Text to replace filenames in links. If empty, `{random}.extension` will be used.
35 * `adapter`: one of the mail adapters listed in [Swoosh readme](https://github.com/swoosh/swoosh#adapters), or `Swoosh.Adapters.Local` for in-memory mailbox.
36 * `api_key` / `password` and / or other adapter-specific settings, per the above documentation.
38 An example for Sendgrid adapter:
41 config :pleroma, Pleroma.Mailer,
42 adapter: Swoosh.Adapters.Sendgrid,
43 api_key: "YOUR_API_KEY"
46 An example for SMTP adapter:
49 config :pleroma, Pleroma.Mailer,
50 adapter: Swoosh.Adapters.SMTP,
51 relay: "smtp.gmail.com",
52 username: "YOUR_USERNAME@gmail.com",
53 password: "YOUR_SMTP_PASSWORD",
61 * `valid_schemes`: List of the scheme part that is considered valid to be an URL
64 * `name`: The instance’s name
65 * `email`: Email used to reach an Administrator/Moderator of the instance
66 * `notify_email`: Email used for notifications.
67 * `description`: The instance’s description, can be seen in nodeinfo and ``/api/v1/instance``
68 * `limit`: Posts character limit (CW/Subject included in the counter)
69 * `remote_limit`: Hard character limit beyond which remote posts will be dropped.
70 * `upload_limit`: File size limit of uploads (except for avatar, background, banner)
71 * `avatar_upload_limit`: File size limit of user’s profile avatars
72 * `background_upload_limit`: File size limit of user’s profile backgrounds
73 * `banner_upload_limit`: File size limit of user’s profile banners
74 * `registrations_open`: Enable registrations for anyone, invitations can be enabled when false.
75 * `invites_enabled`: Enable user invitations for admins (depends on `registrations_open: false`).
76 * `account_activation_required`: Require users to confirm their emails before signing in.
77 * `federating`: Enable federation with other instances
78 * `federation_reachability_timeout_days`: Timeout (in days) of each external federation target being unreachable prior to pausing federating to it.
79 * `allow_relay`: Enable Pleroma’s Relay, which makes it possible to follow a whole instance
80 * `rewrite_policy`: Message Rewrite Policy, either one or a list. Here are the ones available by default:
81 * `Pleroma.Web.ActivityPub.MRF.NoOpPolicy`: Doesn’t modify activities (default)
82 * `Pleroma.Web.ActivityPub.MRF.DropPolicy`: Drops all activities. It generally doesn’t makes sense to use in production
83 * `Pleroma.Web.ActivityPub.MRF.SimplePolicy`: Restrict the visibility of activities from certains instances (See ``:mrf_simple`` section)
84 * `Pleroma.Web.ActivityPub.MRF.RejectNonPublic`: Drops posts with non-public visibility settings (See ``:mrf_rejectnonpublic`` section)
85 * `Pleroma.Web.ActivityPub.MRF.EnsureRePrepended`: Rewrites posts to ensure that replies to posts with subjects do not have an identical subject and instead begin with re:.
86 * `public`: Makes the client API in authentificated mode-only except for user-profiles. Useful for disabling the Local Timeline and The Whole Known Network.
87 * `quarantined_instances`: List of ActivityPub instances where private(DMs, followers-only) activities will not be send.
88 * `managed_config`: Whenether the config for pleroma-fe is configured in this config or in ``static/config.json``
89 * `allowed_post_formats`: MIME-type list of formats allowed to be posted (transformed into HTML)
90 * `finmoji_enabled`: Whenether to enable the finmojis in the custom emojis.
91 * `mrf_transparency`: Make the content of your Message Rewrite Facility settings public (via nodeinfo).
92 * `scope_copy`: Copy the scope (private/unlisted/public) in replies to posts by default.
93 * `subject_line_behavior`: Allows changing the default behaviour of subject lines in replies. Valid values:
94 * "email": Copy and preprend re:, as in email.
95 * "masto": Copy verbatim, as in Mastodon.
96 * "noop": Don't copy the subject.
97 * `always_show_subject_input`: When set to false, auto-hide the subject field when it's empty.
98 * `extended_nickname_format`: Set to `true` to use extended local nicknames format (allows underscores/dashes). This will break federation with
99 older software for theses nicknames.
100 * `max_pinned_statuses`: The maximum number of pinned statuses. `0` will disable the feature.
101 * `autofollowed_nicknames`: Set to nicknames of (local) users that every new user should automatically follow.
102 * `no_attachment_links`: Set to true to disable automatically adding attachment link text to statuses
103 * `welcome_message`: A message that will be send to a newly registered users as a direct message.
104 * `welcome_user_nickname`: The nickname of the local user that sends the welcome message.
105 * `max_report_comment_size`: The maximum size of the report comment (Default: `1000`)
106 * `safe_dm_mentions`: If set to true, only mentions at the beginning of a post will be used to address people in direct messages. This is to prevent accidental mentioning of people when talking about them (e.g. "@friend hey i really don't like @enemy"). (Default: `false`)
109 * `backends`: `:console` is used to send logs to stdout, `{ExSyslogger, :ex_syslogger}` to log to syslog, and `Quack.Logger` to log to Slack
111 An example to enable ONLY ExSyslogger (f/ex in ``prod.secret.exs``) with info and debug suppressed:
114 backends: [{ExSyslogger, :ex_syslogger}]
116 config :logger, :ex_syslogger,
120 Another example, keeping console output and adding the pid to syslog output:
123 backends: [:console, {ExSyslogger, :ex_syslogger}]
125 config :logger, :ex_syslogger,
127 option: [:pid, :ndelay]
130 See: [logger’s documentation](https://hexdocs.pm/logger/Logger.html) and [ex_syslogger’s documentation](https://hexdocs.pm/ex_syslogger/)
132 An example of logging info to local syslog, but warn to a Slack channel:
135 backends: [ {ExSyslogger, :ex_syslogger}, Quack.Logger ],
138 config :logger, :ex_syslogger,
141 format: "$metadata[$level] $message"
146 webhook_url: "https://hooks.slack.com/services/YOUR-API-KEY-HERE"
149 See the [Quack Github](https://github.com/azohra/quack) for more details
151 ## :frontend_configurations
153 This can be used to configure a keyword list that keeps the configuration data for any kind of frontend. By default, settings for `pleroma_fe` and `masto_fe` are configured.
155 Frontends can access these settings at `/api/pleroma/frontend_configurations`
157 To add your own configuration for PleromaFE, use it like this:
159 `config :pleroma, :frontend_configurations, pleroma_fe: %{redirectRootNoLogin: "/main/all", ...}`
161 These settings need to be complete, they will override the defaults. See `priv/static/static/config.json` for the available keys.
164 __THIS IS DEPRECATED__
166 If you are using this method, please change it to the `frontend_configurations` method. Please set this option to false in your config like this: `config :pleroma, :fe, false`.
168 This section is used to configure Pleroma-FE, unless ``:managed_config`` in ``:instance`` is set to false.
170 * `theme`: Which theme to use, they are defined in ``styles.json``
171 * `logo`: URL of the logo, defaults to Pleroma’s logo
172 * `logo_mask`: Whether to use only the logo's shape as a mask (true) or as a regular image (false)
173 * `logo_margin`: What margin to use around the logo
174 * `background`: URL of the background, unless viewing a user profile with a background that is set
175 * `redirect_root_no_login`: relative URL which indicates where to redirect when a user isn’t logged in.
176 * `redirect_root_login`: relative URL which indicates where to redirect when a user is logged in.
177 * `show_instance_panel`: Whenether to show the instance’s specific panel.
178 * `scope_options_enabled`: Enable setting an notice visibility and subject/CW when posting
179 * `formatting_options_enabled`: Enable setting a formatting different than plain-text (ie. HTML, Markdown) when posting, relates to ``:instance, allowed_post_formats``
180 * `collapse_message_with_subjects`: When a message has a subject(aka Content Warning), collapse it by default
181 * `hide_post_stats`: Hide notices statistics(repeats, favorites, …)
182 * `hide_user_stats`: Hide profile statistics(posts, posts per day, followers, followings, …)
185 * `media_removal`: List of instances to remove medias from
186 * `media_nsfw`: List of instances to put medias as NSFW(sensitive) from
187 * `federated_timeline_removal`: List of instances to remove from Federated (aka The Whole Known Network) Timeline
188 * `reject`: List of instances to reject any activities from
189 * `accept`: List of instances to accept any activities from
191 ## :mrf_rejectnonpublic
192 * `allow_followersonly`: whether to allow followers-only posts
193 * `allow_direct`: whether to allow direct messages
196 * `delist_threshold`: Number of mentioned users after which the message gets delisted (the message can still be seen, but it will not show up in public timelines and mentioned users won't get notifications about it). Set to 0 to disable.
197 * `reject_threshold`: Number of mentioned users after which the messaged gets rejected. Set to 0 to disable.
200 * `reject`: A list of patterns which result in message being rejected, each pattern can be a string or a [regular expression](https://hexdocs.pm/elixir/Regex.html)
201 * `federated_timeline_removal`: A list of patterns which result in message being removed from federated timelines (a.k.a unlisted), each pattern can be a string or a [regular expression](https://hexdocs.pm/elixir/Regex.html)
202 * `replace`: A list of tuples containing `{pattern, replacement}`, `pattern` can be a string or a [regular expression](https://hexdocs.pm/elixir/Regex.html)
205 * `enabled`: Enables proxying of remote media to the instance’s proxy
206 * `base_url`: The base URL to access a user-uploaded file. Useful when you want to proxy the media files via another host/CDN fronts.
207 * `proxy_opts`: All options defined in `Pleroma.ReverseProxy` documentation, defaults to `[max_body_length: (25*1_048_576)]`.
210 * `enabled`: Enables the gopher interface
211 * `ip`: IP address to bind to
212 * `port`: Port to bind to
213 * `dstport`: Port advertised in urls (optional, defaults to `port`)
215 ## Pleroma.Web.Endpoint
216 `Phoenix` endpoint configuration, all configuration options can be viewed [here](https://hexdocs.pm/phoenix/Phoenix.Endpoint.html#module-dynamic-configuration), only common options are listed here
217 * `http` - a list containing http protocol configuration, all configuration options can be viewed [here](https://hexdocs.pm/plug_cowboy/Plug.Cowboy.html#module-options), only common options are listed here
218 - `ip` - a tuple consisting of 4 integers
220 * `url` - a list containing the configuration for generating urls, accepts
221 - `host` - the host without the scheme and a post (e.g `example.com`, not `https://example.com:2020`)
222 - `scheme` - e.g `http`, `https`
227 **Important note**: if you modify anything inside these lists, default `config.exs` values will be overwritten, which may result in breakage, to make sure this does not happen please copy the default value for the list from `config.exs` and modify/add only what you need
231 config :pleroma, Pleroma.Web.Endpoint,
232 url: [host: "example.com", port: 2020, scheme: "https"],
234 # start copied from config.exs
238 {"/api/v1/streaming", Pleroma.Web.MastodonAPI.WebsocketHandler, []},
239 {"/websocket", Phoenix.Endpoint.CowboyWebSocket,
240 {Phoenix.Transports.WebSocket,
241 {Pleroma.Web.Endpoint, Pleroma.Web.UserSocket, websocket_config}}},
242 {:_, Phoenix.Endpoint.Cowboy2Handler, {Pleroma.Web.Endpoint, []}}
244 # end copied from config.exs
251 This will make Pleroma listen on `127.0.0.1` port `8080` and generate urls starting with `https://example.com:2020`
254 * ``accept_blocks``: Whether to accept incoming block activities from other instances
255 * ``unfollow_blocked``: Whether blocks result in people getting unfollowed
256 * ``outgoing_blocks``: Whether to federate blocks to other instances
257 * ``deny_follow_blocked``: Whether to disallow following an account that has blocked the user in question
260 * ``enabled``: Whether the managed content security policy is enabled
261 * ``sts``: Whether to additionally send a `Strict-Transport-Security` header
262 * ``sts_max_age``: The maximum age for the `Strict-Transport-Security` header if sent
263 * ``ct_max_age``: The maximum age for the `Expect-CT` header if sent
264 * ``referrer_policy``: The referrer policy to use, either `"same-origin"` or `"no-referrer"`.
266 ## :mrf_user_allowlist
268 The keys in this section are the domain names that the policy should apply to.
269 Each key should be assigned a list of users that should be allowed through by
270 their ActivityPub ID.
275 config :pleroma, :mrf_user_allowlist,
276 "example.org": ["https://example.org/users/admin"]
279 ## :web_push_encryption, :vapid_details
281 Web Push Notifications configuration. You can use the mix task `mix web_push.gen.keypair` to generate it.
283 * ``subject``: a mailto link for the administrative contact. It’s best if this email is not a personal email address, but rather a group email so that if a person leaves an organization, is unavailable for an extended period, or otherwise can’t respond, someone else on the list can.
284 * ``public_key``: VAPID public key
285 * ``private_key``: VAPID private key
288 * `enabled`: Whether the captcha should be shown on registration
289 * `method`: The method/service to use for captcha
290 * `seconds_valid`: The time in seconds for which the captcha is valid
292 ### Pleroma.Captcha.Kocaptcha
293 Kocaptcha is a very simple captcha service with a single API endpoint,
294 the source code is here: https://github.com/koto-bank/kocaptcha. The default endpoint
295 `https://captcha.kotobank.ch` is hosted by the developer.
297 * `endpoint`: the kocaptcha endpoint to use
301 Allows to set a token that can be used to authenticate with the admin api without using an actual user by giving it as the 'admin_token' parameter. Example:
304 config :pleroma, :admin_token, "somerandomtoken"
310 curl "http://localhost:4000/api/pleroma/admin/invite_token?admin_token=somerandomtoken"
313 ## :pleroma_job_queue
315 [Pleroma Job Queue](https://git.pleroma.social/pleroma/pleroma_job_queue) configuration: a list of queues with maximum concurrent jobs.
317 Pleroma has the following queues:
319 * `federator_outgoing` - Outgoing federation
320 * `federator_incoming` - Incoming federation
321 * `mailer` - Email sender, see [`Pleroma.Mailer`](#pleroma-mailer)
322 * `transmogrifier` - Transmogrifier
323 * `web_push` - Web push notifications
324 * `scheduled_activities` - Scheduled activities, see [`Pleroma.ScheduledActivities`](#pleromascheduledactivity)
329 config :pleroma_job_queue, :queues,
330 federator_incoming: 50,
331 federator_outgoing: 50
334 This config contains two queues: `federator_incoming` and `federator_outgoing`. Both have the `max_jobs` set to `50`.
336 ## Pleroma.Web.Federator.RetryQueue
338 * `enabled`: If set to `true`, failed federation jobs will be retried
339 * `max_jobs`: The maximum amount of parallel federation jobs running at the same time.
340 * `initial_timeout`: The initial timeout in seconds
341 * `max_retries`: The maximum number of times a federation job is retried
343 ## Pleroma.Web.Metadata
344 * `providers`: a list of metadata providers to enable. Providers availible:
345 * Pleroma.Web.Metadata.Providers.OpenGraph
346 * Pleroma.Web.Metadata.Providers.TwitterCard
347 * `unfurl_nsfw`: If set to `true` nsfw attachments will be shown in previews
350 * `enabled`: if enabled the instance will parse metadata from attached links to generate link previews
352 ## :fetch_initial_posts
353 * `enabled`: if enabled, when a new user is federated with, fetch some of their latest posts
354 * `pages`: the amount of pages to fetch
358 Advanced. Tweaks Hackney (http client) connections pools.
360 There's three pools used:
362 * `:federation` for the federation jobs.
363 You may want this pool max_connections to be at least equal to the number of federator jobs + retry queue jobs.
364 * `:media` for rich media, media proxy
365 * `:upload` for uploaded media (if using a remote uploader and `proxy_remote: true`)
367 For each pool, the options are:
369 * `max_connections` - how much connections a pool can hold
370 * `timeout` - retention duration for connections
374 Configuration for the `auto_linker` library:
376 * `class: "auto-linker"` - specify the class to be added to the generated link. false to clear
377 * `rel: "noopener noreferrer"` - override the rel attribute. false to clear
378 * `new_window: true` - set to false to remove `target='_blank'` attribute
379 * `scheme: false` - Set to true to link urls with schema `http://google.com`
380 * `truncate: false` - Set to a number to truncate urls longer then the number. Truncated urls will end in `..`
381 * `strip_prefix: true` - Strip the scheme prefix
382 * `extra: false` - link urls with rarely used schemes (magnet, ipfs, irc, etc.)
398 ## Pleroma.ScheduledActivity
400 * `daily_user_limit`: the number of scheduled activities a user is allowed to create in a single day (Default: `25`)
401 * `total_user_limit`: the number of scheduled activities a user is allowed to create in total (Default: `300`)
402 * `enabled`: whether scheduled activities are sent to the job queue to be executed
404 ## Pleroma.Web.Auth.Authenticator
406 * `Pleroma.Web.Auth.PleromaAuthenticator`: default database authenticator
407 * `Pleroma.Web.Auth.LDAPAuthenticator`: LDAP authentication
411 Use LDAP for user authentication. When a user logs in to the Pleroma
412 instance, the name and password will be verified by trying to authenticate
413 (bind) to an LDAP server. If a user exists in the LDAP directory but there
414 is no account with the same name yet on the Pleroma instance then a new
415 Pleroma account will be created with the same name as the LDAP user name.
417 * `enabled`: enables LDAP authentication
418 * `host`: LDAP server hostname
419 * `port`: LDAP port, e.g. 389 or 636
420 * `ssl`: true to use SSL, usually implies the port 636
421 * `sslopts`: additional SSL options
422 * `tls`: true to start TLS, usually implies the port 389
423 * `tlsopts`: additional TLS options
424 * `base`: LDAP base, e.g. "dc=example,dc=com"
425 * `uid`: LDAP attribute name to authenticate the user, e.g. when "cn", the filter will be "cn=username,base"
429 Authentication / authorization settings.
431 * `auth_template`: authentication form template. By default it's `show.html` which corresponds to `lib/pleroma/web/templates/o_auth/o_auth/show.html.eex`.
432 * `oauth_consumer_template`: OAuth consumer mode authentication form template. By default it's `consumer.html` which corresponds to `lib/pleroma/web/templates/o_auth/o_auth/consumer.html.eex`.
433 * `oauth_consumer_strategies`: the list of enabled OAuth consumer strategies; by default it's set by OAUTH_CONSUMER_STRATEGIES environment variable.
435 # OAuth consumer mode
437 OAuth consumer mode allows sign in / sign up via external OAuth providers (e.g. Twitter, Facebook, Google, Microsoft, etc.).
438 Implementation is based on Ueberauth; see the list of [available strategies](https://github.com/ueberauth/ueberauth/wiki/List-of-Strategies).
440 Note: each strategy is shipped as a separate dependency; in order to get the strategies, run `OAUTH_CONSUMER_STRATEGIES="..." mix deps.get`,
441 e.g. `OAUTH_CONSUMER_STRATEGIES="twitter facebook google microsoft" mix deps.get`.
442 The server should also be started with `OAUTH_CONSUMER_STRATEGIES="..." mix phx.server` in case you enable any strategies.
444 Note: each strategy requires separate setup (on external provider side and Pleroma side). Below are the guidelines on setting up most popular strategies.
446 * For Twitter, [register an app](https://developer.twitter.com/en/apps), configure callback URL to https://<your_host>/oauth/twitter/callback
448 * For Facebook, [register an app](https://developers.facebook.com/apps), configure callback URL to https://<your_host>/oauth/facebook/callback, enable Facebook Login service at https://developers.facebook.com/apps/<app_id>/fb-login/settings/
450 * For Google, [register an app](https://console.developers.google.com), configure callback URL to https://<your_host>/oauth/google/callback
452 * For Microsoft, [register an app](https://portal.azure.com), configure callback URL to https://<your_host>/oauth/microsoft/callback
454 Once the app is configured on external OAuth provider side, add app's credentials and strategy-specific settings (if any — e.g. see Microsoft below) to `config/prod.secret.exs`,
455 per strategy's documentation (e.g. [ueberauth_twitter](https://github.com/ueberauth/ueberauth_twitter)). Example config basing on environment variables:
459 config :ueberauth, Ueberauth.Strategy.Twitter.OAuth,
460 consumer_key: System.get_env("TWITTER_CONSUMER_KEY"),
461 consumer_secret: System.get_env("TWITTER_CONSUMER_SECRET")
464 config :ueberauth, Ueberauth.Strategy.Facebook.OAuth,
465 client_id: System.get_env("FACEBOOK_APP_ID"),
466 client_secret: System.get_env("FACEBOOK_APP_SECRET"),
467 redirect_uri: System.get_env("FACEBOOK_REDIRECT_URI")
470 config :ueberauth, Ueberauth.Strategy.Google.OAuth,
471 client_id: System.get_env("GOOGLE_CLIENT_ID"),
472 client_secret: System.get_env("GOOGLE_CLIENT_SECRET"),
473 redirect_uri: System.get_env("GOOGLE_REDIRECT_URI")
476 config :ueberauth, Ueberauth.Strategy.Microsoft.OAuth,
477 client_id: System.get_env("MICROSOFT_CLIENT_ID"),
478 client_secret: System.get_env("MICROSOFT_CLIENT_SECRET")
480 config :ueberauth, Ueberauth,
482 microsoft: {Ueberauth.Strategy.Microsoft, [callback_params: []]}