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