Merge branch 'develop' into feature/reports-groups-and-multiple-state-update
[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 Pleroma configuration works by first importing the base config (`config/config.exs` on source installs, compiled-in on OTP releases), then overriding it by the environment config (`config/$MIX_ENV.exs` on source installs, N/A to OTP releases) and then overriding it by user config (`config/$MIX_ENV.secret.exs` on source installs, typically `/etc/pleroma/config.exs` on OTP releases).
6
7 You shouldn't edit the base config directly to avoid breakages and merge conflicts, but it can be used as a reference if you don't understand how an option is supposed to be formatted, the latest version of it can be viewed [here](https://git.pleroma.social/pleroma/pleroma/blob/develop/config/config.exs).
8
9
10 ## Pleroma.Upload
11 * `uploader`: Select which `Pleroma.Uploaders` to use
12 * `filters`: List of `Pleroma.Upload.Filter` to use.
13 * `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`
14 * `base_url`: The base URL to access a user-uploaded file. Useful when you want to proxy the media files via another host.
15 * `proxy_remote`: If you're using a remote uploader, Pleroma will proxy media requests instead of redirecting to it.
16 * `proxy_opts`: Proxy options, see `Pleroma.ReverseProxy` documentation.
17
18 !!! warning
19 `strip_exif` has been replaced by `Pleroma.Upload.Filter.Mogrify`.
20
21 ## Pleroma.Uploaders.Local
22 * `uploads`: Which directory to store the user-uploads in, relative to pleroma’s working directory
23
24 ## Pleroma.Uploaders.S3
25 * `bucket`: S3 bucket name
26 * `bucket_namespace`: S3 bucket namespace
27 * `public_endpoint`: S3 endpoint that the user finally accesses(ex. "https://s3.dualstack.ap-northeast-1.amazonaws.com")
28 * `truncated_namespace`: If you use S3 compatible service such as Digital Ocean Spaces or CDN, set folder name or "" etc.
29 For example, when using CDN to S3 virtual host format, set "".
30 At this time, write CNAME to CDN in public_endpoint.
31 * `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.
32
33 ## Pleroma.Upload.Filter.Mogrify
34
35 * `args`: List of actions for the `mogrify` command like `"strip"` or `["strip", "auto-orient", {"implode", "1"}]`.
36
37 ## Pleroma.Upload.Filter.Dedupe
38
39 No specific configuration.
40
41 ## Pleroma.Upload.Filter.AnonymizeFilename
42
43 This filter replaces the filename (not the path) of an upload. For complete obfuscation, add
44 `Pleroma.Upload.Filter.Dedupe` before AnonymizeFilename.
45
46 * `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}`.
47
48 ## Pleroma.Emails.Mailer
49 * `adapter`: one of the mail adapters listed in [Swoosh readme](https://github.com/swoosh/swoosh#adapters), or `Swoosh.Adapters.Local` for in-memory mailbox.
50 * `api_key` / `password` and / or other adapter-specific settings, per the above documentation.
51 * `enabled`: Allows enable/disable send emails. Default: `false`.
52
53 An example for Sendgrid adapter:
54
55 ```elixir
56 config :pleroma, Pleroma.Emails.Mailer,
57 adapter: Swoosh.Adapters.Sendgrid,
58 api_key: "YOUR_API_KEY"
59 ```
60
61 An example for SMTP adapter:
62
63 ```elixir
64 config :pleroma, Pleroma.Emails.Mailer,
65 adapter: Swoosh.Adapters.SMTP,
66 relay: "smtp.gmail.com",
67 username: "YOUR_USERNAME@gmail.com",
68 password: "YOUR_SMTP_PASSWORD",
69 port: 465,
70 ssl: true,
71 tls: :always,
72 auth: :always
73 ```
74
75 ## :uri_schemes
76 * `valid_schemes`: List of the scheme part that is considered valid to be an URL
77
78 ## :instance
79 * `name`: The instance’s name
80 * `email`: Email used to reach an Administrator/Moderator of the instance
81 * `notify_email`: Email used for notifications.
82 * `description`: The instance’s description, can be seen in nodeinfo and ``/api/v1/instance``
83 * `limit`: Posts character limit (CW/Subject included in the counter)
84 * `remote_limit`: Hard character limit beyond which remote posts will be dropped.
85 * `upload_limit`: File size limit of uploads (except for avatar, background, banner)
86 * `avatar_upload_limit`: File size limit of user’s profile avatars
87 * `background_upload_limit`: File size limit of user’s profile backgrounds
88 * `banner_upload_limit`: File size limit of user’s profile banners
89 * `poll_limits`: A map with poll limits for **local** polls
90 * `max_options`: Maximum number of options
91 * `max_option_chars`: Maximum number of characters per option
92 * `min_expiration`: Minimum expiration time (in seconds)
93 * `max_expiration`: Maximum expiration time (in seconds)
94 * `registrations_open`: Enable registrations for anyone, invitations can be enabled when false.
95 * `invites_enabled`: Enable user invitations for admins (depends on `registrations_open: false`).
96 * `account_activation_required`: Require users to confirm their emails before signing in.
97 * `federating`: Enable federation with other instances
98 * `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.
99 * `federation_reachability_timeout_days`: Timeout (in days) of each external federation target being unreachable prior to pausing federating to it.
100 * `allow_relay`: Enable Pleroma’s Relay, which makes it possible to follow a whole instance
101 * `rewrite_policy`: Message Rewrite Policy, either one or a list. Here are the ones available by default:
102 * `Pleroma.Web.ActivityPub.MRF.NoOpPolicy`: Doesn’t modify activities (default)
103 * `Pleroma.Web.ActivityPub.MRF.DropPolicy`: Drops all activities. It generally doesn’t makes sense to use in production
104 * `Pleroma.Web.ActivityPub.MRF.SimplePolicy`: Restrict the visibility of activities from certains instances (See ``:mrf_simple`` section)
105 * `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)
106 * `Pleroma.Web.ActivityPub.MRF.SubchainPolicy`: Selectively runs other MRF policies when messages match (see ``:mrf_subchain`` section)
107 * `Pleroma.Web.ActivityPub.MRF.RejectNonPublic`: Drops posts with non-public visibility settings (See ``:mrf_rejectnonpublic`` section)
108 * `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:.
109 * `Pleroma.Web.ActivityPub.MRF.AntiLinkSpamPolicy`: Rejects posts from likely spambots by rejecting posts from new users that contain links.
110 * `Pleroma.Web.ActivityPub.MRF.MediaProxyWarmingPolicy`: Crawls attachments using their MediaProxy URLs so that the MediaProxy cache is primed.
111 * `Pleroma.Web.ActivityPub.MRF.MentionPolicy`: Drops posts mentioning configurable users. (see `:mrf_mention` section)
112 * `Pleroma.Web.ActivityPub.MRF.VocabularyPolicy`: Restricts activities to a configured set of vocabulary. (see `:mrf_vocabulary` section)
113 * `public`: Makes the client API in authentificated mode-only except for user-profiles. Useful for disabling the Local Timeline and The Whole Known Network.
114 * `quarantined_instances`: List of ActivityPub instances where private(DMs, followers-only) activities will not be send.
115 * `managed_config`: Whenether the config for pleroma-fe is configured in this config or in ``static/config.json``
116 * `allowed_post_formats`: MIME-type list of formats allowed to be posted (transformed into HTML)
117 * `mrf_transparency`: Make the content of your Message Rewrite Facility settings public (via nodeinfo).
118 * `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.
119 * `extended_nickname_format`: Set to `true` to use extended local nicknames format (allows underscores/dashes). This will break federation with
120 older software for theses nicknames.
121 * `max_pinned_statuses`: The maximum number of pinned statuses. `0` will disable the feature.
122 * `autofollowed_nicknames`: Set to nicknames of (local) users that every new user should automatically follow.
123 * `no_attachment_links`: Set to true to disable automatically adding attachment link text to statuses
124 * `welcome_message`: A message that will be send to a newly registered users as a direct message.
125 * `welcome_user_nickname`: The nickname of the local user that sends the welcome message.
126 * `max_report_comment_size`: The maximum size of the report comment (Default: `1000`)
127 * `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`.
128 * `healthcheck`: If set to true, system data will be shown on ``/api/pleroma/healthcheck``.
129 * `remote_post_retention_days`: The default amount of days to retain remote posts when pruning the database.
130 * `user_bio_length`: A user bio maximum length (default: `5000`)
131 * `user_name_length`: A user name maximum length (default: `100`)
132 * `skip_thread_containment`: Skip filter out broken threads. The default is `false`.
133 * `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`.
134 * `max_account_fields`: The maximum number of custom fields in the user profile (default: `10`)
135 * `max_remote_account_fields`: The maximum number of custom fields in the remote user profile (default: `20`)
136 * `account_field_name_length`: An account field name maximum length (default: `512`)
137 * `account_field_value_length`: An account field value maximum length (default: `2048`)
138 * `external_user_synchronization`: Enabling following/followers counters synchronization for external users.
139
140 !!! danger
141 This is a Work In Progress, not usable just yet
142
143 * `dynamic_configuration`: Allow transferring configuration to DB with the subsequent customization from Admin api.
144
145
146
147 ## :logger
148 * `backends`: `:console` is used to send logs to stdout, `{ExSyslogger, :ex_syslogger}` to log to syslog, and `Quack.Logger` to log to Slack
149
150 An example to enable ONLY ExSyslogger (f/ex in ``prod.secret.exs``) with info and debug suppressed:
151 ```elixir
152 config :logger,
153 backends: [{ExSyslogger, :ex_syslogger}]
154
155 config :logger, :ex_syslogger,
156 level: :warn
157 ```
158
159 Another example, keeping console output and adding the pid to syslog output:
160 ```elixir
161 config :logger,
162 backends: [:console, {ExSyslogger, :ex_syslogger}]
163
164 config :logger, :ex_syslogger,
165 level: :warn,
166 option: [:pid, :ndelay]
167 ```
168
169 See: [logger’s documentation](https://hexdocs.pm/logger/Logger.html) and [ex_syslogger’s documentation](https://hexdocs.pm/ex_syslogger/)
170
171 An example of logging info to local syslog, but warn to a Slack channel:
172 ```elixir
173 config :logger,
174 backends: [ {ExSyslogger, :ex_syslogger}, Quack.Logger ],
175 level: :info
176
177 config :logger, :ex_syslogger,
178 level: :info,
179 ident: "pleroma",
180 format: "$metadata[$level] $message"
181
182 config :quack,
183 level: :warn,
184 meta: [:all],
185 webhook_url: "https://hooks.slack.com/services/YOUR-API-KEY-HERE"
186 ```
187
188 See the [Quack Github](https://github.com/azohra/quack) for more details
189
190 ## :frontend_configurations
191
192 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).
193
194 Frontends can access these settings at `/api/pleroma/frontend_configurations`
195
196 To add your own configuration for PleromaFE, use it like this:
197
198 ```elixir
199 config :pleroma, :frontend_configurations,
200 pleroma_fe: %{
201 theme: "pleroma-dark",
202 # ... see /priv/static/static/config.json for the available keys.
203 },
204 masto_fe: %{
205 showInstanceSpecificPanel: true
206 }
207 ```
208
209 These settings **need to be complete**, they will override the defaults.
210
211 NOTE: for versions < 1.0, you need to set [`:fe`](#fe) to false, as shown a few lines below.
212
213 ## :fe
214 !!! warning
215 __THIS IS DEPRECATED__
216
217 If you are using this method, please change it to the [`frontend_configurations`](#frontend_configurations) method.
218 Please **set this option to false** in your config like this:
219
220 ```elixir
221 config :pleroma, :fe, false
222 ```
223
224 This section is used to configure Pleroma-FE, unless ``:managed_config`` in ``:instance`` is set to false.
225
226 * `theme`: Which theme to use, they are defined in ``styles.json``
227 * `logo`: URL of the logo, defaults to Pleroma’s logo
228 * `logo_mask`: Whether to use only the logo's shape as a mask (true) or as a regular image (false)
229 * `logo_margin`: What margin to use around the logo
230 * `background`: URL of the background, unless viewing a user profile with a background that is set
231 * `redirect_root_no_login`: relative URL which indicates where to redirect when a user isn’t logged in.
232 * `redirect_root_login`: relative URL which indicates where to redirect when a user is logged in.
233 * `show_instance_panel`: Whenether to show the instance’s specific panel.
234 * `scope_options_enabled`: Enable setting an notice visibility and subject/CW when posting
235 * `formatting_options_enabled`: Enable setting a formatting different than plain-text (ie. HTML, Markdown) when posting, relates to ``:instance, allowed_post_formats``
236 * `collapse_message_with_subjects`: When a message has a subject(aka Content Warning), collapse it by default
237 * `hide_post_stats`: Hide notices statistics(repeats, favorites, …)
238 * `hide_user_stats`: Hide profile statistics(posts, posts per day, followers, followings, …)
239
240 ## :assets
241
242 This section configures assets to be used with various frontends. Currently the only option
243 relates to mascots on the mastodon frontend
244
245 * `mascots`: KeywordList of mascots, each element __MUST__ contain both a `url` and a
246 `mime_type` key.
247 * `default_mascot`: An element from `mascots` - This will be used as the default mascot
248 on MastoFE (default: `:pleroma_fox_tan`)
249
250 ## :manifest
251
252 This section describe PWA manifest instance-specific values. Currently this option relate only for MastoFE.
253
254 * `icons`: Describe the icons of the app, this a list of maps describing icons in the same way as the
255 [spec](https://www.w3.org/TR/appmanifest/#imageresource-and-its-members) describes it.
256
257 Example:
258
259 ```elixir
260 config :pleroma, :manifest,
261 icons: [
262 %{
263 src: "/static/logo.png"
264 },
265 %{
266 src: "/static/icon.png",
267 type: "image/png"
268 },
269 %{
270 src: "/static/icon.ico",
271 sizes: "72x72 96x96 128x128 256x256"
272 }
273 ]
274 ```
275
276 * `theme_color`: Describe the theme color of the app. (Example: `"#282c37"`, `"rebeccapurple"`)
277 * `background_color`: Describe the background color of the app. (Example: `"#191b22"`, `"aliceblue"`)
278
279 ## :mrf_simple
280 * `media_removal`: List of instances to remove medias from
281 * `media_nsfw`: List of instances to put medias as NSFW(sensitive) from
282 * `federated_timeline_removal`: List of instances to remove from Federated (aka The Whole Known Network) Timeline
283 * `reject`: List of instances to reject any activities from
284 * `accept`: List of instances to accept any activities from
285 * `report_removal`: List of instances to reject reports from
286 * `avatar_removal`: List of instances to strip avatars from
287 * `banner_removal`: List of instances to strip banners from
288
289 ## :mrf_subchain
290 This policy processes messages through an alternate pipeline when a given message matches certain criteria.
291 All criteria are configured as a map of regular expressions to lists of policy modules.
292
293 * `match_actor`: Matches a series of regular expressions against the actor field.
294
295 Example:
296
297 ```elixir
298 config :pleroma, :mrf_subchain,
299 match_actor: %{
300 ~r/https:\/\/example.com/s => [Pleroma.Web.ActivityPub.MRF.DropPolicy]
301 }
302 ```
303
304 ## :mrf_rejectnonpublic
305 * `allow_followersonly`: whether to allow followers-only posts
306 * `allow_direct`: whether to allow direct messages
307
308 ## :mrf_hellthread
309 * `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.
310 * `reject_threshold`: Number of mentioned users after which the messaged gets rejected. Set to 0 to disable.
311
312 ## :mrf_keyword
313 * `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)
314 * `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)
315 * `replace`: A list of tuples containing `{pattern, replacement}`, `pattern` can be a string or a [regular expression](https://hexdocs.pm/elixir/Regex.html)
316
317 ## :mrf_mention
318 * `actors`: A list of actors, for which to drop any posts mentioning.
319
320 ## :mrf_vocabulary
321 * `accept`: A list of ActivityStreams terms to accept. If empty, all supported messages are accepted.
322 * `reject`: A list of ActivityStreams terms to reject. If empty, no messages are rejected.
323
324 ## :media_proxy
325 * `enabled`: Enables proxying of remote media to the instance’s proxy
326 * `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.
327 * `proxy_opts`: All options defined in `Pleroma.ReverseProxy` documentation, defaults to `[max_body_length: (25*1_048_576)]`.
328 * `whitelist`: List of domains to bypass the mediaproxy
329
330 ## :gopher
331 * `enabled`: Enables the gopher interface
332 * `ip`: IP address to bind to
333 * `port`: Port to bind to
334 * `dstport`: Port advertised in urls (optional, defaults to `port`)
335
336 ## Pleroma.Web.Endpoint
337
338 !!! note
339 `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.
340
341 * `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).
342 - `ip` - a tuple consisting of 4 integers
343 - `port`
344 * `url` - a list containing the configuration for generating urls, accepts
345 - `host` - the host without the scheme and a post (e.g `example.com`, not `https://example.com:2020`)
346 - `scheme` - e.g `http`, `https`
347 - `port`
348 - `path`
349 * `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.
350
351
352
353 !!! warning
354 If you modify anything inside these lists, default `config.exs` values will be overwritten, which may result in breakage, to make sure this does not happen please copy the default value for the list from `config.exs` and modify/add only what you need
355
356 Example:
357 ```elixir
358 config :pleroma, Pleroma.Web.Endpoint,
359 url: [host: "example.com", port: 2020, scheme: "https"],
360 http: [
361 # start copied from config.exs
362 dispatch: [
363 {:_,
364 [
365 {"/api/v1/streaming", Pleroma.Web.MastodonAPI.WebsocketHandler, []},
366 {"/websocket", Phoenix.Endpoint.CowboyWebSocket,
367 {Phoenix.Transports.WebSocket,
368 {Pleroma.Web.Endpoint, Pleroma.Web.UserSocket, websocket_config}}},
369 {:_, Phoenix.Endpoint.Cowboy2Handler, {Pleroma.Web.Endpoint, []}}
370 ]}
371 # end copied from config.exs
372 ],
373 port: 8080,
374 ip: {127, 0, 0, 1}
375 ]
376 ```
377
378 This will make Pleroma listen on `127.0.0.1` port `8080` and generate urls starting with `https://example.com:2020`
379
380 ## :activitypub
381 * ``unfollow_blocked``: Whether blocks result in people getting unfollowed
382 * ``outgoing_blocks``: Whether to federate blocks to other instances
383 * ``deny_follow_blocked``: Whether to disallow following an account that has blocked the user in question
384 * ``sign_object_fetches``: Sign object fetches with HTTP signatures
385
386 ## :http_security
387 * ``enabled``: Whether the managed content security policy is enabled
388 * ``sts``: Whether to additionally send a `Strict-Transport-Security` header
389 * ``sts_max_age``: The maximum age for the `Strict-Transport-Security` header if sent
390 * ``ct_max_age``: The maximum age for the `Expect-CT` header if sent
391 * ``referrer_policy``: The referrer policy to use, either `"same-origin"` or `"no-referrer"`
392 * ``report_uri``: Adds the specified url to `report-uri` and `report-to` group in CSP header.
393
394 ## :mrf_user_allowlist
395
396 The keys in this section are the domain names that the policy should apply to.
397 Each key should be assigned a list of users that should be allowed through by
398 their ActivityPub ID.
399
400 An example:
401
402 ```elixir
403 config :pleroma, :mrf_user_allowlist,
404 "example.org": ["https://example.org/users/admin"]
405 ```
406
407 ## :web_push_encryption, :vapid_details
408
409 Web Push Notifications configuration. You can use the mix task `mix web_push.gen.keypair` to generate it.
410
411 * ``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.
412 * ``public_key``: VAPID public key
413 * ``private_key``: VAPID private key
414
415 ## Pleroma.Captcha
416 * `enabled`: Whether the captcha should be shown on registration
417 * `method`: The method/service to use for captcha
418 * `seconds_valid`: The time in seconds for which the captcha is valid
419
420 ### Pleroma.Captcha.Kocaptcha
421 Kocaptcha is a very simple captcha service with a single API endpoint,
422 the source code is here: https://github.com/koto-bank/kocaptcha. The default endpoint
423 `https://captcha.kotobank.ch` is hosted by the developer.
424
425 * `endpoint`: the kocaptcha endpoint to use
426
427 ## :admin_token
428
429 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. Example:
430
431 ```elixir
432 config :pleroma, :admin_token, "somerandomtoken"
433 ```
434
435 You can then do
436
437 ```sh
438 curl "http://localhost:4000/api/pleroma/admin/invite_token?admin_token=somerandomtoken"
439 ```
440
441 ## Oban
442
443 [Oban](https://github.com/sorentwo/oban) asynchronous job processor configuration.
444
445 Configuration options described in [Oban readme](https://github.com/sorentwo/oban#usage):
446 * `repo` - app's Ecto repo (`Pleroma.Repo`)
447 * `verbose` - logs verbosity
448 * `prune` - non-retryable jobs [pruning settings](https://github.com/sorentwo/oban#pruning) (`:disabled` / `{:maxlen, value}` / `{:maxage, value}`)
449 * `queues` - job queues (see below)
450
451 Pleroma has the following queues:
452
453 * `activity_expiration` - Activity expiration
454 * `federator_outgoing` - Outgoing federation
455 * `federator_incoming` - Incoming federation
456 * `mailer` - Email sender, see [`Pleroma.Emails.Mailer`](#pleromaemailsmailer)
457 * `transmogrifier` - Transmogrifier
458 * `web_push` - Web push notifications
459 * `scheduled_activities` - Scheduled activities, see [`Pleroma.ScheduledActivity`](#pleromascheduledactivity)
460
461 Example:
462
463 ```elixir
464 config :pleroma, Oban,
465 repo: Pleroma.Repo,
466 verbose: false,
467 prune: {:maxlen, 1500},
468 queues: [
469 federator_incoming: 50,
470 federator_outgoing: 50
471 ]
472 ```
473
474 This config contains two queues: `federator_incoming` and `federator_outgoing`. Both have the number of max concurrent jobs set to `50`.
475
476 ### Migrating `pleroma_job_queue` settings
477
478 `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).
479
480 ## :workers
481
482 Includes custom worker options not interpretable directly by `Oban`.
483
484 * `retries` — keyword lists where keys are `Oban` queues (see above) and values are numbers of max attempts for failed jobs.
485
486 Example:
487
488 ```elixir
489 config :pleroma, :workers,
490 retries: [
491 federator_incoming: 5,
492 federator_outgoing: 5
493 ]
494 ```
495
496 ### Migrating `Pleroma.Web.Federator.RetryQueue` settings
497
498 * `max_retries` is replaced with `config :pleroma, :workers, retries: [federator_outgoing: 5]`
499 * `enabled: false` corresponds to `config :pleroma, :workers, retries: [federator_outgoing: 1]`
500 * deprecated options: `max_jobs`, `initial_timeout`
501
502 ## Pleroma.Web.Metadata
503 * `providers`: a list of metadata providers to enable. Providers available:
504 * Pleroma.Web.Metadata.Providers.OpenGraph
505 * Pleroma.Web.Metadata.Providers.TwitterCard
506 * Pleroma.Web.Metadata.Providers.RelMe - add links from user bio with rel=me into the `<header>` as `<link rel=me>`
507 * Pleroma.Web.Metadata.Providers.Feed - add a link to a user's Atom feed into the `<header>` as `<link rel=alternate>`
508 * `unfurl_nsfw`: If set to `true` nsfw attachments will be shown in previews
509
510 ## :rich_media
511 * `enabled`: if enabled the instance will parse metadata from attached links to generate link previews
512 * `ignore_hosts`: list of hosts which will be ignored by the metadata parser. For example `["accounts.google.com", "xss.website"]`, defaults to `[]`.
513 * `ignore_tld`: list TLDs (top-level domains) which will ignore for parse metadata. default is ["local", "localdomain", "lan"]
514 * `parsers`: list of Rich Media parsers
515
516 ## :fetch_initial_posts
517 * `enabled`: if enabled, when a new user is federated with, fetch some of their latest posts
518 * `pages`: the amount of pages to fetch
519
520 ## :hackney_pools
521
522 Advanced. Tweaks Hackney (http client) connections pools.
523
524 There's three pools used:
525
526 * `:federation` for the federation jobs.
527 You may want this pool max_connections to be at least equal to the number of federator jobs + retry queue jobs.
528 * `:media` for rich media, media proxy
529 * `:upload` for uploaded media (if using a remote uploader and `proxy_remote: true`)
530
531 For each pool, the options are:
532
533 * `max_connections` - how much connections a pool can hold
534 * `timeout` - retention duration for connections
535
536 ## :auto_linker
537
538 Configuration for the `auto_linker` library:
539
540 * `class: "auto-linker"` - specify the class to be added to the generated link. false to clear
541 * `rel: "noopener noreferrer"` - override the rel attribute. false to clear
542 * `new_window: true` - set to false to remove `target='_blank'` attribute
543 * `scheme: false` - Set to true to link urls with schema `http://google.com`
544 * `truncate: false` - Set to a number to truncate urls longer then the number. Truncated urls will end in `..`
545 * `strip_prefix: true` - Strip the scheme prefix
546 * `extra: false` - link urls with rarely used schemes (magnet, ipfs, irc, etc.)
547
548 Example:
549
550 ```elixir
551 config :auto_linker,
552 opts: [
553 scheme: true,
554 extra: true,
555 class: false,
556 strip_prefix: false,
557 new_window: false,
558 rel: "ugc"
559 ]
560 ```
561
562 ## Pleroma.Scheduler
563
564 Configuration for [Quantum](https://github.com/quantum-elixir/quantum-core) jobs scheduler.
565
566 See [Quantum readme](https://github.com/quantum-elixir/quantum-core#usage) for the list of supported options.
567
568 Example:
569
570 ```elixir
571 config :pleroma, Pleroma.Scheduler,
572 global: true,
573 overlap: true,
574 timezone: :utc,
575 jobs: [{"0 */6 * * * *", {Pleroma.Web.Websub, :refresh_subscriptions, []}}]
576 ```
577
578 The above example defines a single job which invokes `Pleroma.Web.Websub.refresh_subscriptions()` every 6 hours ("0 */6 * * * *", [crontab format](https://en.wikipedia.org/wiki/Cron)).
579
580 ## Pleroma.ScheduledActivity
581
582 * `daily_user_limit`: the number of scheduled activities a user is allowed to create in a single day (Default: `25`)
583 * `total_user_limit`: the number of scheduled activities a user is allowed to create in total (Default: `300`)
584 * `enabled`: whether scheduled activities are sent to the job queue to be executed
585
586 ## Pleroma.ActivityExpiration
587
588 * `enabled`: whether expired activities will be sent to the job queue to be deleted
589
590 ## Pleroma.Web.Auth.Authenticator
591
592 * `Pleroma.Web.Auth.PleromaAuthenticator`: default database authenticator
593 * `Pleroma.Web.Auth.LDAPAuthenticator`: LDAP authentication
594
595 ## :ldap
596
597 Use LDAP for user authentication. When a user logs in to the Pleroma
598 instance, the name and password will be verified by trying to authenticate
599 (bind) to an LDAP server. If a user exists in the LDAP directory but there
600 is no account with the same name yet on the Pleroma instance then a new
601 Pleroma account will be created with the same name as the LDAP user name.
602
603 * `enabled`: enables LDAP authentication
604 * `host`: LDAP server hostname
605 * `port`: LDAP port, e.g. 389 or 636
606 * `ssl`: true to use SSL, usually implies the port 636
607 * `sslopts`: additional SSL options
608 * `tls`: true to start TLS, usually implies the port 389
609 * `tlsopts`: additional TLS options
610 * `base`: LDAP base, e.g. "dc=example,dc=com"
611 * `uid`: LDAP attribute name to authenticate the user, e.g. when "cn", the filter will be "cn=username,base"
612
613 ## BBS / SSH access
614
615 To enable simple command line interface accessible over ssh, add a setting like this to your configuration file:
616
617 ```exs
618 app_dir = File.cwd!
619 priv_dir = Path.join([app_dir, "priv/ssh_keys"])
620
621 config :esshd,
622 enabled: true,
623 priv_dir: priv_dir,
624 handler: "Pleroma.BBS.Handler",
625 port: 10_022,
626 password_authenticator: "Pleroma.BBS.Authenticator"
627 ```
628
629 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`
630
631 ## :auth
632
633 * `Pleroma.Web.Auth.PleromaAuthenticator`: default database authenticator
634 * `Pleroma.Web.Auth.LDAPAuthenticator`: LDAP authentication
635
636 Authentication / authorization settings.
637
638 * `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`.
639 * `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`.
640 * `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>`).
641
642 ## :email_notifications
643
644 Email notifications settings.
645
646 - digest - emails of "what you've missed" for users who have been
647 inactive for a while.
648 - active: globally enable or disable digest emails
649 - schedule: When to send digest email, in [crontab format](https://en.wikipedia.org/wiki/Cron).
650 "0 0 * * 0" is the default, meaning "once a week at midnight on Sunday morning"
651 - interval: Minimum interval between digest emails to one user
652 - inactivity_threshold: Minimum user inactivity threshold
653
654 ## Pleroma.Emails.UserEmail
655
656 - `:logo` - a path to a custom logo. Set it to `nil` to use the default Pleroma logo.
657 - `:styling` - a map with color settings for email templates.
658
659 ## OAuth consumer mode
660
661 OAuth consumer mode allows sign in / sign up via external OAuth providers (e.g. Twitter, Facebook, Google, Microsoft, etc.).
662 Implementation is based on Ueberauth; see the list of [available strategies](https://github.com/ueberauth/ueberauth/wiki/List-of-Strategies).
663
664 !!! note
665 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.
666
667 !!! note
668 Each strategy requires separate setup (on external provider side and Pleroma side). Below are the guidelines on setting up most popular strategies.
669
670 !!! note
671 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"`
672
673 * For Twitter, [register an app](https://developer.twitter.com/en/apps), configure callback URL to https://<your_host>/oauth/twitter/callback
674
675 * 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/
676
677 * For Google, [register an app](https://console.developers.google.com), configure callback URL to https://<your_host>/oauth/google/callback
678
679 * For Microsoft, [register an app](https://portal.azure.com), configure callback URL to https://<your_host>/oauth/microsoft/callback
680
681 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`,
682 per strategy's documentation (e.g. [ueberauth_twitter](https://github.com/ueberauth/ueberauth_twitter)). Example config basing on environment variables:
683
684 ```elixir
685 # Twitter
686 config :ueberauth, Ueberauth.Strategy.Twitter.OAuth,
687 consumer_key: System.get_env("TWITTER_CONSUMER_KEY"),
688 consumer_secret: System.get_env("TWITTER_CONSUMER_SECRET")
689
690 # Facebook
691 config :ueberauth, Ueberauth.Strategy.Facebook.OAuth,
692 client_id: System.get_env("FACEBOOK_APP_ID"),
693 client_secret: System.get_env("FACEBOOK_APP_SECRET"),
694 redirect_uri: System.get_env("FACEBOOK_REDIRECT_URI")
695
696 # Google
697 config :ueberauth, Ueberauth.Strategy.Google.OAuth,
698 client_id: System.get_env("GOOGLE_CLIENT_ID"),
699 client_secret: System.get_env("GOOGLE_CLIENT_SECRET"),
700 redirect_uri: System.get_env("GOOGLE_REDIRECT_URI")
701
702 # Microsoft
703 config :ueberauth, Ueberauth.Strategy.Microsoft.OAuth,
704 client_id: System.get_env("MICROSOFT_CLIENT_ID"),
705 client_secret: System.get_env("MICROSOFT_CLIENT_SECRET")
706
707 config :ueberauth, Ueberauth,
708 providers: [
709 microsoft: {Ueberauth.Strategy.Microsoft, [callback_params: []]}
710 ]
711
712 # Keycloak
713 # Note: make sure to add `keycloak:ueberauth_keycloak_strategy` entry to `OAUTH_CONSUMER_STRATEGIES` environment variable
714 keycloak_url = "https://publicly-reachable-keycloak-instance.org:8080"
715
716 config :ueberauth, Ueberauth.Strategy.Keycloak.OAuth,
717 client_id: System.get_env("KEYCLOAK_CLIENT_ID"),
718 client_secret: System.get_env("KEYCLOAK_CLIENT_SECRET"),
719 site: keycloak_url,
720 authorize_url: "#{keycloak_url}/auth/realms/master/protocol/openid-connect/auth",
721 token_url: "#{keycloak_url}/auth/realms/master/protocol/openid-connect/token",
722 userinfo_url: "#{keycloak_url}/auth/realms/master/protocol/openid-connect/userinfo",
723 token_method: :post
724
725 config :ueberauth, Ueberauth,
726 providers: [
727 keycloak: {Ueberauth.Strategy.Keycloak, [uid_field: :email]}
728 ]
729 ```
730
731 ## OAuth 2.0 provider - :oauth2
732
733 Configure OAuth 2 provider capabilities:
734
735 * `token_expires_in` - The lifetime in seconds of the access token.
736 * `issue_new_refresh_token` - Keeps old refresh token or generate new refresh token when to obtain an access token.
737 * `clean_expired_tokens` - Enable a background job to clean expired oauth tokens. Defaults to `false`.
738 * `clean_expired_tokens_interval` - Interval to run the job to clean expired tokens. Defaults to `86_400_000` (24 hours).
739
740 ## :emoji
741 * `shortcode_globs`: Location of custom emoji files. `*` can be used as a wildcard. Example `["/emoji/custom/**/*.png"]`
742 * `pack_extensions`: A list of file extensions for emojis, when no emoji.txt for a pack is present. Example `[".png", ".gif"]`
743 * `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"]]`
744 * `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).
745 * `shared_pack_cache_seconds_per_file`: When an emoji pack is shared, the archive is created and cached in
746 memory for this amount of seconds multiplied by the number of files.
747
748 ## Database options
749
750 ### RUM indexing for full text search
751 * `rum_enabled`: If RUM indexes should be used. Defaults to `false`.
752
753 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.
754
755 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.
756
757 To enable them, both the `rum_enabled` flag has to be set and the following special migration has to be run:
758
759 `mix ecto.migrate --migrations-path priv/repo/optional_migrations/rum_indexing/`
760
761 This will probably take a long time.
762
763 ## :rate_limit
764
765 This is an advanced feature and disabled by default.
766
767 If your instance is behind a reverse proxy you must enable and configure [`Pleroma.Plugs.RemoteIp`](#pleroma-plugs-remoteip).
768
769 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:
770
771 * The first element: `scale` (Integer). The time scale in milliseconds.
772 * The second element: `limit` (Integer). How many requests to limit in the time scale provided.
773
774 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.
775
776 Supported rate limiters:
777
778 * `:search` for the search requests (account & status search etc.)
779 * `:app_account_creation` for registering user accounts from the same IP address
780 * `:relations_actions` for actions on relations with all users (follow, unfollow)
781 * `:relation_id_action` for actions on relation with a specific user (follow, unfollow)
782 * `:statuses_actions` for create / delete / fav / unfav / reblog / unreblog actions on any statuses
783 * `:status_id_action` for fav / unfav or reblog / unreblog actions on the same status by the same user
784
785 ## :web_cache_ttl
786
787 The expiration time for the web responses cache. Values should be in milliseconds or `nil` to disable expiration.
788
789 Available caches:
790
791 * `:activity_pub` - activity pub routes (except question activities). Defaults to `nil` (no expiration).
792 * `:activity_pub_question` - activity pub routes (question activities). Defaults to `30_000` (30 seconds).
793
794 ## Pleroma.Plugs.RemoteIp
795
796 !!! warning
797 If your instance is not behind at least one reverse proxy, you should not enable this plug.
798
799 `Pleroma.Plugs.RemoteIp` is a shim to call [`RemoteIp`](https://git.pleroma.social/pleroma/remote_ip) but with runtime configuration.
800
801 Available options:
802
803 * `enabled` - Enable/disable the plug. Defaults to `false`.
804 * `headers` - A list of strings naming the `req_headers` to use when deriving the `remote_ip`. Order does not matter. Defaults to `~w[forwarded x-forwarded-for x-client-ip x-real-ip]`.
805 * `proxies` - A list of strings in [CIDR](https://en.wikipedia.org/wiki/CIDR) notation specifying the IPs of known proxies. Defaults to `[]`.
806 * `reserved` - Defaults to [localhost](https://en.wikipedia.org/wiki/Localhost) and [private network](https://en.wikipedia.org/wiki/Private_network).