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