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 * `base_url`: The base URL to access a user-uploaded file. Useful when you want to proxy the media files via another host.
10 * `proxy_remote`: If you\'re using a remote uploader, Pleroma will proxy media requests instead of redirecting to it.
11 * `proxy_opts`: Proxy options, see `Pleroma.ReverseProxy` documentation.
13 Note: `strip_exif` has been replaced by `Pleroma.Upload.Filter.Mogrify`.
15 ## Pleroma.Uploaders.Local
16 * `uploads`: Which directory to store the user-uploads in, relative to pleroma’s working directory
18 ## Pleroma.Upload.Filter.Mogrify
20 * `args`: List of actions for the `mogrify` command like `"strip"` or `["strip", "auto-orient", {"impode", "1"}]`.
22 ## Pleroma.Upload.Filter.Dedupe
24 No specific configuration.
26 ## Pleroma.Upload.Filter.AnonymizeFilename
28 This filter replaces the filename (not the path) of an upload. For complete obfuscation, add
29 `Pleroma.Upload.Filter.Dedupe` before AnonymizeFilename.
31 * `text`: Text to replace filenames in links. If empty, `{random}.extension` will be used.
34 * `adapter`: one of the mail adapters listed in [Swoosh readme](https://github.com/swoosh/swoosh#adapters), or `Swoosh.Adapters.Local` for in-memory mailbox.
35 * `api_key` / `password` and / or other adapter-specific settings, per the above documentation.
37 An example for Sendgrid adapter:
40 config :pleroma, Pleroma.Mailer,
41 adapter: Swoosh.Adapters.Sendgrid,
42 api_key: "YOUR_API_KEY"
45 An example for SMTP adapter:
48 config :pleroma, Pleroma.Mailer,
49 adapter: Swoosh.Adapters.SMTP,
50 relay: "smtp.gmail.com",
51 username: "YOUR_USERNAME@gmail.com",
52 password: "YOUR_SMTP_PASSWORD",
60 * `valid_schemes`: List of the scheme part that is considered valid to be an URL
63 * `name`: The instance’s name
64 * `email`: Email used to reach an Administrator/Moderator of the instance
65 * `description`: The instance’s description, can be seen in nodeinfo and ``/api/v1/instance``
66 * `limit`: Posts character limit (CW/Subject included in the counter)
67 * `remote_limit`: Hard character limit beyond which remote posts will be dropped.
68 * `upload_limit`: File size limit of uploads (except for avatar, background, banner)
69 * `avatar_upload_limit`: File size limit of user’s profile avatars
70 * `background_upload_limit`: File size limit of user’s profile backgrounds
71 * `banner_upload_limit`: File size limit of user’s profile banners
72 * `registrations_open`: Enable registrations for anyone, invitations can be enabled when false.
73 * `invites_enabled`: Enable user invitations for admins (depends on `registrations_open: false`).
74 * `account_activation_required`: Require users to confirm their emails before signing in.
75 * `federating`: Enable federation with other instances
76 * `federation_reachability_timeout_days`: Timeout (in days) of each external federation target being unreachable prior to pausing federating to it.
77 * `allow_relay`: Enable Pleroma’s Relay, which makes it possible to follow a whole instance
78 * `rewrite_policy`: Message Rewrite Policy, either one or a list. Here are the ones available by default:
79 * `Pleroma.Web.ActivityPub.MRF.NoOpPolicy`: Doesn’t modify activities (default)
80 * `Pleroma.Web.ActivityPub.MRF.DropPolicy`: Drops all activities. It generally doesn’t makes sense to use in production
81 * `Pleroma.Web.ActivityPub.MRF.SimplePolicy`: Restrict the visibility of activities from certains instances (See ``:mrf_simple`` section)
82 * `Pleroma.Web.ActivityPub.MRF.RejectNonPublic`: Drops posts with non-public visibility settings (See ``:mrf_rejectnonpublic`` section)
83 * `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:.
84 * `public`: Makes the client API in authentificated mode-only except for user-profiles. Useful for disabling the Local Timeline and The Whole Known Network.
85 * `quarantined_instances`: List of ActivityPub instances where private(DMs, followers-only) activities will not be send.
86 * `managed_config`: Whenether the config for pleroma-fe is configured in this config or in ``static/config.json``
87 * `allowed_post_formats`: MIME-type list of formats allowed to be posted (transformed into HTML)
88 * `finmoji_enabled`: Whenether to enable the finmojis in the custom emojis.
89 * `mrf_transparency`: Make the content of your Message Rewrite Facility settings public (via nodeinfo).
90 * `scope_copy`: Copy the scope (private/unlisted/public) in replies to posts by default.
91 * `subject_line_behavior`: Allows changing the default behaviour of subject lines in replies. Valid values:
92 * "email": Copy and preprend re:, as in email.
93 * "masto": Copy verbatim, as in Mastodon.
94 * "noop": Don't copy the subject.
95 * `always_show_subject_input`: When set to false, auto-hide the subject field when it's empty.
96 * `extended_nickname_format`: Set to `true` to use extended local nicknames format (allows underscores/dashes). This will break federation with
97 older software for theses nicknames.
98 * `max_pinned_statuses`: The maximum number of pinned statuses. `0` will disable the feature.
99 * `autofollowed_nicknames`: Set to nicknames of (local) users that every new user should automatically follow.
100 * `no_attachment_links`: Set to true to disable automatically adding attachment link text to statuses
101 * `welcome_message`: A message that will be send to a newly registered users as a direct message.
102 * `welcome_user_nickname`: The nickname of the local user that sends the welcome message.
105 * `backends`: `:console` is used to send logs to stdout, `{ExSyslogger, :ex_syslogger}` to log to syslog
107 An example to enable ONLY ExSyslogger (f/ex in ``prod.secret.exs``) with info and debug suppressed:
110 backends: [{ExSyslogger, :ex_syslogger}]
112 config :logger, :ex_syslogger,
116 Another example, keeping console output and adding the pid to syslog output:
119 backends: [:console, {ExSyslogger, :ex_syslogger}]
121 config :logger, :ex_syslogger,
123 option: [:pid, :ndelay]
126 See: [logger’s documentation](https://hexdocs.pm/logger/Logger.html) and [ex_syslogger’s documentation](https://hexdocs.pm/ex_syslogger/)
129 ## :frontend_configurations
131 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` are configured.
133 Frontends can access these settings at `/api/pleroma/frontend_configurations`
135 To add your own configuration for PleromaFE, use it like this:
137 `config :pleroma, :frontend_configurations, pleroma_fe: %{redirectRootNoLogin: "/main/all", ...}`
139 These settings need to be complete, they will override the defaults. See `priv/static/static/config.json` for the available keys.
142 __THIS IS DEPRECATED__
144 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`.
146 This section is used to configure Pleroma-FE, unless ``:managed_config`` in ``:instance`` is set to false.
148 * `theme`: Which theme to use, they are defined in ``styles.json``
149 * `logo`: URL of the logo, defaults to Pleroma’s logo
150 * `logo_mask`: Whether to use only the logo's shape as a mask (true) or as a regular image (false)
151 * `logo_margin`: What margin to use around the logo
152 * `background`: URL of the background, unless viewing a user profile with a background that is set
153 * `redirect_root_no_login`: relative URL which indicates where to redirect when a user isn’t logged in.
154 * `redirect_root_login`: relative URL which indicates where to redirect when a user is logged in.
155 * `show_instance_panel`: Whenether to show the instance’s specific panel.
156 * `scope_options_enabled`: Enable setting an notice visibility and subject/CW when posting
157 * `formatting_options_enabled`: Enable setting a formatting different than plain-text (ie. HTML, Markdown) when posting, relates to ``:instance, allowed_post_formats``
158 * `collapse_message_with_subjects`: When a message has a subject(aka Content Warning), collapse it by default
159 * `hide_post_stats`: Hide notices statistics(repeats, favorites, …)
160 * `hide_user_stats`: Hide profile statistics(posts, posts per day, followers, followings, …)
163 * `media_removal`: List of instances to remove medias from
164 * `media_nsfw`: List of instances to put medias as NSFW(sensitive) from
165 * `federated_timeline_removal`: List of instances to remove from Federated (aka The Whole Known Network) Timeline
166 * `reject`: List of instances to reject any activities from
167 * `accept`: List of instances to accept any activities from
169 ## :mrf_rejectnonpublic
170 * `allow_followersonly`: whether to allow followers-only posts
171 * `allow_direct`: whether to allow direct messages
174 * `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.
175 * `reject_threshold`: Number of mentioned users after which the messaged gets rejected. Set to 0 to disable.
178 * `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)
179 * `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)
180 * `replace`: A list of tuples containing `{pattern, replacement}`, `pattern` can be a string or a [regular expression](https://hexdocs.pm/elixir/Regex.html)
183 * `enabled`: Enables proxying of remote media to the instance’s proxy
184 * `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.
185 * `proxy_opts`: All options defined in `Pleroma.ReverseProxy` documentation, defaults to `[max_body_length: (25*1_048_576)]`.
188 * `enabled`: Enables the gopher interface
189 * `ip`: IP address to bind to
190 * `port`: Port to bind to
193 * ``accept_blocks``: Whether to accept incoming block activities from other instances
194 * ``unfollow_blocked``: Whether blocks result in people getting unfollowed
195 * ``outgoing_blocks``: Whether to federate blocks to other instances
196 * ``deny_follow_blocked``: Whether to disallow following an account that has blocked the user in question
199 * ``enabled``: Whether the managed content security policy is enabled
200 * ``sts``: Whether to additionally send a `Strict-Transport-Security` header
201 * ``sts_max_age``: The maximum age for the `Strict-Transport-Security` header if sent
202 * ``ct_max_age``: The maximum age for the `Expect-CT` header if sent
203 * ``referrer_policy``: The referrer policy to use, either `"same-origin"` or `"no-referrer"`.
205 ## :mrf_user_allowlist
207 The keys in this section are the domain names that the policy should apply to.
208 Each key should be assigned a list of users that should be allowed through by
209 their ActivityPub ID.
214 config :pleroma, :mrf_user_allowlist,
215 "example.org": ["https://example.org/users/admin"]
218 ## :web_push_encryption, :vapid_details
220 Web Push Notifications configuration. You can use the mix task `mix web_push.gen.keypair` to generate it.
222 * ``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.
223 * ``public_key``: VAPID public key
224 * ``private_key``: VAPID private key
227 * `enabled`: Whether the captcha should be shown on registration
228 * `method`: The method/service to use for captcha
229 * `seconds_valid`: The time in seconds for which the captcha is valid
231 ### Pleroma.Captcha.Kocaptcha
232 Kocaptcha is a very simple captcha service with a single API endpoint,
233 the source code is here: https://github.com/koto-bank/kocaptcha. The default endpoint
234 `https://captcha.kotobank.ch` is hosted by the developer.
236 * `endpoint`: the kocaptcha endpoint to use
240 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:
243 config :pleroma, :admin_token, "somerandomtoken"
249 curl "http://localhost:4000/api/pleroma/admin/invite_token?admin_token=somerandomtoken"
254 A list of job queues and their settings.
258 * `max_jobs`: The maximum amount of parallel jobs running at the same time.
263 config :pleroma, Pleroma.Jobs,
264 federator_incoming: [max_jobs: 50],
265 federator_outgoing: [max_jobs: 50]
268 This config contains two queues: `federator_incoming` and `federator_outgoing`. Both have the `max_jobs` set to `50`.
271 ## Pleroma.Web.Federator.RetryQueue
273 * `enabled`: If set to `true`, failed federation jobs will be retried
274 * `max_jobs`: The maximum amount of parallel federation jobs running at the same time.
275 * `initial_timeout`: The initial timeout in seconds
276 * `max_retries`: The maximum number of times a federation job is retried
278 ## Pleroma.Web.Metadata
279 * `providers`: a list of metadata providers to enable. Providers availible:
280 * Pleroma.Web.Metadata.Providers.OpenGraph
281 * Pleroma.Web.Metadata.Providers.TwitterCard
282 * `unfurl_nsfw`: If set to `true` nsfw attachments will be shown in previews
285 * `enabled`: if enabled the instance will parse metadata from attached links to generate link previews
289 Advanced. Tweaks Hackney (http client) connections pools.
291 There's three pools used:
293 * `:federation` for the federation jobs.
294 You may want this pool max_connections to be at least equal to the number of federator jobs + retry queue jobs.
295 * `:media` for rich media, media proxy
296 * `:upload` for uploaded media (if using a remote uploader and `proxy_remote: true`)
298 For each pool, the options are:
300 * `max_connections` - how much connections a pool can hold
301 * `timeout` - retention duration for connections