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:
47 config :pleroma, Pleroma.Mailer,
48 adapter: Swoosh.Adapters.SMTP,
49 relay: "smtp.gmail.com",
50 username: "YOUR_USERNAME@gmail.com",
51 password: "YOUR_SMTP_PASSWORD",
59 * `valid_schemes`: List of the scheme part that is considered valid to be an URL
62 * `name`: The instance’s name
63 * `email`: Email used to reach an Administrator/Moderator of the instance
64 * `description`: The instance’s description, can be seen in nodeinfo and ``/api/v1/instance``
65 * `limit`: Posts character limit (CW/Subject included in the counter)
66 * `remote_limit`: Hard character limit beyond which remote posts will be dropped.
67 * `upload_limit`: File size limit of uploads (except for avatar, background, banner)
68 * `avatar_upload_limit`: File size limit of user’s profile avatars
69 * `background_upload_limit`: File size limit of user’s profile backgrounds
70 * `banner_upload_limit`: File size limit of user’s profile banners
71 * `registrations_open`: Enable registrations for anyone, invitations can be enabled when false.
72 * `invites_enabled`: Enable user invitations for admins (depends on `registrations_open: false`).
73 * `account_activation_required`: Require users to confirm their emails before signing in.
74 * `federating`: Enable federation with other instances
75 * `federation_reachability_timeout_days`: Timeout (in days) of each external federation target being unreachable prior to pausing federating to it.
76 * `allow_relay`: Enable Pleroma’s Relay, which makes it possible to follow a whole instance
77 * `rewrite_policy`: Message Rewrite Policy, either one or a list. Here are the ones available by default:
78 * `Pleroma.Web.ActivityPub.MRF.NoOpPolicy`: Doesn’t modify activities (default)
79 * `Pleroma.Web.ActivityPub.MRF.DropPolicy`: Drops all activities. It generally doesn’t makes sense to use in production
80 * `Pleroma.Web.ActivityPub.MRF.SimplePolicy`: Restrict the visibility of activities from certains instances (See ``:mrf_simple`` section)
81 * `Pleroma.Web.ActivityPub.MRF.RejectNonPublic`: Drops posts with non-public visibility settings (See ``:mrf_rejectnonpublic`` section)
82 * `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:.
83 * `public`: Makes the client API in authentificated mode-only except for user-profiles. Useful for disabling the Local Timeline and The Whole Known Network.
84 * `quarantined_instances`: List of ActivityPub instances where private(DMs, followers-only) activities will not be send.
85 * `managed_config`: Whenether the config for pleroma-fe is configured in this config or in ``static/config.json``
86 * `allowed_post_formats`: MIME-type list of formats allowed to be posted (transformed into HTML)
87 * `finmoji_enabled`: Whenether to enable the finmojis in the custom emojis.
88 * `mrf_transparency`: Make the content of your Message Rewrite Facility settings public (via nodeinfo).
89 * `scope_copy`: Copy the scope (private/unlisted/public) in replies to posts by default.
90 * `subject_line_behavior`: Allows changing the default behaviour of subject lines in replies. Valid values:
91 * "email": Copy and preprend re:, as in email.
92 * "masto": Copy verbatim, as in Mastodon.
93 * "noop": Don't copy the subject.
94 * `always_show_subject_input`: When set to false, auto-hide the subject field when it's empty.
95 * `extended_nickname_format`: Set to `true` to use extended local nicknames format (allows underscores/dashes). This will break federation with
96 older software for theses nicknames.
97 * `max_pinned_statuses`: The maximum number of pinned statuses. `0` will disable the feature.
98 * `autofollowed_nicknames`: Set to nicknames of (local) users that every new user should automatically follow.
99 * `no_attachment_links`: Set to true to disable automatically adding attachment link text to statuses
100 * `welcome_message`: A message that will be send to a newly registered users as a direct message.
101 * `welcome_user_nickname`: The nickname of the local user that sends the welcome message.
104 * `backends`: `:console` is used to send logs to stdout, `{ExSyslogger, :ex_syslogger}` to log to syslog
106 An example to enable ONLY ExSyslogger (f/ex in ``prod.secret.exs``) with info and debug suppressed:
109 backends: [{ExSyslogger, :ex_syslogger}]
111 config :logger, :ex_syslogger,
115 Another example, keeping console output and adding the pid to syslog output:
118 backends: [:console, {ExSyslogger, :ex_syslogger}]
120 config :logger, :ex_syslogger,
122 option: [:pid, :ndelay]
125 See: [logger’s documentation](https://hexdocs.pm/logger/Logger.html) and [ex_syslogger’s documentation](https://hexdocs.pm/ex_syslogger/)
128 ## :frontend_configurations
130 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.
132 Frontends can access these settings at `/api/pleroma/frontend_configurations`
134 To add your own configuration for PleromaFE, use it like this:
136 `config :pleroma, :frontend_configurations, pleroma_fe: %{redirectRootNoLogin: "/main/all", ...}`
138 These settings need to be complete, they will override the defaults. See `priv/static/static/config.json` for the available keys.
141 __THIS IS DEPRECATED__
143 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`.
145 This section is used to configure Pleroma-FE, unless ``:managed_config`` in ``:instance`` is set to false.
147 * `theme`: Which theme to use, they are defined in ``styles.json``
148 * `logo`: URL of the logo, defaults to Pleroma’s logo
149 * `logo_mask`: Whether to use only the logo's shape as a mask (true) or as a regular image (false)
150 * `logo_margin`: What margin to use around the logo
151 * `background`: URL of the background, unless viewing a user profile with a background that is set
152 * `redirect_root_no_login`: relative URL which indicates where to redirect when a user isn’t logged in.
153 * `redirect_root_login`: relative URL which indicates where to redirect when a user is logged in.
154 * `show_instance_panel`: Whenether to show the instance’s specific panel.
155 * `scope_options_enabled`: Enable setting an notice visibility and subject/CW when posting
156 * `formatting_options_enabled`: Enable setting a formatting different than plain-text (ie. HTML, Markdown) when posting, relates to ``:instance, allowed_post_formats``
157 * `collapse_message_with_subjects`: When a message has a subject(aka Content Warning), collapse it by default
158 * `hide_post_stats`: Hide notices statistics(repeats, favorites, …)
159 * `hide_user_stats`: Hide profile statistics(posts, posts per day, followers, followings, …)
162 * `media_removal`: List of instances to remove medias from
163 * `media_nsfw`: List of instances to put medias as NSFW(sensitive) from
164 * `federated_timeline_removal`: List of instances to remove from Federated (aka The Whole Known Network) Timeline
165 * `reject`: List of instances to reject any activities from
166 * `accept`: List of instances to accept any activities from
168 ## :mrf_rejectnonpublic
169 * `allow_followersonly`: whether to allow followers-only posts
170 * `allow_direct`: whether to allow direct messages
173 * `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.
174 * `reject_threshold`: Number of mentioned users after which the messaged gets rejected. Set to 0 to disable.
177 * `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)
178 * `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)
179 * `replace`: A list of tuples containing `{pattern, replacement}`, `pattern` can be a string or a [regular expression](https://hexdocs.pm/elixir/Regex.html)
182 * `enabled`: Enables proxying of remote media to the instance’s proxy
183 * `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.
184 * `proxy_opts`: All options defined in `Pleroma.ReverseProxy` documentation, defaults to `[max_body_length: (25*1_048_576)]`.
187 * `enabled`: Enables the gopher interface
188 * `ip`: IP address to bind to
189 * `port`: Port to bind to
192 * ``accept_blocks``: Whether to accept incoming block activities from other instances
193 * ``unfollow_blocked``: Whether blocks result in people getting unfollowed
194 * ``outgoing_blocks``: Whether to federate blocks to other instances
195 * ``deny_follow_blocked``: Whether to disallow following an account that has blocked the user in question
198 * ``enabled``: Whether the managed content security policy is enabled
199 * ``sts``: Whether to additionally send a `Strict-Transport-Security` header
200 * ``sts_max_age``: The maximum age for the `Strict-Transport-Security` header if sent
201 * ``ct_max_age``: The maximum age for the `Expect-CT` header if sent
202 * ``referrer_policy``: The referrer policy to use, either `"same-origin"` or `"no-referrer"`.
204 ## :mrf_user_allowlist
206 The keys in this section are the domain names that the policy should apply to.
207 Each key should be assigned a list of users that should be allowed through by
208 their ActivityPub ID.
213 config :pleroma, :mrf_user_allowlist,
214 "example.org": ["https://example.org/users/admin"]
217 ## :web_push_encryption, :vapid_details
219 Web Push Notifications configuration. You can use the mix task `mix web_push.gen.keypair` to generate it.
221 * ``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.
222 * ``public_key``: VAPID public key
223 * ``private_key``: VAPID private key
226 * `enabled`: Whether the captcha should be shown on registration
227 * `method`: The method/service to use for captcha
228 * `seconds_valid`: The time in seconds for which the captcha is valid
230 ### Pleroma.Captcha.Kocaptcha
231 Kocaptcha is a very simple captcha service with a single API endpoint,
232 the source code is here: https://github.com/koto-bank/kocaptcha. The default endpoint
233 `https://captcha.kotobank.ch` is hosted by the developer.
235 * `endpoint`: the kocaptcha endpoint to use
239 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:
242 config :pleroma, :admin_token, "somerandomtoken"
247 curl "http://localhost:4000/api/pleroma/admin/invite_token?admin_token=somerandomtoken"
250 ## Pleroma.Web.Federator
252 * `max_jobs`: The maximum amount of parallel federation jobs running at the same time.
254 ## Pleroma.Web.Federator.RetryQueue
256 * `enabled`: If set to `true`, failed federation jobs will be retried
257 * `max_jobs`: The maximum amount of parallel federation jobs running at the same time.
258 * `initial_timeout`: The initial timeout in seconds
259 * `max_retries`: The maximum number of times a federation job is retried
261 ## Pleroma.Web.Metadata
262 * `providers`: a list of metadata providers to enable. Providers availible:
263 * Pleroma.Web.Metadata.Providers.OpenGraph
264 * Pleroma.Web.Metadata.Providers.TwitterCard
265 * `unfurl_nsfw`: If set to `true` nsfw attachments will be shown in previews
268 * `enabled`: if enabled the instance will parse metadata from attached links to generate link previews
272 Advanced. Tweaks Hackney (http client) connections pools.
274 There's three pools used:
276 * `:federation` for the federation jobs.
277 You may want this pool max_connections to be at least equal to the number of federator jobs + retry queue jobs.
278 * `:media` for rich media, media proxy
279 * `:upload` for uploaded media (if using a remote uploader and `proxy_remote: true`)
281 For each pool, the options are:
283 * `max_connections` - how much connections a pool can hold
284 * `timeout` - retention duration for connections