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