e68b6c6dc1773093309dfff65641db358d8b38ec
[akkoma] / docs / configuration / cheatsheet.md
1 # Configuration Cheat Sheet
2
3 This is a cheat sheet for Pleroma configuration file, any setting possible to configure should be listed here.
4
5 For OTP installations the configuration is typically stored in `/etc/pleroma/config.exs`.
6
7 For from source installations Pleroma configuration works by first importing the base config `config/config.exs`, then overriding it by the environment config `config/$MIX_ENV.exs` and then overriding it by user config `config/$MIX_ENV.secret.exs`. In from source installations you should always make the changes to the user config and NEVER to the base config to avoid breakages and merge conflicts. So for production you change/add configuration to `config/prod.secret.exs`.
8
9 To add configuration to your config file, you can copy it from the base config. The latest version of it can be viewed [here](https://git.pleroma.social/pleroma/pleroma/blob/develop/config/config.exs). You can also use this file if you don't know how an option is supposed to be formatted.
10
11 ## :chat
12
13 * `enabled` - Enables the backend chat. Defaults to `true`.
14
15 ## :instance
16 * `name`: The instance’s name.
17 * `email`: Email used to reach an Administrator/Moderator of the instance.
18 * `notify_email`: Email used for notifications.
19 * `description`: The instance’s description, can be seen in nodeinfo and ``/api/v1/instance``.
20 * `limit`: Posts character limit (CW/Subject included in the counter).
21 * `discription_limit`: The character limit for image descriptions.
22 * `chat_limit`: Character limit of the instance chat messages.
23 * `remote_limit`: Hard character limit beyond which remote posts will be dropped.
24 * `upload_limit`: File size limit of uploads (except for avatar, background, banner).
25 * `avatar_upload_limit`: File size limit of user’s profile avatars.
26 * `background_upload_limit`: File size limit of user’s profile backgrounds.
27 * `banner_upload_limit`: File size limit of user’s profile banners.
28 * `poll_limits`: A map with poll limits for **local** polls.
29 * `max_options`: Maximum number of options.
30 * `max_option_chars`: Maximum number of characters per option.
31 * `min_expiration`: Minimum expiration time (in seconds).
32 * `max_expiration`: Maximum expiration time (in seconds).
33 * `registrations_open`: Enable registrations for anyone, invitations can be enabled when false.
34 * `invites_enabled`: Enable user invitations for admins (depends on `registrations_open: false`).
35 * `account_activation_required`: Require users to confirm their emails before signing in.
36 * `account_approval_required`: Require users to be manually approved by an admin before signing in.
37 * `federating`: Enable federation with other instances.
38 * `federation_incoming_replies_max_depth`: Max. depth of reply-to activities fetching on incoming federation, to prevent out-of-memory situations while fetching very long threads. If set to `nil`, threads of any depth will be fetched. Lower this value if you experience out-of-memory crashes.
39 * `federation_reachability_timeout_days`: Timeout (in days) of each external federation target being unreachable prior to pausing federating to it.
40 * `allow_relay`: Enable Pleroma’s Relay, which makes it possible to follow a whole instance.
41 * `public`: Makes the client API in authenticated mode-only except for user-profiles. Useful for disabling the Local Timeline and The Whole Known Network. Note that there is a dependent setting restricting or allowing unauthenticated access to specific resources, see `restrict_unauthenticated` for more details.
42 * `quarantined_instances`: List of ActivityPub instances where private (DMs, followers-only) activities will not be send.
43 * `managed_config`: Whenether the config for pleroma-fe is configured in [:frontend_configurations](#frontend_configurations) or in ``static/config.json``.
44 * `allowed_post_formats`: MIME-type list of formats allowed to be posted (transformed into HTML).
45 * `extended_nickname_format`: Set to `true` to use extended local nicknames format (allows underscores/dashes). This will break federation with
46 older software for theses nicknames.
47 * `max_pinned_statuses`: The maximum number of pinned statuses. `0` will disable the feature.
48 * `autofollowed_nicknames`: Set to nicknames of (local) users that every new user should automatically follow.
49 * `attachment_links`: Set to true to enable automatically adding attachment link text to statuses.
50 * `max_report_comment_size`: The maximum size of the report comment (Default: `1000`).
51 * `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`.
52 * `healthcheck`: If set to true, system data will be shown on ``/api/pleroma/healthcheck``.
53 * `remote_post_retention_days`: The default amount of days to retain remote posts when pruning the database.
54 * `user_bio_length`: A user bio maximum length (default: `5000`).
55 * `user_name_length`: A user name maximum length (default: `100`).
56 * `skip_thread_containment`: Skip filter out broken threads. The default is `false`.
57 * `limit_to_local_content`: Limit unauthenticated users to search for local statutes and users only. Possible values: `:unauthenticated`, `:all` and `false`. The default is `:unauthenticated`.
58 * `max_account_fields`: The maximum number of custom fields in the user profile (default: `10`).
59 * `max_remote_account_fields`: The maximum number of custom fields in the remote user profile (default: `20`).
60 * `account_field_name_length`: An account field name maximum length (default: `512`).
61 * `account_field_value_length`: An account field value maximum length (default: `2048`).
62 * `registration_reason_length`: Maximum registration reason length (default: `500`).
63 * `external_user_synchronization`: Enabling following/followers counters synchronization for external users.
64 * `cleanup_attachments`: Remove attachments along with statuses. Does not affect duplicate files and attachments without status. Enabling this will increase load to database when deleting statuses on larger instances.
65 * `show_reactions`: Let favourites and emoji reactions be viewed through the API (default: `true`).
66
67 ## Welcome
68 * `direct_message`: - welcome message sent as a direct message.
69 * `enabled`: Enables the send a direct message to a newly registered user. Defaults to `false`.
70 * `sender_nickname`: The nickname of the local user that sends the welcome message.
71 * `message`: A message that will be send to a newly registered users as a direct message.
72 * `chat_message`: - welcome message sent as a chat message.
73 * `enabled`: Enables the send a chat message to a newly registered user. Defaults to `false`.
74 * `sender_nickname`: The nickname of the local user that sends the welcome message.
75 * `message`: A message that will be send to a newly registered users as a chat message.
76 * `email`: - welcome message sent as a email.
77 * `enabled`: Enables the send a welcome email to a newly registered user. Defaults to `false`.
78 * `sender`: The email address or tuple with `{nickname, email}` that will use as sender to the welcome email.
79 * `subject`: A subject of welcome email.
80 * `html`: A html that will be send to a newly registered users as a email.
81 * `text`: A text that will be send to a newly registered users as a email.
82
83 Example:
84
85 ```elixir
86 config :pleroma, :welcome,
87 direct_message: [
88 enabled: true,
89 sender_nickname: "lain",
90 message: "Hi, @username! Welcome on board!"
91 ],
92 email: [
93 enabled: true,
94 sender: {"Pleroma App", "welcome@pleroma.app"},
95 subject: "Welcome to <%= instance_name %>",
96 html: "Welcome to <%= instance_name %>",
97 text: "Welcome to <%= instance_name %>"
98 ]
99 ```
100
101 ## Message rewrite facility
102
103 ### :mrf
104 * `policies`: Message Rewrite Policy, either one or a list. Here are the ones available by default:
105 * `Pleroma.Web.ActivityPub.MRF.NoOpPolicy`: Doesn’t modify activities (default).
106 * `Pleroma.Web.ActivityPub.MRF.DropPolicy`: Drops all activities. It generally doesn’t makes sense to use in production.
107 * `Pleroma.Web.ActivityPub.MRF.SimplePolicy`: Restrict the visibility of activities from certains instances (See [`:mrf_simple`](#mrf_simple)).
108 * `Pleroma.Web.ActivityPub.MRF.TagPolicy`: Applies policies to individual users based on tags, which can be set using pleroma-fe/admin-fe/any other app that supports Pleroma Admin API. For example it allows marking posts from individual users nsfw (sensitive).
109 * `Pleroma.Web.ActivityPub.MRF.SubchainPolicy`: Selectively runs other MRF policies when messages match (See [`:mrf_subchain`](#mrf_subchain)).
110 * `Pleroma.Web.ActivityPub.MRF.RejectNonPublic`: Drops posts with non-public visibility settings (See [`:mrf_rejectnonpublic`](#mrf_rejectnonpublic)).
111 * `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:.
112 * `Pleroma.Web.ActivityPub.MRF.AntiLinkSpamPolicy`: Rejects posts from likely spambots by rejecting posts from new users that contain links.
113 * `Pleroma.Web.ActivityPub.MRF.MediaProxyWarmingPolicy`: Crawls attachments using their MediaProxy URLs so that the MediaProxy cache is primed.
114 * `Pleroma.Web.ActivityPub.MRF.MentionPolicy`: Drops posts mentioning configurable users. (See [`:mrf_mention`](#mrf_mention)).
115 * `Pleroma.Web.ActivityPub.MRF.VocabularyPolicy`: Restricts activities to a configured set of vocabulary. (See [`:mrf_vocabulary`](#mrf_vocabulary)).
116 * `Pleroma.Web.ActivityPub.MRF.ObjectAgePolicy`: Rejects or delists posts based on their age when received. (See [`:mrf_object_age`](#mrf_object_age)).
117 * `Pleroma.Web.ActivityPub.MRF.ActivityExpirationPolicy`: Sets a default expiration on all posts made by users of the local instance. Requires `Pleroma.ActivityExpiration` to be enabled for processing the scheduled delections.
118 * `transparency`: Make the content of your Message Rewrite Facility settings public (via nodeinfo).
119 * `transparency_exclusions`: Exclude specific instance names from MRF transparency. The use of the exclusions feature will be disclosed in nodeinfo as a boolean value.
120
121 ## Federation
122 ### MRF policies
123
124 !!! note
125 Configuring MRF policies is not enough for them to take effect. You have to enable them by specifying their module in `policies` under [:mrf](#mrf) section.
126
127 #### :mrf_simple
128 * `media_removal`: List of instances to remove media from.
129 * `media_nsfw`: List of instances to put media as NSFW(sensitive) from.
130 * `federated_timeline_removal`: List of instances to remove from Federated (aka The Whole Known Network) Timeline.
131 * `reject`: List of instances to reject any activities from.
132 * `accept`: List of instances to accept any activities from.
133 * `followers_only`: List of instances to decrease post visibility to only the followers, including for DM mentions.
134 * `report_removal`: List of instances to reject reports from.
135 * `avatar_removal`: List of instances to strip avatars from.
136 * `banner_removal`: List of instances to strip banners from.
137
138 #### :mrf_subchain
139 This policy processes messages through an alternate pipeline when a given message matches certain criteria.
140 All criteria are configured as a map of regular expressions to lists of policy modules.
141
142 * `match_actor`: Matches a series of regular expressions against the actor field.
143
144 Example:
145
146 ```elixir
147 config :pleroma, :mrf_subchain,
148 match_actor: %{
149 ~r/https:\/\/example.com/s => [Pleroma.Web.ActivityPub.MRF.DropPolicy]
150 }
151 ```
152
153 #### :mrf_rejectnonpublic
154 * `allow_followersonly`: whether to allow followers-only posts.
155 * `allow_direct`: whether to allow direct messages.
156
157 #### :mrf_hellthread
158 * `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.
159 * `reject_threshold`: Number of mentioned users after which the messaged gets rejected. Set to 0 to disable.
160
161 #### :mrf_keyword
162 * `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).
163 * `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).
164 * `replace`: A list of tuples containing `{pattern, replacement}`, `pattern` can be a string or a [regular expression](https://hexdocs.pm/elixir/Regex.html).
165
166 #### :mrf_mention
167 * `actors`: A list of actors, for which to drop any posts mentioning.
168
169 #### :mrf_vocabulary
170 * `accept`: A list of ActivityStreams terms to accept. If empty, all supported messages are accepted.
171 * `reject`: A list of ActivityStreams terms to reject. If empty, no messages are rejected.
172
173 #### :mrf_user_allowlist
174
175 The keys in this section are the domain names that the policy should apply to.
176 Each key should be assigned a list of users that should be allowed through by
177 their ActivityPub ID.
178
179 An example:
180
181 ```elixir
182 config :pleroma, :mrf_user_allowlist, %{
183 "example.org" => ["https://example.org/users/admin"]
184 }
185 ```
186
187 #### :mrf_object_age
188 * `threshold`: Required time offset (in seconds) compared to your server clock of an incoming post before actions are taken.
189 e.g., A value of 900 results in any post with a timestamp older than 15 minutes will be acted upon.
190 * `actions`: A list of actions to apply to the post:
191 * `:delist` removes the post from public timelines
192 * `:strip_followers` removes followers from the ActivityPub recipient list, ensuring they won't be delivered to home timelines
193 * `:reject` rejects the message entirely
194
195 #### :mrf_steal_emoji
196 * `hosts`: List of hosts to steal emojis from
197 * `rejected_shortcodes`: Regex-list of shortcodes to reject
198 * `size_limit`: File size limit (in bytes), checked before an emoji is saved to the disk
199
200 #### :mrf_activity_expiration
201
202 * `days`: Default global expiration time for all local Create activities (in days)
203
204 ### :activitypub
205 * `unfollow_blocked`: Whether blocks result in people getting unfollowed
206 * `outgoing_blocks`: Whether to federate blocks to other instances
207 * `deny_follow_blocked`: Whether to disallow following an account that has blocked the user in question
208 * `sign_object_fetches`: Sign object fetches with HTTP signatures
209 * `authorized_fetch_mode`: Require HTTP signatures for AP fetches
210
211 ## Pleroma.User
212
213 * `restricted_nicknames`: List of nicknames users may not register with.
214 * `email_blacklist`: List of email domains users may not register with.
215
216 ## Pleroma.ScheduledActivity
217
218 * `daily_user_limit`: the number of scheduled activities a user is allowed to create in a single day (Default: `25`)
219 * `total_user_limit`: the number of scheduled activities a user is allowed to create in total (Default: `300`)
220 * `enabled`: whether scheduled activities are sent to the job queue to be executed
221
222 ## Pleroma.ActivityExpiration
223
224 Enables the worker which processes posts scheduled for deletion. Pinned posts are exempt from expiration.
225
226 * `enabled`: whether expired activities will be sent to the job queue to be deleted
227
228 ## Frontends
229
230 ### :frontend_configurations
231
232 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. You can find the documentation for `pleroma_fe` configuration into [Pleroma-FE configuration and customization for instance administrators](/frontend/CONFIGURATION/#options).
233
234 Frontends can access these settings at `/api/pleroma/frontend_configurations`
235
236 To add your own configuration for PleromaFE, use it like this:
237
238 ```elixir
239 config :pleroma, :frontend_configurations,
240 pleroma_fe: %{
241 theme: "pleroma-dark",
242 # ... see /priv/static/static/config.json for the available keys.
243 },
244 masto_fe: %{
245 showInstanceSpecificPanel: true
246 }
247 ```
248
249 These settings **need to be complete**, they will override the defaults.
250
251 ### :static_fe
252
253 Render profiles and posts using server-generated HTML that is viewable without using JavaScript.
254
255 Available options:
256
257 * `enabled` - Enables the rendering of static HTML. Defaults to `false`.
258
259 ### :assets
260
261 This section configures assets to be used with various frontends. Currently the only option
262 relates to mascots on the mastodon frontend
263
264 * `mascots`: KeywordList of mascots, each element __MUST__ contain both a `url` and a
265 `mime_type` key.
266 * `default_mascot`: An element from `mascots` - This will be used as the default mascot
267 on MastoFE (default: `:pleroma_fox_tan`).
268
269 ### :manifest
270
271 This section describe PWA manifest instance-specific values. Currently this option relate only for MastoFE.
272
273 * `icons`: Describe the icons of the app, this a list of maps describing icons in the same way as the
274 [spec](https://www.w3.org/TR/appmanifest/#imageresource-and-its-members) describes it.
275
276 Example:
277
278 ```elixir
279 config :pleroma, :manifest,
280 icons: [
281 %{
282 src: "/static/logo.png"
283 },
284 %{
285 src: "/static/icon.png",
286 type: "image/png"
287 },
288 %{
289 src: "/static/icon.ico",
290 sizes: "72x72 96x96 128x128 256x256"
291 }
292 ]
293 ```
294
295 * `theme_color`: Describe the theme color of the app. (Example: `"#282c37"`, `"rebeccapurple"`).
296 * `background_color`: Describe the background color of the app. (Example: `"#191b22"`, `"aliceblue"`).
297
298 ## :emoji
299
300 * `shortcode_globs`: Location of custom emoji files. `*` can be used as a wildcard. Example `["/emoji/custom/**/*.png"]`
301 * `pack_extensions`: A list of file extensions for emojis, when no emoji.txt for a pack is present. Example `[".png", ".gif"]`
302 * `groups`: Emojis are ordered in groups (tags). This is an array of key-value pairs where the key is the groupname and the value the location or array of locations. `*` can be used as a wildcard. Example `[Custom: ["/emoji/*.png", "/emoji/custom/*.png"]]`
303 * `default_manifest`: Location of the JSON-manifest. This manifest contains information about the emoji-packs you can download. Currently only one manifest can be added (no arrays).
304 * `shared_pack_cache_seconds_per_file`: When an emoji pack is shared, the archive is created and cached in
305 memory for this amount of seconds multiplied by the number of files.
306
307 ## :media_proxy
308
309 * `enabled`: Enables proxying of remote media to the instance’s proxy
310 * `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.
311 * `proxy_opts`: All options defined in `Pleroma.ReverseProxy` documentation, defaults to `[max_body_length: (25*1_048_576)]`.
312 * `whitelist`: List of hosts with scheme to bypass the mediaproxy (e.g. `https://example.com`)
313 * `invalidation`: options for remove media from cache after delete object:
314 * `enabled`: Enables purge cache
315 * `provider`: Which one of the [purge cache strategy](#purge-cache-strategy) to use.
316
317 ### Purge cache strategy
318
319 #### Pleroma.Web.MediaProxy.Invalidation.Script
320
321 This strategy allow perform external shell script to purge cache.
322 Urls of attachments pass to script as arguments.
323
324 * `script_path`: path to external script.
325
326 Example:
327
328 ```elixir
329 config :pleroma, Pleroma.Web.MediaProxy.Invalidation.Script,
330 script_path: "./installation/nginx-cache-purge.example"
331 ```
332
333 #### Pleroma.Web.MediaProxy.Invalidation.Http
334
335 This strategy allow perform custom http request to purge cache.
336
337 * `method`: http method. default is `purge`
338 * `headers`: http headers.
339 * `options`: request options.
340
341 Example:
342 ```elixir
343 config :pleroma, Pleroma.Web.MediaProxy.Invalidation.Http,
344 method: :purge,
345 headers: [],
346 options: []
347 ```
348
349 ## Link previews
350
351 ### Pleroma.Web.Metadata (provider)
352 * `providers`: a list of metadata providers to enable. Providers available:
353 * `Pleroma.Web.Metadata.Providers.OpenGraph`
354 * `Pleroma.Web.Metadata.Providers.TwitterCard`
355 * `Pleroma.Web.Metadata.Providers.RelMe` - add links from user bio with rel=me into the `<header>` as `<link rel=me>`.
356 * `Pleroma.Web.Metadata.Providers.Feed` - add a link to a user's Atom feed into the `<header>` as `<link rel=alternate>`.
357 * `unfurl_nsfw`: If set to `true` nsfw attachments will be shown in previews.
358
359 ### :rich_media (consumer)
360 * `enabled`: if enabled the instance will parse metadata from attached links to generate link previews.
361 * `ignore_hosts`: list of hosts which will be ignored by the metadata parser. For example `["accounts.google.com", "xss.website"]`, defaults to `[]`.
362 * `ignore_tld`: list TLDs (top-level domains) which will ignore for parse metadata. default is ["local", "localdomain", "lan"].
363 * `parsers`: list of Rich Media parsers.
364
365 ## HTTP server
366
367 ### Pleroma.Web.Endpoint
368
369 !!! note
370 `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.
371
372 * `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. For deployment using docker, you need to set this to `[ip: {0,0,0,0}, port: 4000]` to make pleroma accessible from other containers (such as your nginx server).
373 - `ip` - a tuple consisting of 4 integers
374 - `port`
375 * `url` - a list containing the configuration for generating urls, accepts
376 - `host` - the host without the scheme and a post (e.g `example.com`, not `https://example.com:2020`)
377 - `scheme` - e.g `http`, `https`
378 - `port`
379 - `path`
380 * `extra_cookie_attrs` - a list of `Key=Value` strings to be added as non-standard cookie attributes. Defaults to `["SameSite=Lax"]`. See the [SameSite article](https://www.owasp.org/index.php/SameSite) on OWASP for more info.
381
382 Example:
383 ```elixir
384 config :pleroma, Pleroma.Web.Endpoint,
385 url: [host: "example.com", port: 2020, scheme: "https"],
386 http: [
387 port: 8080,
388 ip: {127, 0, 0, 1}
389 ]
390 ```
391
392 This will make Pleroma listen on `127.0.0.1` port `8080` and generate urls starting with `https://example.com:2020`
393
394 ### :http_security
395 * ``enabled``: Whether the managed content security policy is enabled.
396 * ``sts``: Whether to additionally send a `Strict-Transport-Security` header.
397 * ``sts_max_age``: The maximum age for the `Strict-Transport-Security` header if sent.
398 * ``ct_max_age``: The maximum age for the `Expect-CT` header if sent.
399 * ``referrer_policy``: The referrer policy to use, either `"same-origin"` or `"no-referrer"`.
400 * ``report_uri``: Adds the specified url to `report-uri` and `report-to` group in CSP header.
401
402 ### Pleroma.Plugs.RemoteIp
403
404 !!! warning
405 If your instance is not behind at least one reverse proxy, you should not enable this plug.
406
407 `Pleroma.Plugs.RemoteIp` is a shim to call [`RemoteIp`](https://git.pleroma.social/pleroma/remote_ip) but with runtime configuration.
408
409 Available options:
410
411 * `enabled` - Enable/disable the plug. Defaults to `false`.
412 * `headers` - A list of strings naming the `req_headers` to use when deriving the `remote_ip`. Order does not matter. Defaults to `["x-forwarded-for"]`.
413 * `proxies` - A list of strings in [CIDR](https://en.wikipedia.org/wiki/CIDR) notation specifying the IPs of known proxies. Defaults to `[]`.
414 * `reserved` - Defaults to [localhost](https://en.wikipedia.org/wiki/Localhost) and [private network](https://en.wikipedia.org/wiki/Private_network).
415
416
417 ### :rate_limit
418
419 !!! note
420 If your instance is behind a reverse proxy ensure [`Pleroma.Plugs.RemoteIp`](#pleroma-plugs-remoteip) is enabled (it is enabled by default).
421
422 A keyword list of rate limiters where a key is a limiter name and value is the limiter configuration. The basic configuration is a tuple where:
423
424 * The first element: `scale` (Integer). The time scale in milliseconds.
425 * The second element: `limit` (Integer). How many requests to limit in the time scale provided.
426
427 It is also possible to have different limits for unauthenticated and authenticated users: the keyword value must be a list of two tuples where the first one is a config for unauthenticated users and the second one is for authenticated.
428
429 For example:
430
431 ```elixir
432 config :pleroma, :rate_limit,
433 authentication: {60_000, 15},
434 search: [{1000, 10}, {1000, 30}]
435 ```
436
437 Means that:
438
439 1. In 60 seconds, 15 authentication attempts can be performed from the same IP address.
440 2. In 1 second, 10 search requests can be performed from the same IP adress by unauthenticated users, while authenticated users can perform 30 search requests per second.
441
442 Supported rate limiters:
443
444 * `:search` - Account/Status search.
445 * `:timeline` - Timeline requests (each timeline has it's own limiter).
446 * `:app_account_creation` - Account registration from the API.
447 * `:relations_actions` - Following/Unfollowing in general.
448 * `:relation_id_action` - Following/Unfollowing for a specific user.
449 * `:statuses_actions` - Status actions such as: (un)repeating, (un)favouriting, creating, deleting.
450 * `:status_id_action` - (un)Repeating/(un)Favouriting a particular status.
451 * `:authentication` - Authentication actions, i.e getting an OAuth token.
452 * `:password_reset` - Requesting password reset emails.
453 * `:account_confirmation_resend` - Requesting resending account confirmation emails.
454 * `:ap_routes` - Requesting statuses via ActivityPub.
455
456 ### :web_cache_ttl
457
458 The expiration time for the web responses cache. Values should be in milliseconds or `nil` to disable expiration.
459
460 Available caches:
461
462 * `:activity_pub` - activity pub routes (except question activities). Defaults to `nil` (no expiration).
463 * `:activity_pub_question` - activity pub routes (question activities). Defaults to `30_000` (30 seconds).
464
465 ## HTTP client
466
467 ### :http
468
469 * `proxy_url`: an upstream proxy to fetch posts and/or media with, (default: `nil`)
470 * `send_user_agent`: should we include a user agent with HTTP requests? (default: `true`)
471 * `user_agent`: what user agent should we use? (default: `:default`), must be string or `:default`
472 * `adapter`: array of adapter options
473
474 ### :hackney_pools
475
476 Advanced. Tweaks Hackney (http client) connections pools.
477
478 There's three pools used:
479
480 * `:federation` for the federation jobs.
481 You may want this pool max_connections to be at least equal to the number of federator jobs + retry queue jobs.
482 * `:media` for rich media, media proxy
483 * `:upload` for uploaded media (if using a remote uploader and `proxy_remote: true`)
484
485 For each pool, the options are:
486
487 * `max_connections` - how much connections a pool can hold
488 * `timeout` - retention duration for connections
489
490
491 ### :connections_pool
492
493 *For `gun` adapter*
494
495 Settings for HTTP connection pool.
496
497 * `:connection_acquisition_wait` - Timeout to acquire a connection from pool.The total max time is this value multiplied by the number of retries.
498 * `connection_acquisition_retries` - Number of attempts to acquire the connection from the pool if it is overloaded. Each attempt is timed `:connection_acquisition_wait` apart.
499 * `:max_connections` - Maximum number of connections in the pool.
500 * `:await_up_timeout` - Timeout to connect to the host.
501 * `:reclaim_multiplier` - Multiplied by `:max_connections` this will be the maximum number of idle connections that will be reclaimed in case the pool is overloaded.
502
503 ### :pools
504
505 *For `gun` adapter*
506
507 Settings for request pools. These pools are limited on top of `:connections_pool`.
508
509 There are four pools used:
510
511 * `:federation` for the federation jobs. You may want this pool's max_connections to be at least equal to the number of federator jobs + retry queue jobs.
512 * `:media` - for rich media, media proxy.
513 * `:upload` - for proxying media when a remote uploader is used and `proxy_remote: true`.
514 * `:default` - for other requests.
515
516 For each pool, the options are:
517
518 * `:size` - limit to how much requests can be concurrently executed.
519 * `:timeout` - timeout while `gun` will wait for response
520 * `:max_waiting` - limit to how much requests can be waiting for others to finish, after this is reached, subsequent requests will be dropped.
521
522 ## Captcha
523
524 ### Pleroma.Captcha
525
526 * `enabled`: Whether the captcha should be shown on registration.
527 * `method`: The method/service to use for captcha.
528 * `seconds_valid`: The time in seconds for which the captcha is valid.
529
530 ### Captcha providers
531
532 #### Pleroma.Captcha.Native
533
534 A built-in captcha provider. Enabled by default.
535
536 #### Pleroma.Captcha.Kocaptcha
537
538 Kocaptcha is a very simple captcha service with a single API endpoint,
539 the source code is here: [kocaptcha](https://github.com/koto-bank/kocaptcha). The default endpoint
540 `https://captcha.kotobank.ch` is hosted by the developer.
541
542 * `endpoint`: the Kocaptcha endpoint to use.
543
544 ## Uploads
545
546 ### Pleroma.Upload
547
548 * `uploader`: Which one of the [uploaders](#uploaders) to use.
549 * `filters`: List of [upload filters](#upload-filters) to use.
550 * `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`
551 * `base_url`: The base URL to access a user-uploaded file. Useful when you want to proxy the media files via another host.
552 * `proxy_remote`: If you're using a remote uploader, Pleroma will proxy media requests instead of redirecting to it.
553 * `proxy_opts`: Proxy options, see `Pleroma.ReverseProxy` documentation.
554 * `filename_display_max_length`: Set max length of a filename to display. 0 = no limit. Default: 30.
555
556 !!! warning
557 `strip_exif` has been replaced by `Pleroma.Upload.Filter.Mogrify`.
558
559 ### Uploaders
560
561 #### Pleroma.Uploaders.Local
562
563 * `uploads`: Which directory to store the user-uploads in, relative to pleroma’s working directory.
564
565 #### Pleroma.Uploaders.S3
566
567 Don't forget to configure [Ex AWS S3](#ex-aws-s3-settings)
568
569 * `bucket`: S3 bucket name.
570 * `bucket_namespace`: S3 bucket namespace.
571 * `public_endpoint`: S3 endpoint that the user finally accesses(ex. "https://s3.dualstack.ap-northeast-1.amazonaws.com")
572 * `truncated_namespace`: If you use S3 compatible service such as Digital Ocean Spaces or CDN, set folder name or "" etc.
573 For example, when using CDN to S3 virtual host format, set "".
574 At this time, write CNAME to CDN in public_endpoint.
575 * `streaming_enabled`: Enable streaming uploads, when enabled the file will be sent to the server in chunks as it's being read. This may be unsupported by some providers, try disabling this if you have upload problems.
576
577 #### Ex AWS S3 settings
578
579 * `access_key_id`: Access key ID
580 * `secret_access_key`: Secret access key
581 * `host`: S3 host
582
583 Example:
584
585 ```elixir
586 config :ex_aws, :s3,
587 access_key_id: "xxxxxxxxxx",
588 secret_access_key: "yyyyyyyyyy",
589 host: "s3.eu-central-1.amazonaws.com"
590 ```
591
592 ### Upload filters
593
594 #### Pleroma.Upload.Filter.AnonymizeFilename
595
596 This filter replaces the filename (not the path) of an upload. For complete obfuscation, add
597 `Pleroma.Upload.Filter.Dedupe` before AnonymizeFilename.
598
599 * `text`: Text to replace filenames in links. If empty, `{random}.extension` will be used. You can get the original filename extension by using `{extension}`, for example `custom-file-name.{extension}`.
600
601 #### Pleroma.Upload.Filter.Dedupe
602
603 No specific configuration.
604
605 #### Pleroma.Upload.Filter.Exiftool
606
607 This filter only strips the GPS and location metadata with Exiftool leaving color profiles and attributes intact.
608
609 No specific configuration.
610
611 #### Pleroma.Upload.Filter.Mogrify
612
613 * `args`: List of actions for the `mogrify` command like `"strip"` or `["strip", "auto-orient", {"implode", "1"}]`.
614
615 ## Email
616
617 ### Pleroma.Emails.Mailer
618 * `adapter`: one of the mail adapters listed in [Swoosh readme](https://github.com/swoosh/swoosh#adapters), or `Swoosh.Adapters.Local` for in-memory mailbox.
619 * `api_key` / `password` and / or other adapter-specific settings, per the above documentation.
620 * `enabled`: Allows enable/disable send emails. Default: `false`.
621
622 An example for Sendgrid adapter:
623
624 ```elixir
625 config :pleroma, Pleroma.Emails.Mailer,
626 enabled: true,
627 adapter: Swoosh.Adapters.Sendgrid,
628 api_key: "YOUR_API_KEY"
629 ```
630
631 An example for SMTP adapter:
632
633 ```elixir
634 config :pleroma, Pleroma.Emails.Mailer,
635 enabled: true,
636 adapter: Swoosh.Adapters.SMTP,
637 relay: "smtp.gmail.com",
638 username: "YOUR_USERNAME@gmail.com",
639 password: "YOUR_SMTP_PASSWORD",
640 port: 465,
641 ssl: true,
642 auth: :always
643 ```
644
645 ### :email_notifications
646
647 Email notifications settings.
648
649 - digest - emails of "what you've missed" for users who have been
650 inactive for a while.
651 - active: globally enable or disable digest emails
652 - schedule: When to send digest email, in [crontab format](https://en.wikipedia.org/wiki/Cron).
653 "0 0 * * 0" is the default, meaning "once a week at midnight on Sunday morning"
654 - interval: Minimum interval between digest emails to one user
655 - inactivity_threshold: Minimum user inactivity threshold
656
657 ### Pleroma.Emails.UserEmail
658
659 - `:logo` - a path to a custom logo. Set it to `nil` to use the default Pleroma logo.
660 - `:styling` - a map with color settings for email templates.
661
662 ### Pleroma.Emails.NewUsersDigestEmail
663
664 - `:enabled` - a boolean, enables new users admin digest email when `true`. Defaults to `false`.
665
666 ## Background jobs
667
668 ### Oban
669
670 [Oban](https://github.com/sorentwo/oban) asynchronous job processor configuration.
671
672 Configuration options described in [Oban readme](https://github.com/sorentwo/oban#usage):
673
674 * `repo` - app's Ecto repo (`Pleroma.Repo`)
675 * `log` - logs verbosity
676 * `queues` - job queues (see below)
677 * `crontab` - periodic jobs, see [`Oban.Cron`](#obancron)
678
679 Pleroma has the following queues:
680
681 * `activity_expiration` - Activity expiration
682 * `federator_outgoing` - Outgoing federation
683 * `federator_incoming` - Incoming federation
684 * `mailer` - Email sender, see [`Pleroma.Emails.Mailer`](#pleromaemailsmailer)
685 * `transmogrifier` - Transmogrifier
686 * `web_push` - Web push notifications
687 * `scheduled_activities` - Scheduled activities, see [`Pleroma.ScheduledActivity`](#pleromascheduledactivity)
688
689 #### Oban.Cron
690
691 Pleroma has these periodic job workers:
692
693 `Pleroma.Workers.Cron.ClearOauthTokenWorker` - a job worker to cleanup expired oauth tokens.
694
695 Example:
696
697 ```elixir
698 config :pleroma, Oban,
699 repo: Pleroma.Repo,
700 verbose: false,
701 prune: {:maxlen, 1500},
702 queues: [
703 federator_incoming: 50,
704 federator_outgoing: 50
705 ],
706 crontab: [
707 {"0 0 * * *", Pleroma.Workers.Cron.ClearOauthTokenWorker}
708 ]
709 ```
710
711 This config contains two queues: `federator_incoming` and `federator_outgoing`. Both have the number of max concurrent jobs set to `50`.
712
713 #### Migrating `pleroma_job_queue` settings
714
715 `config :pleroma_job_queue, :queues` is replaced by `config :pleroma, Oban, :queues` and uses the same format (keys are queues' names, values are max concurrent jobs numbers).
716
717 ### :workers
718
719 Includes custom worker options not interpretable directly by `Oban`.
720
721 * `retries` — keyword lists where keys are `Oban` queues (see above) and values are numbers of max attempts for failed jobs.
722
723 Example:
724
725 ```elixir
726 config :pleroma, :workers,
727 retries: [
728 federator_incoming: 5,
729 federator_outgoing: 5
730 ]
731 ```
732
733 #### Migrating `Pleroma.Web.Federator.RetryQueue` settings
734
735 * `max_retries` is replaced with `config :pleroma, :workers, retries: [federator_outgoing: 5]`
736 * `enabled: false` corresponds to `config :pleroma, :workers, retries: [federator_outgoing: 1]`
737 * deprecated options: `max_jobs`, `initial_timeout`
738
739 ## :web_push_encryption, :vapid_details
740
741 Web Push Notifications configuration. You can use the mix task `mix web_push.gen.keypair` to generate it.
742
743 * ``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.
744 * ``public_key``: VAPID public key
745 * ``private_key``: VAPID private key
746
747 ## :logger
748 * `backends`: `:console` is used to send logs to stdout, `{ExSyslogger, :ex_syslogger}` to log to syslog, and `Quack.Logger` to log to Slack
749
750 An example to enable ONLY ExSyslogger (f/ex in ``prod.secret.exs``) with info and debug suppressed:
751 ```elixir
752 config :logger,
753 backends: [{ExSyslogger, :ex_syslogger}]
754
755 config :logger, :ex_syslogger,
756 level: :warn
757 ```
758
759 Another example, keeping console output and adding the pid to syslog output:
760 ```elixir
761 config :logger,
762 backends: [:console, {ExSyslogger, :ex_syslogger}]
763
764 config :logger, :ex_syslogger,
765 level: :warn,
766 option: [:pid, :ndelay]
767 ```
768
769 See: [logger’s documentation](https://hexdocs.pm/logger/Logger.html) and [ex_syslogger’s documentation](https://hexdocs.pm/ex_syslogger/)
770
771 An example of logging info to local syslog, but warn to a Slack channel:
772 ```elixir
773 config :logger,
774 backends: [ {ExSyslogger, :ex_syslogger}, Quack.Logger ],
775 level: :info
776
777 config :logger, :ex_syslogger,
778 level: :info,
779 ident: "pleroma",
780 format: "$metadata[$level] $message"
781
782 config :quack,
783 level: :warn,
784 meta: [:all],
785 webhook_url: "https://hooks.slack.com/services/YOUR-API-KEY-HERE"
786 ```
787
788 See the [Quack Github](https://github.com/azohra/quack) for more details
789
790
791
792 ## Database options
793
794 ### RUM indexing for full text search
795
796 !!! warning
797 It is recommended to use PostgreSQL v11 or newer. We have seen some minor issues with lower PostgreSQL versions.
798
799 * `rum_enabled`: If RUM indexes should be used. Defaults to `false`.
800
801 RUM indexes are an alternative indexing scheme that is not included in PostgreSQL by default. While they may eventually be mainlined, for now they have to be installed as a PostgreSQL extension from https://github.com/postgrespro/rum.
802
803 Their advantage over the standard GIN indexes is that they allow efficient ordering of search results by timestamp, which makes search queries a lot faster on larger servers, by one or two orders of magnitude. They take up around 3 times as much space as GIN indexes.
804
805 To enable them, both the `rum_enabled` flag has to be set and the following special migration has to be run:
806
807 `mix ecto.migrate --migrations-path priv/repo/optional_migrations/rum_indexing/`
808
809 This will probably take a long time.
810
811 ## Alternative client protocols
812
813 ### BBS / SSH access
814
815 To enable simple command line interface accessible over ssh, add a setting like this to your configuration file:
816
817 ```exs
818 app_dir = File.cwd!
819 priv_dir = Path.join([app_dir, "priv/ssh_keys"])
820
821 config :esshd,
822 enabled: true,
823 priv_dir: priv_dir,
824 handler: "Pleroma.BBS.Handler",
825 port: 10_022,
826 password_authenticator: "Pleroma.BBS.Authenticator"
827 ```
828
829 Feel free to adjust the priv_dir and port number. Then you will have to create the key for the keys (in the example `priv/ssh_keys`) and create the host keys with `ssh-keygen -m PEM -N "" -b 2048 -t rsa -f ssh_host_rsa_key`. After restarting, you should be able to connect to your Pleroma instance with `ssh username@server -p $PORT`
830
831 ### :gopher
832 * `enabled`: Enables the gopher interface
833 * `ip`: IP address to bind to
834 * `port`: Port to bind to
835 * `dstport`: Port advertised in urls (optional, defaults to `port`)
836
837
838 ## Authentication
839
840 ### :admin_token
841
842 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 or `x-admin-token` HTTP header. Example:
843
844 ```elixir
845 config :pleroma, :admin_token, "somerandomtoken"
846 ```
847
848 You can then do
849
850 ```shell
851 curl "http://localhost:4000/api/pleroma/admin/users/invites?admin_token=somerandomtoken"
852 ```
853
854 or
855
856 ```shell
857 curl -H "X-Admin-Token: somerandomtoken" "http://localhost:4000/api/pleroma/admin/users/invites"
858 ```
859
860 Warning: it's discouraged to use this feature because of the associated security risk: static / rarely changed instance-wide token is much weaker compared to email-password pair of a real admin user; consider using HTTP Basic Auth or OAuth-based authentication instead.
861
862 ### :auth
863
864 Authentication / authorization settings.
865
866 * `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`.
867 * `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`.
868 * `oauth_consumer_strategies`: the list of enabled OAuth consumer strategies; by default it's set by `OAUTH_CONSUMER_STRATEGIES` environment variable. Each entry in this space-delimited string should be of format `<strategy>` or `<strategy>:<dependency>` (e.g. `twitter` or `keycloak:ueberauth_keycloak_strategy` in case dependency is named differently than `ueberauth_<strategy>`).
869
870 ### Pleroma.Web.Auth.Authenticator
871
872 * `Pleroma.Web.Auth.PleromaAuthenticator`: default database authenticator.
873 * `Pleroma.Web.Auth.LDAPAuthenticator`: LDAP authentication.
874
875 ### :ldap
876
877 Use LDAP for user authentication. When a user logs in to the Pleroma
878 instance, the name and password will be verified by trying to authenticate
879 (bind) to an LDAP server. If a user exists in the LDAP directory but there
880 is no account with the same name yet on the Pleroma instance then a new
881 Pleroma account will be created with the same name as the LDAP user name.
882
883 * `enabled`: enables LDAP authentication
884 * `host`: LDAP server hostname
885 * `port`: LDAP port, e.g. 389 or 636
886 * `ssl`: true to use SSL, usually implies the port 636
887 * `sslopts`: additional SSL options
888 * `tls`: true to start TLS, usually implies the port 389
889 * `tlsopts`: additional TLS options
890 * `base`: LDAP base, e.g. "dc=example,dc=com"
891 * `uid`: LDAP attribute name to authenticate the user, e.g. when "cn", the filter will be "cn=username,base"
892
893 Note, if your LDAP server is an Active Directory server the correct value is commonly `uid: "cn"`, but if you use an
894 OpenLDAP server the value may be `uid: "uid"`.
895
896 ### OAuth consumer mode
897
898 OAuth consumer mode allows sign in / sign up via external OAuth providers (e.g. Twitter, Facebook, Google, Microsoft, etc.).
899 Implementation is based on Ueberauth; see the list of [available strategies](https://github.com/ueberauth/ueberauth/wiki/List-of-Strategies).
900
901 !!! note
902 Each strategy is shipped as a separate dependency; in order to get the strategies, run `OAUTH_CONSUMER_STRATEGIES="..." mix deps.get`, e.g. `OAUTH_CONSUMER_STRATEGIES="twitter facebook google microsoft" mix deps.get`. The server should also be started with `OAUTH_CONSUMER_STRATEGIES="..." mix phx.server` in case you enable any strategies.
903
904 !!! note
905 Each strategy requires separate setup (on external provider side and Pleroma side). Below are the guidelines on setting up most popular strategies.
906
907 !!! note
908 Make sure that `"SameSite=Lax"` is set in `extra_cookie_attrs` when you have this feature enabled. OAuth consumer mode will not work with `"SameSite=Strict"`
909
910 * For Twitter, [register an app](https://developer.twitter.com/en/apps), configure callback URL to https://<your_host>/oauth/twitter/callback
911
912 * 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/
913
914 * For Google, [register an app](https://console.developers.google.com), configure callback URL to https://<your_host>/oauth/google/callback
915
916 * For Microsoft, [register an app](https://portal.azure.com), configure callback URL to https://<your_host>/oauth/microsoft/callback
917
918 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`,
919 per strategy's documentation (e.g. [ueberauth_twitter](https://github.com/ueberauth/ueberauth_twitter)). Example config basing on environment variables:
920
921 ```elixir
922 # Twitter
923 config :ueberauth, Ueberauth.Strategy.Twitter.OAuth,
924 consumer_key: System.get_env("TWITTER_CONSUMER_KEY"),
925 consumer_secret: System.get_env("TWITTER_CONSUMER_SECRET")
926
927 # Facebook
928 config :ueberauth, Ueberauth.Strategy.Facebook.OAuth,
929 client_id: System.get_env("FACEBOOK_APP_ID"),
930 client_secret: System.get_env("FACEBOOK_APP_SECRET"),
931 redirect_uri: System.get_env("FACEBOOK_REDIRECT_URI")
932
933 # Google
934 config :ueberauth, Ueberauth.Strategy.Google.OAuth,
935 client_id: System.get_env("GOOGLE_CLIENT_ID"),
936 client_secret: System.get_env("GOOGLE_CLIENT_SECRET"),
937 redirect_uri: System.get_env("GOOGLE_REDIRECT_URI")
938
939 # Microsoft
940 config :ueberauth, Ueberauth.Strategy.Microsoft.OAuth,
941 client_id: System.get_env("MICROSOFT_CLIENT_ID"),
942 client_secret: System.get_env("MICROSOFT_CLIENT_SECRET")
943
944 config :ueberauth, Ueberauth,
945 providers: [
946 microsoft: {Ueberauth.Strategy.Microsoft, [callback_params: []]}
947 ]
948
949 # Keycloak
950 # Note: make sure to add `keycloak:ueberauth_keycloak_strategy` entry to `OAUTH_CONSUMER_STRATEGIES` environment variable
951 keycloak_url = "https://publicly-reachable-keycloak-instance.org:8080"
952
953 config :ueberauth, Ueberauth.Strategy.Keycloak.OAuth,
954 client_id: System.get_env("KEYCLOAK_CLIENT_ID"),
955 client_secret: System.get_env("KEYCLOAK_CLIENT_SECRET"),
956 site: keycloak_url,
957 authorize_url: "#{keycloak_url}/auth/realms/master/protocol/openid-connect/auth",
958 token_url: "#{keycloak_url}/auth/realms/master/protocol/openid-connect/token",
959 userinfo_url: "#{keycloak_url}/auth/realms/master/protocol/openid-connect/userinfo",
960 token_method: :post
961
962 config :ueberauth, Ueberauth,
963 providers: [
964 keycloak: {Ueberauth.Strategy.Keycloak, [uid_field: :email]}
965 ]
966 ```
967
968 ### OAuth 2.0 provider - :oauth2
969
970 Configure OAuth 2 provider capabilities:
971
972 * `token_expires_in` - The lifetime in seconds of the access token.
973 * `issue_new_refresh_token` - Keeps old refresh token or generate new refresh token when to obtain an access token.
974 * `clean_expired_tokens` - Enable a background job to clean expired oauth tokens. Defaults to `false`. Interval settings sets in configuration periodic jobs [`Oban.Cron`](#obancron)
975
976 ## Link parsing
977
978 ### :uri_schemes
979 * `valid_schemes`: List of the scheme part that is considered valid to be an URL.
980
981 ### Pleroma.Formatter
982
983 Configuration for Pleroma's link formatter which parses mentions, hashtags, and URLs.
984
985 * `class` - specify the class to be added to the generated link (default: `false`)
986 * `rel` - specify the rel attribute (default: `ugc`)
987 * `new_window` - adds `target="_blank"` attribute (default: `false`)
988 * `truncate` - Set to a number to truncate URLs longer then the number. Truncated URLs will end in `...` (default: `false`)
989 * `strip_prefix` - Strip the scheme prefix (default: `false`)
990 * `extra` - link URLs with rarely used schemes (magnet, ipfs, irc, etc.) (default: `true`)
991 * `validate_tld` - Set to false to disable TLD validation for URLs/emails. Can be set to :no_scheme to validate TLDs only for urls without a scheme (e.g `example.com` will be validated, but `http://example.loki` won't) (default: `:no_scheme`)
992
993 Example:
994
995 ```elixir
996 config :pleroma, Pleroma.Formatter,
997 class: false,
998 rel: "ugc",
999 new_window: false,
1000 truncate: false,
1001 strip_prefix: false,
1002 extra: true,
1003 validate_tld: :no_scheme
1004 ```
1005
1006 ## Custom Runtime Modules (`:modules`)
1007
1008 * `runtime_dir`: A path to custom Elixir modules (such as MRF policies).
1009
1010 ## :configurable_from_database
1011
1012 Boolean, enables/disables in-database configuration. Read [Transfering the config to/from the database](../administration/CLI_tasks/config.md) for more information.
1013
1014 ## :database_config_whitelist
1015
1016 List of valid configuration sections which are allowed to be configured from the
1017 database. Settings stored in the database before the whitelist is configured are
1018 still applied, so it is suggested to only use the whitelist on instances that
1019 have not migrated the config to the database.
1020
1021 Example:
1022 ```elixir
1023 config :pleroma, :database_config_whitelist, [
1024 {:pleroma, :instance},
1025 {:pleroma, Pleroma.Web.Metadata},
1026 {:auto_linker}
1027 ]
1028 ```
1029
1030 ### Multi-factor authentication - :two_factor_authentication
1031 * `totp` - a list containing TOTP configuration
1032 - `digits` - Determines the length of a one-time pass-code in characters. Defaults to 6 characters.
1033 - `period` - a period for which the TOTP code will be valid in seconds. Defaults to 30 seconds.
1034 * `backup_codes` - a list containing backup codes configuration
1035 - `number` - number of backup codes to generate.
1036 - `length` - backup code length. Defaults to 16 characters.
1037
1038 ## Restrict entities access for unauthenticated users
1039
1040 ### :restrict_unauthenticated
1041
1042 Restrict access for unauthenticated users to timelines (public and federated), user profiles and statuses.
1043
1044 * `timelines`: public and federated timelines
1045 * `local`: public timeline
1046 * `federated`: federated timeline (includes public timeline)
1047 * `profiles`: user profiles
1048 * `local`
1049 * `remote`
1050 * `activities`: statuses
1051 * `local`
1052 * `remote`
1053
1054 Note: when `:instance, :public` is set to `false`, all `:restrict_unauthenticated` items be effectively set to `true` by default. If you'd like to allow unauthenticated access to specific API endpoints on a private instance, please explicitly set `:restrict_unauthenticated` to non-default value in `config/prod.secret.exs`.
1055
1056 Note: setting `restrict_unauthenticated/timelines/local` to `true` has no practical sense if `restrict_unauthenticated/timelines/federated` is set to `false` (since local public activities will still be delivered to unauthenticated users as part of federated timeline).
1057
1058 ## Pleroma.Web.ApiSpec.CastAndValidate
1059
1060 * `:strict` a boolean, enables strict input validation (useful in development, not recommended in production). Defaults to `false`.
1061
1062 ## :instances_favicons
1063
1064 Control favicons for instances.
1065
1066 * `enabled`: Allow/disallow displaying and getting instances favicons
1067
1068 ## Frontend management
1069
1070 Frontends in Pleroma are swappable - you can specify which one to use here.
1071
1072 For now, you can set a frontend with the key `primary` and the options of `name` and `ref`. This will then make Pleroma serve the frontend from a folder constructed by concatenating the instance static path, `frontends` and the name and ref.
1073
1074 The key `primary` refers to the frontend that will be served by default for general requests. In the future, other frontends like the admin frontend will also be configurable here.
1075
1076 If you don't set anything here, the bundled frontend will be used.
1077
1078 Example:
1079
1080 ```
1081 config :pleroma, :frontends,
1082 primary: %{
1083 "name" => "pleroma",
1084 "ref" => "stable"
1085 }
1086 ```
1087
1088 This would serve the frontend from the the folder at `$instance_static/frontends/pleroma/stable`. You have to copy the frontend into this folder yourself. You can choose the name and ref any way you like, but they will be used by mix tasks to automate installation in the future, the name referring to the project and the ref referring to a commit.