1 # Configuration Cheat Sheet
3 This is a cheat sheet for Pleroma configuration file, any setting possible to configure should be listed here.
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).
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).
10 * `name`: The instance’s name.
11 * `email`: Email used to reach an Administrator/Moderator of the instance.
12 * `notify_email`: Email used for notifications.
13 * `description`: The instance’s description, can be seen in nodeinfo and ``/api/v1/instance``.
14 * `limit`: Posts character limit (CW/Subject included in the counter).
15 * `remote_limit`: Hard character limit beyond which remote posts will be dropped.
16 * `upload_limit`: File size limit of uploads (except for avatar, background, banner).
17 * `avatar_upload_limit`: File size limit of user’s profile avatars.
18 * `background_upload_limit`: File size limit of user’s profile backgrounds.
19 * `banner_upload_limit`: File size limit of user’s profile banners.
20 * `poll_limits`: A map with poll limits for **local** polls.
21 * `max_options`: Maximum number of options.
22 * `max_option_chars`: Maximum number of characters per option.
23 * `min_expiration`: Minimum expiration time (in seconds).
24 * `max_expiration`: Maximum expiration time (in seconds).
25 * `registrations_open`: Enable registrations for anyone, invitations can be enabled when false.
26 * `invites_enabled`: Enable user invitations for admins (depends on `registrations_open: false`).
27 * `account_activation_required`: Require users to confirm their emails before signing in.
28 * `federating`: Enable federation with other instances.
29 * `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.
30 * `federation_reachability_timeout_days`: Timeout (in days) of each external federation target being unreachable prior to pausing federating to it.
31 * `allow_relay`: Enable Pleroma’s Relay, which makes it possible to follow a whole instance.
32 * `rewrite_policy`: Message Rewrite Policy, either one or a list. Here are the ones available by default:
33 * `Pleroma.Web.ActivityPub.MRF.NoOpPolicy`: Doesn’t modify activities (default).
34 * `Pleroma.Web.ActivityPub.MRF.DropPolicy`: Drops all activities. It generally doesn’t makes sense to use in production.
35 * `Pleroma.Web.ActivityPub.MRF.SimplePolicy`: Restrict the visibility of activities from certains instances (See [`:mrf_simple`](#mrf_simple)).
36 * `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).
37 * `Pleroma.Web.ActivityPub.MRF.SubchainPolicy`: Selectively runs other MRF policies when messages match (See [`:mrf_subchain`](#mrf_subchain)).
38 * `Pleroma.Web.ActivityPub.MRF.RejectNonPublic`: Drops posts with non-public visibility settings (See [`:mrf_rejectnonpublic`](#mrf_rejectnonpublic)).
39 * `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:.
40 * `Pleroma.Web.ActivityPub.MRF.AntiLinkSpamPolicy`: Rejects posts from likely spambots by rejecting posts from new users that contain links.
41 * `Pleroma.Web.ActivityPub.MRF.MediaProxyWarmingPolicy`: Crawls attachments using their MediaProxy URLs so that the MediaProxy cache is primed.
42 * `Pleroma.Web.ActivityPub.MRF.MentionPolicy`: Drops posts mentioning configurable users. (See [`:mrf_mention`](#mrf_mention)).
43 * `Pleroma.Web.ActivityPub.MRF.VocabularyPolicy`: Restricts activities to a configured set of vocabulary. (See [`:mrf_vocabulary`](#mrf_vocabulary)).
44 * `Pleroma.Web.ActivityPub.MRF.ObjectAgePolicy`: Rejects or delists posts based on their age when received. (See [`:mrf_object_age`](#mrf_object_age)).
45 * `public`: Makes the client API in authentificated mode-only except for user-profiles. Useful for disabling the Local Timeline and The Whole Known Network.
46 * `quarantined_instances`: List of ActivityPub instances where private(DMs, followers-only) activities will not be send.
47 * `managed_config`: Whenether the config for pleroma-fe is configured in [:frontend_configurations](#frontend_configurations) or in ``static/config.json``.
48 * `allowed_post_formats`: MIME-type list of formats allowed to be posted (transformed into HTML).
49 * `mrf_transparency`: Make the content of your Message Rewrite Facility settings public (via nodeinfo).
50 * `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.
51 * `extended_nickname_format`: Set to `true` to use extended local nicknames format (allows underscores/dashes). This will break federation with
52 older software for theses nicknames.
53 * `max_pinned_statuses`: The maximum number of pinned statuses. `0` will disable the feature.
54 * `autofollowed_nicknames`: Set to nicknames of (local) users that every new user should automatically follow.
55 * `no_attachment_links`: Set to true to disable automatically adding attachment link text to statuses.
56 * `welcome_message`: A message that will be send to a newly registered users as a direct message.
57 * `welcome_user_nickname`: The nickname of the local user that sends the welcome message.
58 * `max_report_comment_size`: The maximum size of the report comment (Default: `1000`).
59 * `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`.
60 * `healthcheck`: If set to true, system data will be shown on ``/api/pleroma/healthcheck``.
61 * `remote_post_retention_days`: The default amount of days to retain remote posts when pruning the database.
62 * `user_bio_length`: A user bio maximum length (default: `5000`).
63 * `user_name_length`: A user name maximum length (default: `100`).
64 * `skip_thread_containment`: Skip filter out broken threads. The default is `false`.
65 * `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`.
66 * `max_account_fields`: The maximum number of custom fields in the user profile (default: `10`).
67 * `max_remote_account_fields`: The maximum number of custom fields in the remote user profile (default: `20`).
68 * `account_field_name_length`: An account field name maximum length (default: `512`).
69 * `account_field_value_length`: An account field value maximum length (default: `2048`).
70 * `external_user_synchronization`: Enabling following/followers counters synchronization for external users.
73 This is a Work In Progress, not usable just yet
75 * `dynamic_configuration`: Allow transferring configuration to DB with the subsequent customization from Admin api.
79 * `proxy_url`: an upstream proxy to fetch posts and/or media with, (default: `nil`)
80 * `send_user_agent`: should we include a user agent with HTTP requests? (default: `true`)
81 * `user_agent`: what user agent should we use? (default: `:default`), must be string or `:default`
82 * `adapter`: array of hackney options
88 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.
91 * `media_removal`: List of instances to remove media from.
92 * `media_nsfw`: List of instances to put media as NSFW(sensitive) from.
93 * `federated_timeline_removal`: List of instances to remove from Federated (aka The Whole Known Network) Timeline.
94 * `reject`: List of instances to reject any activities from.
95 * `accept`: List of instances to accept any activities from.
96 * `report_removal`: List of instances to reject reports from.
97 * `avatar_removal`: List of instances to strip avatars from.
98 * `banner_removal`: List of instances to strip banners from.
101 This policy processes messages through an alternate pipeline when a given message matches certain criteria.
102 All criteria are configured as a map of regular expressions to lists of policy modules.
104 * `match_actor`: Matches a series of regular expressions against the actor field.
109 config :pleroma, :mrf_subchain,
111 ~r/https:\/\/example.com/s => [Pleroma.Web.ActivityPub.MRF.DropPolicy]
115 #### :mrf_rejectnonpublic
116 * `allow_followersonly`: whether to allow followers-only posts.
117 * `allow_direct`: whether to allow direct messages.
120 * `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.
121 * `reject_threshold`: Number of mentioned users after which the messaged gets rejected. Set to 0 to disable.
124 * `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).
125 * `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).
126 * `replace`: A list of tuples containing `{pattern, replacement}`, `pattern` can be a string or a [regular expression](https://hexdocs.pm/elixir/Regex.html).
129 * `actors`: A list of actors, for which to drop any posts mentioning.
132 * `accept`: A list of ActivityStreams terms to accept. If empty, all supported messages are accepted.
133 * `reject`: A list of ActivityStreams terms to reject. If empty, no messages are rejected.
135 #### :mrf_user_allowlist
137 The keys in this section are the domain names that the policy should apply to.
138 Each key should be assigned a list of users that should be allowed through by
139 their ActivityPub ID.
144 config :pleroma, :mrf_user_allowlist,
145 "example.org": ["https://example.org/users/admin"]
149 * `threshold`: Required age (in seconds) of a post before actions are taken.
150 * `actions`: A list of actions to apply to the post:
151 * `:delist` removes the post from public timelines
152 * `:strip_followers` removes followers from the ActivityPub recipient list, ensuring they won't be delivered to home timelines
153 * `:reject` rejects the message entirely
156 * ``unfollow_blocked``: Whether blocks result in people getting unfollowed
157 * ``outgoing_blocks``: Whether to federate blocks to other instances
158 * ``deny_follow_blocked``: Whether to disallow following an account that has blocked the user in question
159 * ``sign_object_fetches``: Sign object fetches with HTTP signatures
161 ### :fetch_initial_posts
162 * `enabled`: if enabled, when a new user is federated with, fetch some of their latest posts
163 * `pages`: the amount of pages to fetch
165 ## Pleroma.ScheduledActivity
167 * `daily_user_limit`: the number of scheduled activities a user is allowed to create in a single day (Default: `25`)
168 * `total_user_limit`: the number of scheduled activities a user is allowed to create in total (Default: `300`)
169 * `enabled`: whether scheduled activities are sent to the job queue to be executed
171 ## Pleroma.ActivityExpiration
173 * `enabled`: whether expired activities will be sent to the job queue to be deleted
177 ### :frontend_configurations
179 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).
181 Frontends can access these settings at `/api/pleroma/frontend_configurations`
183 To add your own configuration for PleromaFE, use it like this:
186 config :pleroma, :frontend_configurations,
188 theme: "pleroma-dark",
189 # ... see /priv/static/static/config.json for the available keys.
192 showInstanceSpecificPanel: true
196 These settings **need to be complete**, they will override the defaults.
200 Render profiles and posts using server-generated HTML that is viewable without using JavaScript.
204 * `enabled` - Enables the rendering of static HTML. Defaults to `false`.
208 This section configures assets to be used with various frontends. Currently the only option
209 relates to mascots on the mastodon frontend
211 * `mascots`: KeywordList of mascots, each element __MUST__ contain both a `url` and a
213 * `default_mascot`: An element from `mascots` - This will be used as the default mascot
214 on MastoFE (default: `:pleroma_fox_tan`).
218 This section describe PWA manifest instance-specific values. Currently this option relate only for MastoFE.
220 * `icons`: Describe the icons of the app, this a list of maps describing icons in the same way as the
221 [spec](https://www.w3.org/TR/appmanifest/#imageresource-and-its-members) describes it.
226 config :pleroma, :manifest,
229 src: "/static/logo.png"
232 src: "/static/icon.png",
236 src: "/static/icon.ico",
237 sizes: "72x72 96x96 128x128 256x256"
242 * `theme_color`: Describe the theme color of the app. (Example: `"#282c37"`, `"rebeccapurple"`).
243 * `background_color`: Describe the background color of the app. (Example: `"#191b22"`, `"aliceblue"`).
246 * `shortcode_globs`: Location of custom emoji files. `*` can be used as a wildcard. Example `["/emoji/custom/**/*.png"]`
247 * `pack_extensions`: A list of file extensions for emojis, when no emoji.txt for a pack is present. Example `[".png", ".gif"]`
248 * `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"]]`
249 * `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).
250 * `shared_pack_cache_seconds_per_file`: When an emoji pack is shared, the archive is created and cached in
251 memory for this amount of seconds multiplied by the number of files.
254 * `enabled`: Enables proxying of remote media to the instance’s proxy
255 * `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.
256 * `proxy_opts`: All options defined in `Pleroma.ReverseProxy` documentation, defaults to `[max_body_length: (25*1_048_576)]`.
257 * `whitelist`: List of domains to bypass the mediaproxy
261 ### Pleroma.Web.Metadata (provider)
262 * `providers`: a list of metadata providers to enable. Providers available:
263 * `Pleroma.Web.Metadata.Providers.OpenGraph`
264 * `Pleroma.Web.Metadata.Providers.TwitterCard`
265 * `Pleroma.Web.Metadata.Providers.RelMe` - add links from user bio with rel=me into the `<header>` as `<link rel=me>`.
266 * `Pleroma.Web.Metadata.Providers.Feed` - add a link to a user's Atom feed into the `<header>` as `<link rel=alternate>`.
267 * `unfurl_nsfw`: If set to `true` nsfw attachments will be shown in previews.
269 ### :rich_media (consumer)
270 * `enabled`: if enabled the instance will parse metadata from attached links to generate link previews.
271 * `ignore_hosts`: list of hosts which will be ignored by the metadata parser. For example `["accounts.google.com", "xss.website"]`, defaults to `[]`.
272 * `ignore_tld`: list TLDs (top-level domains) which will ignore for parse metadata. default is ["local", "localdomain", "lan"].
273 * `parsers`: list of Rich Media parsers.
277 ### Pleroma.Web.Endpoint
280 `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.
282 * `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).
283 - `ip` - a tuple consisting of 4 integers
285 * `url` - a list containing the configuration for generating urls, accepts
286 - `host` - the host without the scheme and a post (e.g `example.com`, not `https://example.com:2020`)
287 - `scheme` - e.g `http`, `https`
290 * `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.
294 config :pleroma, Pleroma.Web.Endpoint,
295 url: [host: "example.com", port: 2020, scheme: "https"],
302 This will make Pleroma listen on `127.0.0.1` port `8080` and generate urls starting with `https://example.com:2020`
305 * ``enabled``: Whether the managed content security policy is enabled.
306 * ``sts``: Whether to additionally send a `Strict-Transport-Security` header.
307 * ``sts_max_age``: The maximum age for the `Strict-Transport-Security` header if sent.
308 * ``ct_max_age``: The maximum age for the `Expect-CT` header if sent.
309 * ``referrer_policy``: The referrer policy to use, either `"same-origin"` or `"no-referrer"`.
310 * ``report_uri``: Adds the specified url to `report-uri` and `report-to` group in CSP header.
312 ### Pleroma.Plugs.RemoteIp
315 If your instance is not behind at least one reverse proxy, you should not enable this plug.
317 `Pleroma.Plugs.RemoteIp` is a shim to call [`RemoteIp`](https://git.pleroma.social/pleroma/remote_ip) but with runtime configuration.
321 * `enabled` - Enable/disable the plug. Defaults to `false`.
322 * `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]`.
323 * `proxies` - A list of strings in [CIDR](https://en.wikipedia.org/wiki/CIDR) notation specifying the IPs of known proxies. Defaults to `[]`.
324 * `reserved` - Defaults to [localhost](https://en.wikipedia.org/wiki/Localhost) and [private network](https://en.wikipedia.org/wiki/Private_network).
329 This is an advanced feature and disabled by default.
331 If your instance is behind a reverse proxy you must enable and configure [`Pleroma.Plugs.RemoteIp`](#pleroma-plugs-remoteip).
333 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:
335 * The first element: `scale` (Integer). The time scale in milliseconds.
336 * The second element: `limit` (Integer). How many requests to limit in the time scale provided.
338 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.
340 Supported rate limiters:
342 * `:search` for the search requests (account & status search etc.)
343 * `:app_account_creation` for registering user accounts from the same IP address
344 * `:relations_actions` for actions on relations with all users (follow, unfollow)
345 * `:relation_id_action` for actions on relation with a specific user (follow, unfollow)
346 * `:statuses_actions` for create / delete / fav / unfav / reblog / unreblog actions on any statuses
347 * `:status_id_action` for fav / unfav or reblog / unreblog actions on the same status by the same user
351 The expiration time for the web responses cache. Values should be in milliseconds or `nil` to disable expiration.
355 * `:activity_pub` - activity pub routes (except question activities). Defaults to `nil` (no expiration).
356 * `:activity_pub_question` - activity pub routes (question activities). Defaults to `30_000` (30 seconds).
360 Advanced. Tweaks Hackney (http client) connections pools.
362 There's three pools used:
364 * `:federation` for the federation jobs.
365 You may want this pool max_connections to be at least equal to the number of federator jobs + retry queue jobs.
366 * `:media` for rich media, media proxy
367 * `:upload` for uploaded media (if using a remote uploader and `proxy_remote: true`)
369 For each pool, the options are:
371 * `max_connections` - how much connections a pool can hold
372 * `timeout` - retention duration for connections
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.
382 ### Captcha providers
384 #### Pleroma.Captcha.Kocaptcha
385 Kocaptcha is a very simple captcha service with a single API endpoint,
386 the source code is here: https://github.com/koto-bank/kocaptcha. The default endpoint
387 `https://captcha.kotobank.ch` is hosted by the developer.
389 * `endpoint`: the Kocaptcha endpoint to use.
394 * `uploader`: Which one of the [uploaders](#uploaders) to use.
395 * `filters`: List of [upload filters](#upload-filters) to use.
396 * `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`
397 * `base_url`: The base URL to access a user-uploaded file. Useful when you want to proxy the media files via another host.
398 * `proxy_remote`: If you're using a remote uploader, Pleroma will proxy media requests instead of redirecting to it.
399 * `proxy_opts`: Proxy options, see `Pleroma.ReverseProxy` documentation.
402 `strip_exif` has been replaced by `Pleroma.Upload.Filter.Mogrify`.
405 #### Pleroma.Uploaders.Local
406 * `uploads`: Which directory to store the user-uploads in, relative to pleroma’s working directory.
408 #### Pleroma.Uploaders.S3
409 * `bucket`: S3 bucket name.
410 * `bucket_namespace`: S3 bucket namespace.
411 * `public_endpoint`: S3 endpoint that the user finally accesses(ex. "https://s3.dualstack.ap-northeast-1.amazonaws.com")
412 * `truncated_namespace`: If you use S3 compatible service such as Digital Ocean Spaces or CDN, set folder name or "" etc.
413 For example, when using CDN to S3 virtual host format, set "".
414 At this time, write CNAME to CDN in public_endpoint.
415 * `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.
420 #### Pleroma.Upload.Filter.Mogrify
422 * `args`: List of actions for the `mogrify` command like `"strip"` or `["strip", "auto-orient", {"implode", "1"}]`.
424 #### Pleroma.Upload.Filter.Dedupe
426 No specific configuration.
428 #### Pleroma.Upload.Filter.AnonymizeFilename
430 This filter replaces the filename (not the path) of an upload. For complete obfuscation, add
431 `Pleroma.Upload.Filter.Dedupe` before AnonymizeFilename.
433 * `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}`.
437 ### Pleroma.Emails.Mailer
438 * `adapter`: one of the mail adapters listed in [Swoosh readme](https://github.com/swoosh/swoosh#adapters), or `Swoosh.Adapters.Local` for in-memory mailbox.
439 * `api_key` / `password` and / or other adapter-specific settings, per the above documentation.
440 * `enabled`: Allows enable/disable send emails. Default: `false`.
442 An example for Sendgrid adapter:
445 config :pleroma, Pleroma.Emails.Mailer,
446 adapter: Swoosh.Adapters.Sendgrid,
447 api_key: "YOUR_API_KEY"
450 An example for SMTP adapter:
453 config :pleroma, Pleroma.Emails.Mailer,
454 adapter: Swoosh.Adapters.SMTP,
455 relay: "smtp.gmail.com",
456 username: "YOUR_USERNAME@gmail.com",
457 password: "YOUR_SMTP_PASSWORD",
464 ### :email_notifications
466 Email notifications settings.
468 - digest - emails of "what you've missed" for users who have been
469 inactive for a while.
470 - active: globally enable or disable digest emails
471 - schedule: When to send digest email, in [crontab format](https://en.wikipedia.org/wiki/Cron).
472 "0 0 * * 0" is the default, meaning "once a week at midnight on Sunday morning"
473 - interval: Minimum interval between digest emails to one user
474 - inactivity_threshold: Minimum user inactivity threshold
476 ### Pleroma.Emails.UserEmail
478 - `:logo` - a path to a custom logo. Set it to `nil` to use the default Pleroma logo.
479 - `:styling` - a map with color settings for email templates.
485 [Oban](https://github.com/sorentwo/oban) asynchronous job processor configuration.
487 Configuration options described in [Oban readme](https://github.com/sorentwo/oban#usage):
489 * `repo` - app's Ecto repo (`Pleroma.Repo`)
490 * `verbose` - logs verbosity
491 * `prune` - non-retryable jobs [pruning settings](https://github.com/sorentwo/oban#pruning) (`:disabled` / `{:maxlen, value}` / `{:maxage, value}`)
492 * `queues` - job queues (see below)
494 Pleroma has the following queues:
496 * `activity_expiration` - Activity expiration
497 * `federator_outgoing` - Outgoing federation
498 * `federator_incoming` - Incoming federation
499 * `mailer` - Email sender, see [`Pleroma.Emails.Mailer`](#pleromaemailsmailer)
500 * `transmogrifier` - Transmogrifier
501 * `web_push` - Web push notifications
502 * `scheduled_activities` - Scheduled activities, see [`Pleroma.ScheduledActivity`](#pleromascheduledactivity)
507 config :pleroma, Oban,
510 prune: {:maxlen, 1500},
512 federator_incoming: 50,
513 federator_outgoing: 50
517 This config contains two queues: `federator_incoming` and `federator_outgoing`. Both have the number of max concurrent jobs set to `50`.
519 #### Migrating `pleroma_job_queue` settings
521 `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).
525 Includes custom worker options not interpretable directly by `Oban`.
527 * `retries` — keyword lists where keys are `Oban` queues (see above) and values are numbers of max attempts for failed jobs.
532 config :pleroma, :workers,
534 federator_incoming: 5,
535 federator_outgoing: 5
539 #### Migrating `Pleroma.Web.Federator.RetryQueue` settings
541 * `max_retries` is replaced with `config :pleroma, :workers, retries: [federator_outgoing: 5]`
542 * `enabled: false` corresponds to `config :pleroma, :workers, retries: [federator_outgoing: 1]`
543 * deprecated options: `max_jobs`, `initial_timeout`
545 ### Pleroma.Scheduler
547 Configuration for [Quantum](https://github.com/quantum-elixir/quantum-core) jobs scheduler.
549 See [Quantum readme](https://github.com/quantum-elixir/quantum-core#usage) for the list of supported options.
554 config :pleroma, Pleroma.Scheduler,
558 jobs: [{"0 */6 * * * *", {Pleroma.Web.Websub, :refresh_subscriptions, []}}]
561 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)).
563 ## :web_push_encryption, :vapid_details
565 Web Push Notifications configuration. You can use the mix task `mix web_push.gen.keypair` to generate it.
567 * ``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.
568 * ``public_key``: VAPID public key
569 * ``private_key``: VAPID private key
572 * `backends`: `:console` is used to send logs to stdout, `{ExSyslogger, :ex_syslogger}` to log to syslog, and `Quack.Logger` to log to Slack
574 An example to enable ONLY ExSyslogger (f/ex in ``prod.secret.exs``) with info and debug suppressed:
577 backends: [{ExSyslogger, :ex_syslogger}]
579 config :logger, :ex_syslogger,
583 Another example, keeping console output and adding the pid to syslog output:
586 backends: [:console, {ExSyslogger, :ex_syslogger}]
588 config :logger, :ex_syslogger,
590 option: [:pid, :ndelay]
593 See: [logger’s documentation](https://hexdocs.pm/logger/Logger.html) and [ex_syslogger’s documentation](https://hexdocs.pm/ex_syslogger/)
595 An example of logging info to local syslog, but warn to a Slack channel:
598 backends: [ {ExSyslogger, :ex_syslogger}, Quack.Logger ],
601 config :logger, :ex_syslogger,
604 format: "$metadata[$level] $message"
609 webhook_url: "https://hooks.slack.com/services/YOUR-API-KEY-HERE"
612 See the [Quack Github](https://github.com/azohra/quack) for more details
618 ### RUM indexing for full text search
621 It is recommended to use PostgreSQL v11 or newer. We have seen some minor issues with lower PostgreSQL versions.
623 * `rum_enabled`: If RUM indexes should be used. Defaults to `false`.
625 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.
627 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.
629 To enable them, both the `rum_enabled` flag has to be set and the following special migration has to be run:
631 `mix ecto.migrate --migrations-path priv/repo/optional_migrations/rum_indexing/`
633 This will probably take a long time.
635 ## Alternative client protocols
639 To enable simple command line interface accessible over ssh, add a setting like this to your configuration file:
643 priv_dir = Path.join([app_dir, "priv/ssh_keys"])
648 handler: "Pleroma.BBS.Handler",
650 password_authenticator: "Pleroma.BBS.Authenticator"
653 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`
656 * `enabled`: Enables the gopher interface
657 * `ip`: IP address to bind to
658 * `port`: Port to bind to
659 * `dstport`: Port advertised in urls (optional, defaults to `port`)
666 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:
669 config :pleroma, :admin_token, "somerandomtoken"
675 curl "http://localhost:4000/api/pleroma/admin/users/invites?admin_token=somerandomtoken"
681 curl -H "X-Admin-Token: somerandomtoken" "http://localhost:4000/api/pleroma/admin/users/invites"
686 * `Pleroma.Web.Auth.PleromaAuthenticator`: default database authenticator.
687 * `Pleroma.Web.Auth.LDAPAuthenticator`: LDAP authentication.
689 Authentication / authorization settings.
691 * `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`.
692 * `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`.
693 * `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>`).
695 ### Pleroma.Web.Auth.Authenticator
697 * `Pleroma.Web.Auth.PleromaAuthenticator`: default database authenticator.
698 * `Pleroma.Web.Auth.LDAPAuthenticator`: LDAP authentication.
702 Use LDAP for user authentication. When a user logs in to the Pleroma
703 instance, the name and password will be verified by trying to authenticate
704 (bind) to an LDAP server. If a user exists in the LDAP directory but there
705 is no account with the same name yet on the Pleroma instance then a new
706 Pleroma account will be created with the same name as the LDAP user name.
708 * `enabled`: enables LDAP authentication
709 * `host`: LDAP server hostname
710 * `port`: LDAP port, e.g. 389 or 636
711 * `ssl`: true to use SSL, usually implies the port 636
712 * `sslopts`: additional SSL options
713 * `tls`: true to start TLS, usually implies the port 389
714 * `tlsopts`: additional TLS options
715 * `base`: LDAP base, e.g. "dc=example,dc=com"
716 * `uid`: LDAP attribute name to authenticate the user, e.g. when "cn", the filter will be "cn=username,base"
718 ### OAuth consumer mode
720 OAuth consumer mode allows sign in / sign up via external OAuth providers (e.g. Twitter, Facebook, Google, Microsoft, etc.).
721 Implementation is based on Ueberauth; see the list of [available strategies](https://github.com/ueberauth/ueberauth/wiki/List-of-Strategies).
724 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.
727 Each strategy requires separate setup (on external provider side and Pleroma side). Below are the guidelines on setting up most popular strategies.
730 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"`
732 * For Twitter, [register an app](https://developer.twitter.com/en/apps), configure callback URL to https://<your_host>/oauth/twitter/callback
734 * 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/
736 * For Google, [register an app](https://console.developers.google.com), configure callback URL to https://<your_host>/oauth/google/callback
738 * For Microsoft, [register an app](https://portal.azure.com), configure callback URL to https://<your_host>/oauth/microsoft/callback
740 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`,
741 per strategy's documentation (e.g. [ueberauth_twitter](https://github.com/ueberauth/ueberauth_twitter)). Example config basing on environment variables:
745 config :ueberauth, Ueberauth.Strategy.Twitter.OAuth,
746 consumer_key: System.get_env("TWITTER_CONSUMER_KEY"),
747 consumer_secret: System.get_env("TWITTER_CONSUMER_SECRET")
750 config :ueberauth, Ueberauth.Strategy.Facebook.OAuth,
751 client_id: System.get_env("FACEBOOK_APP_ID"),
752 client_secret: System.get_env("FACEBOOK_APP_SECRET"),
753 redirect_uri: System.get_env("FACEBOOK_REDIRECT_URI")
756 config :ueberauth, Ueberauth.Strategy.Google.OAuth,
757 client_id: System.get_env("GOOGLE_CLIENT_ID"),
758 client_secret: System.get_env("GOOGLE_CLIENT_SECRET"),
759 redirect_uri: System.get_env("GOOGLE_REDIRECT_URI")
762 config :ueberauth, Ueberauth.Strategy.Microsoft.OAuth,
763 client_id: System.get_env("MICROSOFT_CLIENT_ID"),
764 client_secret: System.get_env("MICROSOFT_CLIENT_SECRET")
766 config :ueberauth, Ueberauth,
768 microsoft: {Ueberauth.Strategy.Microsoft, [callback_params: []]}
772 # Note: make sure to add `keycloak:ueberauth_keycloak_strategy` entry to `OAUTH_CONSUMER_STRATEGIES` environment variable
773 keycloak_url = "https://publicly-reachable-keycloak-instance.org:8080"
775 config :ueberauth, Ueberauth.Strategy.Keycloak.OAuth,
776 client_id: System.get_env("KEYCLOAK_CLIENT_ID"),
777 client_secret: System.get_env("KEYCLOAK_CLIENT_SECRET"),
779 authorize_url: "#{keycloak_url}/auth/realms/master/protocol/openid-connect/auth",
780 token_url: "#{keycloak_url}/auth/realms/master/protocol/openid-connect/token",
781 userinfo_url: "#{keycloak_url}/auth/realms/master/protocol/openid-connect/userinfo",
784 config :ueberauth, Ueberauth,
786 keycloak: {Ueberauth.Strategy.Keycloak, [uid_field: :email]}
790 ### OAuth 2.0 provider - :oauth2
792 Configure OAuth 2 provider capabilities:
794 * `token_expires_in` - The lifetime in seconds of the access token.
795 * `issue_new_refresh_token` - Keeps old refresh token or generate new refresh token when to obtain an access token.
796 * `clean_expired_tokens` - Enable a background job to clean expired oauth tokens. Defaults to `false`.
797 * `clean_expired_tokens_interval` - Interval to run the job to clean expired tokens. Defaults to `86_400_000` (24 hours).
802 * `valid_schemes`: List of the scheme part that is considered valid to be an URL.
806 Configuration for the `auto_linker` library:
808 * `class: "auto-linker"` - specify the class to be added to the generated link. false to clear.
809 * `rel: "noopener noreferrer"` - override the rel attribute. false to clear.
810 * `new_window: true` - set to false to remove `target='_blank'` attribute.
811 * `scheme: false` - Set to true to link urls with schema `http://google.com`.
812 * `truncate: false` - Set to a number to truncate urls longer then the number. Truncated urls will end in `..`.
813 * `strip_prefix: true` - Strip the scheme prefix.
814 * `extra: false` - link urls with rarely used schemes (magnet, ipfs, irc, etc.).