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 * `chat_limit`: Character limit of the instance chat messages.
16 * `remote_limit`: Hard character limit beyond which remote posts will be dropped.
17 * `upload_limit`: File size limit of uploads (except for avatar, background, banner).
18 * `avatar_upload_limit`: File size limit of user’s profile avatars.
19 * `background_upload_limit`: File size limit of user’s profile backgrounds.
20 * `banner_upload_limit`: File size limit of user’s profile banners.
21 * `poll_limits`: A map with poll limits for **local** polls.
22 * `max_options`: Maximum number of options.
23 * `max_option_chars`: Maximum number of characters per option.
24 * `min_expiration`: Minimum expiration time (in seconds).
25 * `max_expiration`: Maximum expiration time (in seconds).
26 * `registrations_open`: Enable registrations for anyone, invitations can be enabled when false.
27 * `invites_enabled`: Enable user invitations for admins (depends on `registrations_open: false`).
28 * `account_activation_required`: Require users to confirm their emails before signing in.
29 * `federating`: Enable federation with other instances.
30 * `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.
31 * `federation_reachability_timeout_days`: Timeout (in days) of each external federation target being unreachable prior to pausing federating to it.
32 * `allow_relay`: Enable Pleroma’s Relay, which makes it possible to follow a whole instance.
33 * `rewrite_policy`: Message Rewrite Policy, either one or a list. Here are the ones available by default:
34 * `Pleroma.Web.ActivityPub.MRF.NoOpPolicy`: Doesn’t modify activities (default).
35 * `Pleroma.Web.ActivityPub.MRF.DropPolicy`: Drops all activities. It generally doesn’t makes sense to use in production.
36 * `Pleroma.Web.ActivityPub.MRF.SimplePolicy`: Restrict the visibility of activities from certains instances (See [`:mrf_simple`](#mrf_simple)).
37 * `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).
38 * `Pleroma.Web.ActivityPub.MRF.SubchainPolicy`: Selectively runs other MRF policies when messages match (See [`:mrf_subchain`](#mrf_subchain)).
39 * `Pleroma.Web.ActivityPub.MRF.RejectNonPublic`: Drops posts with non-public visibility settings (See [`:mrf_rejectnonpublic`](#mrf_rejectnonpublic)).
40 * `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:.
41 * `Pleroma.Web.ActivityPub.MRF.AntiLinkSpamPolicy`: Rejects posts from likely spambots by rejecting posts from new users that contain links.
42 * `Pleroma.Web.ActivityPub.MRF.MediaProxyWarmingPolicy`: Crawls attachments using their MediaProxy URLs so that the MediaProxy cache is primed.
43 * `Pleroma.Web.ActivityPub.MRF.MentionPolicy`: Drops posts mentioning configurable users. (See [`:mrf_mention`](#mrf_mention)).
44 * `Pleroma.Web.ActivityPub.MRF.VocabularyPolicy`: Restricts activities to a configured set of vocabulary. (See [`:mrf_vocabulary`](#mrf_vocabulary)).
45 * `Pleroma.Web.ActivityPub.MRF.ObjectAgePolicy`: Rejects or delists posts based on their age when received. (See [`:mrf_object_age`](#mrf_object_age)).
46 * `public`: Makes the client API in authentificated mode-only except for user-profiles. Useful for disabling the Local Timeline and The Whole Known Network.
47 * `quarantined_instances`: List of ActivityPub instances where private(DMs, followers-only) activities will not be send.
48 * `managed_config`: Whenether the config for pleroma-fe is configured in [:frontend_configurations](#frontend_configurations) or in ``static/config.json``.
49 * `allowed_post_formats`: MIME-type list of formats allowed to be posted (transformed into HTML).
50 * `mrf_transparency`: Make the content of your Message Rewrite Facility settings public (via nodeinfo).
51 * `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.
52 * `extended_nickname_format`: Set to `true` to use extended local nicknames format (allows underscores/dashes). This will break federation with
53 older software for theses nicknames.
54 * `max_pinned_statuses`: The maximum number of pinned statuses. `0` will disable the feature.
55 * `autofollowed_nicknames`: Set to nicknames of (local) users that every new user should automatically follow.
56 * `no_attachment_links`: Set to true to disable automatically adding attachment link text to statuses.
57 * `welcome_message`: A message that will be send to a newly registered users as a direct message.
58 * `welcome_user_nickname`: The nickname of the local user that sends the welcome message.
59 * `max_report_comment_size`: The maximum size of the report comment (Default: `1000`).
60 * `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`.
61 * `healthcheck`: If set to true, system data will be shown on ``/api/pleroma/healthcheck``.
62 * `remote_post_retention_days`: The default amount of days to retain remote posts when pruning the database.
63 * `user_bio_length`: A user bio maximum length (default: `5000`).
64 * `user_name_length`: A user name maximum length (default: `100`).
65 * `skip_thread_containment`: Skip filter out broken threads. The default is `false`.
66 * `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`.
67 * `max_account_fields`: The maximum number of custom fields in the user profile (default: `10`).
68 * `max_remote_account_fields`: The maximum number of custom fields in the remote user profile (default: `20`).
69 * `account_field_name_length`: An account field name maximum length (default: `512`).
70 * `account_field_value_length`: An account field value maximum length (default: `2048`).
71 * `external_user_synchronization`: Enabling following/followers counters synchronization for external users.
77 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.
80 * `media_removal`: List of instances to remove media from.
81 * `media_nsfw`: List of instances to put media as NSFW(sensitive) from.
82 * `federated_timeline_removal`: List of instances to remove from Federated (aka The Whole Known Network) Timeline.
83 * `reject`: List of instances to reject any activities from.
84 * `accept`: List of instances to accept any activities from.
85 * `report_removal`: List of instances to reject reports from.
86 * `avatar_removal`: List of instances to strip avatars from.
87 * `banner_removal`: List of instances to strip banners from.
90 This policy processes messages through an alternate pipeline when a given message matches certain criteria.
91 All criteria are configured as a map of regular expressions to lists of policy modules.
93 * `match_actor`: Matches a series of regular expressions against the actor field.
98 config :pleroma, :mrf_subchain,
100 ~r/https:\/\/example.com/s => [Pleroma.Web.ActivityPub.MRF.DropPolicy]
104 #### :mrf_rejectnonpublic
105 * `allow_followersonly`: whether to allow followers-only posts.
106 * `allow_direct`: whether to allow direct messages.
109 * `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.
110 * `reject_threshold`: Number of mentioned users after which the messaged gets rejected. Set to 0 to disable.
113 * `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).
114 * `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).
115 * `replace`: A list of tuples containing `{pattern, replacement}`, `pattern` can be a string or a [regular expression](https://hexdocs.pm/elixir/Regex.html).
118 * `actors`: A list of actors, for which to drop any posts mentioning.
121 * `accept`: A list of ActivityStreams terms to accept. If empty, all supported messages are accepted.
122 * `reject`: A list of ActivityStreams terms to reject. If empty, no messages are rejected.
124 #### :mrf_user_allowlist
126 The keys in this section are the domain names that the policy should apply to.
127 Each key should be assigned a list of users that should be allowed through by
128 their ActivityPub ID.
133 config :pleroma, :mrf_user_allowlist,
134 "example.org": ["https://example.org/users/admin"]
138 * `threshold`: Required age (in seconds) of a post before actions are taken.
139 * `actions`: A list of actions to apply to the post:
140 * `:delist` removes the post from public timelines
141 * `:strip_followers` removes followers from the ActivityPub recipient list, ensuring they won't be delivered to home timelines
142 * `:reject` rejects the message entirely
145 * ``unfollow_blocked``: Whether blocks result in people getting unfollowed
146 * ``outgoing_blocks``: Whether to federate blocks to other instances
147 * ``deny_follow_blocked``: Whether to disallow following an account that has blocked the user in question
148 * ``sign_object_fetches``: Sign object fetches with HTTP signatures
150 ### :fetch_initial_posts
151 * `enabled`: if enabled, when a new user is federated with, fetch some of their latest posts
152 * `pages`: the amount of pages to fetch
154 ## Pleroma.ScheduledActivity
156 * `daily_user_limit`: the number of scheduled activities a user is allowed to create in a single day (Default: `25`)
157 * `total_user_limit`: the number of scheduled activities a user is allowed to create in total (Default: `300`)
158 * `enabled`: whether scheduled activities are sent to the job queue to be executed
160 ## Pleroma.ActivityExpiration
162 * `enabled`: whether expired activities will be sent to the job queue to be deleted
166 ### :frontend_configurations
168 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).
170 Frontends can access these settings at `/api/pleroma/frontend_configurations`
172 To add your own configuration for PleromaFE, use it like this:
175 config :pleroma, :frontend_configurations,
177 theme: "pleroma-dark",
178 # ... see /priv/static/static/config.json for the available keys.
181 showInstanceSpecificPanel: true
185 These settings **need to be complete**, they will override the defaults.
189 Render profiles and posts using server-generated HTML that is viewable without using JavaScript.
193 * `enabled` - Enables the rendering of static HTML. Defaults to `false`.
197 This section configures assets to be used with various frontends. Currently the only option
198 relates to mascots on the mastodon frontend
200 * `mascots`: KeywordList of mascots, each element __MUST__ contain both a `url` and a
202 * `default_mascot`: An element from `mascots` - This will be used as the default mascot
203 on MastoFE (default: `:pleroma_fox_tan`).
207 This section describe PWA manifest instance-specific values. Currently this option relate only for MastoFE.
209 * `icons`: Describe the icons of the app, this a list of maps describing icons in the same way as the
210 [spec](https://www.w3.org/TR/appmanifest/#imageresource-and-its-members) describes it.
215 config :pleroma, :manifest,
218 src: "/static/logo.png"
221 src: "/static/icon.png",
225 src: "/static/icon.ico",
226 sizes: "72x72 96x96 128x128 256x256"
231 * `theme_color`: Describe the theme color of the app. (Example: `"#282c37"`, `"rebeccapurple"`).
232 * `background_color`: Describe the background color of the app. (Example: `"#191b22"`, `"aliceblue"`).
235 * `shortcode_globs`: Location of custom emoji files. `*` can be used as a wildcard. Example `["/emoji/custom/**/*.png"]`
236 * `pack_extensions`: A list of file extensions for emojis, when no emoji.txt for a pack is present. Example `[".png", ".gif"]`
237 * `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"]]`
238 * `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).
239 * `shared_pack_cache_seconds_per_file`: When an emoji pack is shared, the archive is created and cached in
240 memory for this amount of seconds multiplied by the number of files.
243 * `enabled`: Enables proxying of remote media to the instance’s proxy
244 * `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.
245 * `proxy_opts`: All options defined in `Pleroma.ReverseProxy` documentation, defaults to `[max_body_length: (25*1_048_576)]`.
246 * `whitelist`: List of domains to bypass the mediaproxy
250 ### Pleroma.Web.Metadata (provider)
251 * `providers`: a list of metadata providers to enable. Providers available:
252 * `Pleroma.Web.Metadata.Providers.OpenGraph`
253 * `Pleroma.Web.Metadata.Providers.TwitterCard`
254 * `Pleroma.Web.Metadata.Providers.RelMe` - add links from user bio with rel=me into the `<header>` as `<link rel=me>`.
255 * `Pleroma.Web.Metadata.Providers.Feed` - add a link to a user's Atom feed into the `<header>` as `<link rel=alternate>`.
256 * `unfurl_nsfw`: If set to `true` nsfw attachments will be shown in previews.
258 ### :rich_media (consumer)
259 * `enabled`: if enabled the instance will parse metadata from attached links to generate link previews.
260 * `ignore_hosts`: list of hosts which will be ignored by the metadata parser. For example `["accounts.google.com", "xss.website"]`, defaults to `[]`.
261 * `ignore_tld`: list TLDs (top-level domains) which will ignore for parse metadata. default is ["local", "localdomain", "lan"].
262 * `parsers`: list of Rich Media parsers.
266 ### Pleroma.Web.Endpoint
269 `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.
271 * `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).
272 - `ip` - a tuple consisting of 4 integers
274 * `url` - a list containing the configuration for generating urls, accepts
275 - `host` - the host without the scheme and a post (e.g `example.com`, not `https://example.com:2020`)
276 - `scheme` - e.g `http`, `https`
279 * `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.
283 config :pleroma, Pleroma.Web.Endpoint,
284 url: [host: "example.com", port: 2020, scheme: "https"],
291 This will make Pleroma listen on `127.0.0.1` port `8080` and generate urls starting with `https://example.com:2020`
294 * ``enabled``: Whether the managed content security policy is enabled.
295 * ``sts``: Whether to additionally send a `Strict-Transport-Security` header.
296 * ``sts_max_age``: The maximum age for the `Strict-Transport-Security` header if sent.
297 * ``ct_max_age``: The maximum age for the `Expect-CT` header if sent.
298 * ``referrer_policy``: The referrer policy to use, either `"same-origin"` or `"no-referrer"`.
299 * ``report_uri``: Adds the specified url to `report-uri` and `report-to` group in CSP header.
301 ### Pleroma.Plugs.RemoteIp
304 If your instance is not behind at least one reverse proxy, you should not enable this plug.
306 `Pleroma.Plugs.RemoteIp` is a shim to call [`RemoteIp`](https://git.pleroma.social/pleroma/remote_ip) but with runtime configuration.
310 * `enabled` - Enable/disable the plug. Defaults to `false`.
311 * `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]`.
312 * `proxies` - A list of strings in [CIDR](https://en.wikipedia.org/wiki/CIDR) notation specifying the IPs of known proxies. Defaults to `[]`.
313 * `reserved` - Defaults to [localhost](https://en.wikipedia.org/wiki/Localhost) and [private network](https://en.wikipedia.org/wiki/Private_network).
318 This is an advanced feature and disabled by default.
320 If your instance is behind a reverse proxy you must enable and configure [`Pleroma.Plugs.RemoteIp`](#pleroma-plugs-remoteip).
322 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:
324 * The first element: `scale` (Integer). The time scale in milliseconds.
325 * The second element: `limit` (Integer). How many requests to limit in the time scale provided.
327 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.
332 config :pleroma, :rate_limit,
333 authentication: {60_000, 15},
334 search: [{1000, 10}, {1000, 30}]
339 1. In 60 seconds, 50 authentication attempts can be performed from the same IP address.
340 2. In 1 second, 10 search requests can be performed from the same IP adress by unauthenticated users, while authenticated users can perform 30 search requests per second.
342 Supported rate limiters:
344 * `:search` - Account/Status search.
345 * `:app_account_creation` - Account registration from the API.
346 * `:relations_actions` - Following/Unfollowing in general.
347 * `:relation_id_action` - Following/Unfollowing for a specific user.
348 * `:statuses_actions` - Status actions such as: (un)repeating, (un)favouriting, creating, deleting.
349 * `:status_id_action` - (un)Repeating/(un)Favouriting a particular status.
350 * `:authentication` - Authentication actions, i.e getting an OAuth token.
351 * `password_reset` - Requesting password reset emails.
352 * `:account_confirmation_resend` - Requesting resending account confirmation emails.
353 * `:ap_routes` - Requesting statuses via ActivityPub.
357 The expiration time for the web responses cache. Values should be in milliseconds or `nil` to disable expiration.
361 * `:activity_pub` - activity pub routes (except question activities). Defaults to `nil` (no expiration).
362 * `:activity_pub_question` - activity pub routes (question activities). Defaults to `30_000` (30 seconds).
368 * `proxy_url`: an upstream proxy to fetch posts and/or media with, (default: `nil`)
369 * `send_user_agent`: should we include a user agent with HTTP requests? (default: `true`)
370 * `user_agent`: what user agent should we use? (default: `:default`), must be string or `:default`
371 * `adapter`: array of hackney options
376 Advanced. Tweaks Hackney (http client) connections pools.
378 There's three pools used:
380 * `:federation` for the federation jobs.
381 You may want this pool max_connections to be at least equal to the number of federator jobs + retry queue jobs.
382 * `:media` for rich media, media proxy
383 * `:upload` for uploaded media (if using a remote uploader and `proxy_remote: true`)
385 For each pool, the options are:
387 * `max_connections` - how much connections a pool can hold
388 * `timeout` - retention duration for connections
395 * `enabled`: Whether the captcha should be shown on registration.
396 * `method`: The method/service to use for captcha.
397 * `seconds_valid`: The time in seconds for which the captcha is valid.
399 ### Captcha providers
401 #### Pleroma.Captcha.Native
403 A built-in captcha provider. Enabled by default.
405 #### Pleroma.Captcha.Kocaptcha
407 Kocaptcha is a very simple captcha service with a single API endpoint,
408 the source code is here: https://github.com/koto-bank/kocaptcha. The default endpoint
409 `https://captcha.kotobank.ch` is hosted by the developer.
411 * `endpoint`: the Kocaptcha endpoint to use.
416 * `uploader`: Which one of the [uploaders](#uploaders) to use.
417 * `filters`: List of [upload filters](#upload-filters) to use.
418 * `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`
419 * `base_url`: The base URL to access a user-uploaded file. Useful when you want to proxy the media files via another host.
420 * `proxy_remote`: If you're using a remote uploader, Pleroma will proxy media requests instead of redirecting to it.
421 * `proxy_opts`: Proxy options, see `Pleroma.ReverseProxy` documentation.
424 `strip_exif` has been replaced by `Pleroma.Upload.Filter.Mogrify`.
427 #### Pleroma.Uploaders.Local
428 * `uploads`: Which directory to store the user-uploads in, relative to pleroma’s working directory.
430 #### Pleroma.Uploaders.S3
431 * `bucket`: S3 bucket name.
432 * `bucket_namespace`: S3 bucket namespace.
433 * `public_endpoint`: S3 endpoint that the user finally accesses(ex. "https://s3.dualstack.ap-northeast-1.amazonaws.com")
434 * `truncated_namespace`: If you use S3 compatible service such as Digital Ocean Spaces or CDN, set folder name or "" etc.
435 For example, when using CDN to S3 virtual host format, set "".
436 At this time, write CNAME to CDN in public_endpoint.
437 * `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.
442 #### Pleroma.Upload.Filter.Mogrify
444 * `args`: List of actions for the `mogrify` command like `"strip"` or `["strip", "auto-orient", {"implode", "1"}]`.
446 #### Pleroma.Upload.Filter.Dedupe
448 No specific configuration.
450 #### Pleroma.Upload.Filter.AnonymizeFilename
452 This filter replaces the filename (not the path) of an upload. For complete obfuscation, add
453 `Pleroma.Upload.Filter.Dedupe` before AnonymizeFilename.
455 * `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}`.
459 ### Pleroma.Emails.Mailer
460 * `adapter`: one of the mail adapters listed in [Swoosh readme](https://github.com/swoosh/swoosh#adapters), or `Swoosh.Adapters.Local` for in-memory mailbox.
461 * `api_key` / `password` and / or other adapter-specific settings, per the above documentation.
462 * `enabled`: Allows enable/disable send emails. Default: `false`.
464 An example for Sendgrid adapter:
467 config :pleroma, Pleroma.Emails.Mailer,
469 adapter: Swoosh.Adapters.Sendgrid,
470 api_key: "YOUR_API_KEY"
473 An example for SMTP adapter:
476 config :pleroma, Pleroma.Emails.Mailer,
478 adapter: Swoosh.Adapters.SMTP,
479 relay: "smtp.gmail.com",
480 username: "YOUR_USERNAME@gmail.com",
481 password: "YOUR_SMTP_PASSWORD",
487 ### :email_notifications
489 Email notifications settings.
491 - digest - emails of "what you've missed" for users who have been
492 inactive for a while.
493 - active: globally enable or disable digest emails
494 - schedule: When to send digest email, in [crontab format](https://en.wikipedia.org/wiki/Cron).
495 "0 0 * * 0" is the default, meaning "once a week at midnight on Sunday morning"
496 - interval: Minimum interval between digest emails to one user
497 - inactivity_threshold: Minimum user inactivity threshold
499 ### Pleroma.Emails.UserEmail
501 - `:logo` - a path to a custom logo. Set it to `nil` to use the default Pleroma logo.
502 - `:styling` - a map with color settings for email templates.
508 [Oban](https://github.com/sorentwo/oban) asynchronous job processor configuration.
510 Configuration options described in [Oban readme](https://github.com/sorentwo/oban#usage):
512 * `repo` - app's Ecto repo (`Pleroma.Repo`)
513 * `verbose` - logs verbosity
514 * `prune` - non-retryable jobs [pruning settings](https://github.com/sorentwo/oban#pruning) (`:disabled` / `{:maxlen, value}` / `{:maxage, value}`)
515 * `queues` - job queues (see below)
517 Pleroma has the following queues:
519 * `activity_expiration` - Activity expiration
520 * `federator_outgoing` - Outgoing federation
521 * `federator_incoming` - Incoming federation
522 * `mailer` - Email sender, see [`Pleroma.Emails.Mailer`](#pleromaemailsmailer)
523 * `transmogrifier` - Transmogrifier
524 * `web_push` - Web push notifications
525 * `scheduled_activities` - Scheduled activities, see [`Pleroma.ScheduledActivity`](#pleromascheduledactivity)
530 config :pleroma, Oban,
533 prune: {:maxlen, 1500},
535 federator_incoming: 50,
536 federator_outgoing: 50
540 This config contains two queues: `federator_incoming` and `federator_outgoing`. Both have the number of max concurrent jobs set to `50`.
542 #### Migrating `pleroma_job_queue` settings
544 `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).
548 Includes custom worker options not interpretable directly by `Oban`.
550 * `retries` — keyword lists where keys are `Oban` queues (see above) and values are numbers of max attempts for failed jobs.
555 config :pleroma, :workers,
557 federator_incoming: 5,
558 federator_outgoing: 5
562 #### Migrating `Pleroma.Web.Federator.RetryQueue` settings
564 * `max_retries` is replaced with `config :pleroma, :workers, retries: [federator_outgoing: 5]`
565 * `enabled: false` corresponds to `config :pleroma, :workers, retries: [federator_outgoing: 1]`
566 * deprecated options: `max_jobs`, `initial_timeout`
568 ### Pleroma.Scheduler
570 Configuration for [Quantum](https://github.com/quantum-elixir/quantum-core) jobs scheduler.
572 See [Quantum readme](https://github.com/quantum-elixir/quantum-core#usage) for the list of supported options.
577 config :pleroma, Pleroma.Scheduler,
581 jobs: [{"0 */6 * * * *", {Pleroma.Web.Websub, :refresh_subscriptions, []}}]
584 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)).
586 ## :web_push_encryption, :vapid_details
588 Web Push Notifications configuration. You can use the mix task `mix web_push.gen.keypair` to generate it.
590 * ``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.
591 * ``public_key``: VAPID public key
592 * ``private_key``: VAPID private key
595 * `backends`: `:console` is used to send logs to stdout, `{ExSyslogger, :ex_syslogger}` to log to syslog, and `Quack.Logger` to log to Slack
597 An example to enable ONLY ExSyslogger (f/ex in ``prod.secret.exs``) with info and debug suppressed:
600 backends: [{ExSyslogger, :ex_syslogger}]
602 config :logger, :ex_syslogger,
606 Another example, keeping console output and adding the pid to syslog output:
609 backends: [:console, {ExSyslogger, :ex_syslogger}]
611 config :logger, :ex_syslogger,
613 option: [:pid, :ndelay]
616 See: [logger’s documentation](https://hexdocs.pm/logger/Logger.html) and [ex_syslogger’s documentation](https://hexdocs.pm/ex_syslogger/)
618 An example of logging info to local syslog, but warn to a Slack channel:
621 backends: [ {ExSyslogger, :ex_syslogger}, Quack.Logger ],
624 config :logger, :ex_syslogger,
627 format: "$metadata[$level] $message"
632 webhook_url: "https://hooks.slack.com/services/YOUR-API-KEY-HERE"
635 See the [Quack Github](https://github.com/azohra/quack) for more details
641 ### RUM indexing for full text search
644 It is recommended to use PostgreSQL v11 or newer. We have seen some minor issues with lower PostgreSQL versions.
646 * `rum_enabled`: If RUM indexes should be used. Defaults to `false`.
648 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.
650 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.
652 To enable them, both the `rum_enabled` flag has to be set and the following special migration has to be run:
654 `mix ecto.migrate --migrations-path priv/repo/optional_migrations/rum_indexing/`
656 This will probably take a long time.
658 ## Alternative client protocols
662 To enable simple command line interface accessible over ssh, add a setting like this to your configuration file:
666 priv_dir = Path.join([app_dir, "priv/ssh_keys"])
671 handler: "Pleroma.BBS.Handler",
673 password_authenticator: "Pleroma.BBS.Authenticator"
676 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`
679 * `enabled`: Enables the gopher interface
680 * `ip`: IP address to bind to
681 * `port`: Port to bind to
682 * `dstport`: Port advertised in urls (optional, defaults to `port`)
689 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:
692 config :pleroma, :admin_token, "somerandomtoken"
698 curl "http://localhost:4000/api/pleroma/admin/users/invites?admin_token=somerandomtoken"
704 curl -H "X-Admin-Token: somerandomtoken" "http://localhost:4000/api/pleroma/admin/users/invites"
709 * `Pleroma.Web.Auth.PleromaAuthenticator`: default database authenticator.
710 * `Pleroma.Web.Auth.LDAPAuthenticator`: LDAP authentication.
712 Authentication / authorization settings.
714 * `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`.
715 * `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`.
716 * `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>`).
718 ### Pleroma.Web.Auth.Authenticator
720 * `Pleroma.Web.Auth.PleromaAuthenticator`: default database authenticator.
721 * `Pleroma.Web.Auth.LDAPAuthenticator`: LDAP authentication.
725 Use LDAP for user authentication. When a user logs in to the Pleroma
726 instance, the name and password will be verified by trying to authenticate
727 (bind) to an LDAP server. If a user exists in the LDAP directory but there
728 is no account with the same name yet on the Pleroma instance then a new
729 Pleroma account will be created with the same name as the LDAP user name.
731 * `enabled`: enables LDAP authentication
732 * `host`: LDAP server hostname
733 * `port`: LDAP port, e.g. 389 or 636
734 * `ssl`: true to use SSL, usually implies the port 636
735 * `sslopts`: additional SSL options
736 * `tls`: true to start TLS, usually implies the port 389
737 * `tlsopts`: additional TLS options
738 * `base`: LDAP base, e.g. "dc=example,dc=com"
739 * `uid`: LDAP attribute name to authenticate the user, e.g. when "cn", the filter will be "cn=username,base"
741 ### OAuth consumer mode
743 OAuth consumer mode allows sign in / sign up via external OAuth providers (e.g. Twitter, Facebook, Google, Microsoft, etc.).
744 Implementation is based on Ueberauth; see the list of [available strategies](https://github.com/ueberauth/ueberauth/wiki/List-of-Strategies).
747 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.
750 Each strategy requires separate setup (on external provider side and Pleroma side). Below are the guidelines on setting up most popular strategies.
753 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"`
755 * For Twitter, [register an app](https://developer.twitter.com/en/apps), configure callback URL to https://<your_host>/oauth/twitter/callback
757 * 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/
759 * For Google, [register an app](https://console.developers.google.com), configure callback URL to https://<your_host>/oauth/google/callback
761 * For Microsoft, [register an app](https://portal.azure.com), configure callback URL to https://<your_host>/oauth/microsoft/callback
763 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`,
764 per strategy's documentation (e.g. [ueberauth_twitter](https://github.com/ueberauth/ueberauth_twitter)). Example config basing on environment variables:
768 config :ueberauth, Ueberauth.Strategy.Twitter.OAuth,
769 consumer_key: System.get_env("TWITTER_CONSUMER_KEY"),
770 consumer_secret: System.get_env("TWITTER_CONSUMER_SECRET")
773 config :ueberauth, Ueberauth.Strategy.Facebook.OAuth,
774 client_id: System.get_env("FACEBOOK_APP_ID"),
775 client_secret: System.get_env("FACEBOOK_APP_SECRET"),
776 redirect_uri: System.get_env("FACEBOOK_REDIRECT_URI")
779 config :ueberauth, Ueberauth.Strategy.Google.OAuth,
780 client_id: System.get_env("GOOGLE_CLIENT_ID"),
781 client_secret: System.get_env("GOOGLE_CLIENT_SECRET"),
782 redirect_uri: System.get_env("GOOGLE_REDIRECT_URI")
785 config :ueberauth, Ueberauth.Strategy.Microsoft.OAuth,
786 client_id: System.get_env("MICROSOFT_CLIENT_ID"),
787 client_secret: System.get_env("MICROSOFT_CLIENT_SECRET")
789 config :ueberauth, Ueberauth,
791 microsoft: {Ueberauth.Strategy.Microsoft, [callback_params: []]}
795 # Note: make sure to add `keycloak:ueberauth_keycloak_strategy` entry to `OAUTH_CONSUMER_STRATEGIES` environment variable
796 keycloak_url = "https://publicly-reachable-keycloak-instance.org:8080"
798 config :ueberauth, Ueberauth.Strategy.Keycloak.OAuth,
799 client_id: System.get_env("KEYCLOAK_CLIENT_ID"),
800 client_secret: System.get_env("KEYCLOAK_CLIENT_SECRET"),
802 authorize_url: "#{keycloak_url}/auth/realms/master/protocol/openid-connect/auth",
803 token_url: "#{keycloak_url}/auth/realms/master/protocol/openid-connect/token",
804 userinfo_url: "#{keycloak_url}/auth/realms/master/protocol/openid-connect/userinfo",
807 config :ueberauth, Ueberauth,
809 keycloak: {Ueberauth.Strategy.Keycloak, [uid_field: :email]}
813 ### OAuth 2.0 provider - :oauth2
815 Configure OAuth 2 provider capabilities:
817 * `token_expires_in` - The lifetime in seconds of the access token.
818 * `issue_new_refresh_token` - Keeps old refresh token or generate new refresh token when to obtain an access token.
819 * `clean_expired_tokens` - Enable a background job to clean expired oauth tokens. Defaults to `false`.
820 * `clean_expired_tokens_interval` - Interval to run the job to clean expired tokens. Defaults to `86_400_000` (24 hours).
825 * `valid_schemes`: List of the scheme part that is considered valid to be an URL.
829 Configuration for the `auto_linker` library:
831 * `class: "auto-linker"` - specify the class to be added to the generated link. false to clear.
832 * `rel: "noopener noreferrer"` - override the rel attribute. false to clear.
833 * `new_window: true` - set to false to remove `target='_blank'` attribute.
834 * `scheme: false` - Set to true to link urls with schema `http://google.com`.
835 * `truncate: false` - Set to a number to truncate urls longer then the number. Truncated urls will end in `..`.
836 * `strip_prefix: true` - Strip the scheme prefix.
837 * `extra: false` - link urls with rarely used schemes (magnet, ipfs, irc, etc.).
853 ## Custom Runtime Modules (`:modules`)
855 * `runtime_dir`: A path to custom Elixir modules (such as MRF policies).
858 ## :configurable_from_database
859 Enable/disable configuration from database.