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