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