1 # Configuration Cheat Sheet
3 This is a cheat sheet for Pleroma configuration file, any setting possible to configure should be listed here.
5 For OTP installations the configuration is typically stored in `/etc/pleroma/config.exs`.
7 For from source installations Pleroma configuration works by first importing the base config `config/config.exs`, then overriding it by the environment config `config/$MIX_ENV.exs` and then overriding it by user config `config/$MIX_ENV.secret.exs`. In from source installations you should always make the changes to the user config and NEVER to the base config to avoid breakages and merge conflicts. So for production you change/add configuration to `config/prod.secret.exs`.
9 To add configuration to your config file, you can copy it from the base config. The latest version of it can be viewed [here](https://git.pleroma.social/pleroma/pleroma/blob/develop/config/config.exs). You can also use this file if you don't know how an option is supposed to be formatted.
13 * `enabled` - Enables the backend chat. Defaults to `true`.
16 * `name`: The instance’s name.
17 * `email`: Email used to reach an Administrator/Moderator of the instance.
18 * `notify_email`: Email used for notifications.
19 * `description`: The instance’s description, can be seen in nodeinfo and ``/api/v1/instance``.
20 * `limit`: Posts character limit (CW/Subject included in the counter).
21 * `discription_limit`: The character limit for image descriptions.
22 * `chat_limit`: Character limit of the instance chat messages.
23 * `remote_limit`: Hard character limit beyond which remote posts will be dropped.
24 * `upload_limit`: File size limit of uploads (except for avatar, background, banner).
25 * `avatar_upload_limit`: File size limit of user’s profile avatars.
26 * `background_upload_limit`: File size limit of user’s profile backgrounds.
27 * `banner_upload_limit`: File size limit of user’s profile banners.
28 * `poll_limits`: A map with poll limits for **local** polls.
29 * `max_options`: Maximum number of options.
30 * `max_option_chars`: Maximum number of characters per option.
31 * `min_expiration`: Minimum expiration time (in seconds).
32 * `max_expiration`: Maximum expiration time (in seconds).
33 * `registrations_open`: Enable registrations for anyone, invitations can be enabled when false.
34 * `invites_enabled`: Enable user invitations for admins (depends on `registrations_open: false`).
35 * `account_activation_required`: Require users to confirm their emails before signing in.
36 * `account_approval_required`: Require users to be manually approved by an admin before signing in.
37 * `federating`: Enable federation with other instances.
38 * `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.
39 * `federation_reachability_timeout_days`: Timeout (in days) of each external federation target being unreachable prior to pausing federating to it.
40 * `allow_relay`: Enable Pleroma’s Relay, which makes it possible to follow a whole instance.
41 * `public`: Makes the client API in authenticated mode-only except for user-profiles. Useful for disabling the Local Timeline and The Whole Known Network. See also: `restrict_unauthenticated`.
42 * `quarantined_instances`: List of ActivityPub instances where private(DMs, followers-only) activities will not be send.
43 * `managed_config`: Whenether the config for pleroma-fe is configured in [:frontend_configurations](#frontend_configurations) or in ``static/config.json``.
44 * `allowed_post_formats`: MIME-type list of formats allowed to be posted (transformed into HTML).
45 * `extended_nickname_format`: Set to `true` to use extended local nicknames format (allows underscores/dashes). This will break federation with
46 older software for theses nicknames.
47 * `max_pinned_statuses`: The maximum number of pinned statuses. `0` will disable the feature.
48 * `autofollowed_nicknames`: Set to nicknames of (local) users that every new user should automatically follow.
49 * `attachment_links`: Set to true to enable automatically adding attachment link text to statuses.
50 * `max_report_comment_size`: The maximum size of the report comment (Default: `1000`).
51 * `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`.
52 * `healthcheck`: If set to true, system data will be shown on ``/api/pleroma/healthcheck``.
53 * `remote_post_retention_days`: The default amount of days to retain remote posts when pruning the database.
54 * `user_bio_length`: A user bio maximum length (default: `5000`).
55 * `user_name_length`: A user name maximum length (default: `100`).
56 * `skip_thread_containment`: Skip filter out broken threads. The default is `false`.
57 * `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`.
58 * `max_account_fields`: The maximum number of custom fields in the user profile (default: `10`).
59 * `max_remote_account_fields`: The maximum number of custom fields in the remote user profile (default: `20`).
60 * `account_field_name_length`: An account field name maximum length (default: `512`).
61 * `account_field_value_length`: An account field value maximum length (default: `2048`).
62 * `registration_reason_length`: Maximum registration reason length (default: `500`).
63 * `external_user_synchronization`: Enabling following/followers counters synchronization for external users.
64 * `cleanup_attachments`: Remove attachments along with statuses. Does not affect duplicate files and attachments without status. Enabling this will increase load to database when deleting statuses on larger instances.
67 * `direct_message`: - welcome message sent as a direct message.
68 * `enabled`: Enables the send a direct message to a newly registered user. Defaults to `false`.
69 * `sender_nickname`: The nickname of the local user that sends the welcome message.
70 * `message`: A message that will be send to a newly registered users as a direct message.
71 * `email`: - welcome message sent as a email.
72 * `enabled`: Enables the send a welcome email to a newly registered user. Defaults to `false`.
73 * `sender`: The email address or tuple with `{nickname, email}` that will use as sender to the welcome email.
74 * `subject`: A subject of welcome email.
75 * `html`: A html that will be send to a newly registered users as a email.
76 * `text`: A text that will be send to a newly registered users as a email.
81 config :pleroma, :welcome,
84 sender_nickname: "lain",
85 message: "Hi, @username! Welcome on board!"
89 sender: {"Pleroma App", "welcome@pleroma.app"},
90 subject: "Welcome to <%= instance_name %>",
91 html: "Welcome to <%= instance_name %>",
92 text: "Welcome to <%= instance_name %>"
96 ## Message rewrite facility
99 * `policies`: Message Rewrite Policy, either one or a list. Here are the ones available by default:
100 * `Pleroma.Web.ActivityPub.MRF.NoOpPolicy`: Doesn’t modify activities (default).
101 * `Pleroma.Web.ActivityPub.MRF.DropPolicy`: Drops all activities. It generally doesn’t makes sense to use in production.
102 * `Pleroma.Web.ActivityPub.MRF.SimplePolicy`: Restrict the visibility of activities from certains instances (See [`:mrf_simple`](#mrf_simple)).
103 * `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).
104 * `Pleroma.Web.ActivityPub.MRF.SubchainPolicy`: Selectively runs other MRF policies when messages match (See [`:mrf_subchain`](#mrf_subchain)).
105 * `Pleroma.Web.ActivityPub.MRF.RejectNonPublic`: Drops posts with non-public visibility settings (See [`:mrf_rejectnonpublic`](#mrf_rejectnonpublic)).
106 * `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:.
107 * `Pleroma.Web.ActivityPub.MRF.AntiLinkSpamPolicy`: Rejects posts from likely spambots by rejecting posts from new users that contain links.
108 * `Pleroma.Web.ActivityPub.MRF.MediaProxyWarmingPolicy`: Crawls attachments using their MediaProxy URLs so that the MediaProxy cache is primed.
109 * `Pleroma.Web.ActivityPub.MRF.MentionPolicy`: Drops posts mentioning configurable users. (See [`:mrf_mention`](#mrf_mention)).
110 * `Pleroma.Web.ActivityPub.MRF.VocabularyPolicy`: Restricts activities to a configured set of vocabulary. (See [`:mrf_vocabulary`](#mrf_vocabulary)).
111 * `Pleroma.Web.ActivityPub.MRF.ObjectAgePolicy`: Rejects or delists posts based on their age when received. (See [`:mrf_object_age`](#mrf_object_age)).
112 * `transparency`: Make the content of your Message Rewrite Facility settings public (via nodeinfo).
113 * `transparency_exclusions`: Exclude specific instance names from MRF transparency. The use of the exclusions feature will be disclosed in nodeinfo as a boolean value.
119 Configuring MRF policies is not enough for them to take effect. You have to enable them by specifying their module in `policies` under [:mrf](#mrf) section.
122 * `media_removal`: List of instances to remove media from.
123 * `media_nsfw`: List of instances to put media as NSFW(sensitive) from.
124 * `federated_timeline_removal`: List of instances to remove from Federated (aka The Whole Known Network) Timeline.
125 * `reject`: List of instances to reject any activities from.
126 * `accept`: List of instances to accept any activities from.
127 * `report_removal`: List of instances to reject reports from.
128 * `avatar_removal`: List of instances to strip avatars from.
129 * `banner_removal`: List of instances to strip banners from.
132 This policy processes messages through an alternate pipeline when a given message matches certain criteria.
133 All criteria are configured as a map of regular expressions to lists of policy modules.
135 * `match_actor`: Matches a series of regular expressions against the actor field.
140 config :pleroma, :mrf_subchain,
142 ~r/https:\/\/example.com/s => [Pleroma.Web.ActivityPub.MRF.DropPolicy]
146 #### :mrf_rejectnonpublic
147 * `allow_followersonly`: whether to allow followers-only posts.
148 * `allow_direct`: whether to allow direct messages.
151 * `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.
152 * `reject_threshold`: Number of mentioned users after which the messaged gets rejected. Set to 0 to disable.
155 * `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).
156 * `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).
157 * `replace`: A list of tuples containing `{pattern, replacement}`, `pattern` can be a string or a [regular expression](https://hexdocs.pm/elixir/Regex.html).
160 * `actors`: A list of actors, for which to drop any posts mentioning.
163 * `accept`: A list of ActivityStreams terms to accept. If empty, all supported messages are accepted.
164 * `reject`: A list of ActivityStreams terms to reject. If empty, no messages are rejected.
166 #### :mrf_user_allowlist
168 The keys in this section are the domain names that the policy should apply to.
169 Each key should be assigned a list of users that should be allowed through by
170 their ActivityPub ID.
175 config :pleroma, :mrf_user_allowlist, %{
176 "example.org" => ["https://example.org/users/admin"]
181 * `threshold`: Required time offset (in seconds) compared to your server clock of an incoming post before actions are taken.
182 e.g., A value of 900 results in any post with a timestamp older than 15 minutes will be acted upon.
183 * `actions`: A list of actions to apply to the post:
184 * `:delist` removes the post from public timelines
185 * `:strip_followers` removes followers from the ActivityPub recipient list, ensuring they won't be delivered to home timelines
186 * `:reject` rejects the message entirely
188 #### :mrf_steal_emoji
189 * `hosts`: List of hosts to steal emojis from
190 * `rejected_shortcodes`: Regex-list of shortcodes to reject
191 * `size_limit`: File size limit (in bytes), checked before an emoji is saved to the disk
193 #### :mrf_activity_expiration
195 * `days`: Default global expiration time for all local Create activities (in days)
198 * `unfollow_blocked`: Whether blocks result in people getting unfollowed
199 * `outgoing_blocks`: Whether to federate blocks to other instances
200 * `deny_follow_blocked`: Whether to disallow following an account that has blocked the user in question
201 * `sign_object_fetches`: Sign object fetches with HTTP signatures
202 * `authorized_fetch_mode`: Require HTTP signatures for AP fetches
204 ## Pleroma.ScheduledActivity
206 * `daily_user_limit`: the number of scheduled activities a user is allowed to create in a single day (Default: `25`)
207 * `total_user_limit`: the number of scheduled activities a user is allowed to create in total (Default: `300`)
208 * `enabled`: whether scheduled activities are sent to the job queue to be executed
210 ## Pleroma.ActivityExpiration
212 * `enabled`: whether expired activities will be sent to the job queue to be deleted
216 ### :frontend_configurations
218 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).
220 Frontends can access these settings at `/api/pleroma/frontend_configurations`
222 To add your own configuration for PleromaFE, use it like this:
225 config :pleroma, :frontend_configurations,
227 theme: "pleroma-dark",
228 # ... see /priv/static/static/config.json for the available keys.
231 showInstanceSpecificPanel: true
235 These settings **need to be complete**, they will override the defaults.
239 Render profiles and posts using server-generated HTML that is viewable without using JavaScript.
243 * `enabled` - Enables the rendering of static HTML. Defaults to `false`.
247 This section configures assets to be used with various frontends. Currently the only option
248 relates to mascots on the mastodon frontend
250 * `mascots`: KeywordList of mascots, each element __MUST__ contain both a `url` and a
252 * `default_mascot`: An element from `mascots` - This will be used as the default mascot
253 on MastoFE (default: `:pleroma_fox_tan`).
257 This section describe PWA manifest instance-specific values. Currently this option relate only for MastoFE.
259 * `icons`: Describe the icons of the app, this a list of maps describing icons in the same way as the
260 [spec](https://www.w3.org/TR/appmanifest/#imageresource-and-its-members) describes it.
265 config :pleroma, :manifest,
268 src: "/static/logo.png"
271 src: "/static/icon.png",
275 src: "/static/icon.ico",
276 sizes: "72x72 96x96 128x128 256x256"
281 * `theme_color`: Describe the theme color of the app. (Example: `"#282c37"`, `"rebeccapurple"`).
282 * `background_color`: Describe the background color of the app. (Example: `"#191b22"`, `"aliceblue"`).
286 * `shortcode_globs`: Location of custom emoji files. `*` can be used as a wildcard. Example `["/emoji/custom/**/*.png"]`
287 * `pack_extensions`: A list of file extensions for emojis, when no emoji.txt for a pack is present. Example `[".png", ".gif"]`
288 * `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"]]`
289 * `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).
290 * `shared_pack_cache_seconds_per_file`: When an emoji pack is shared, the archive is created and cached in
291 memory for this amount of seconds multiplied by the number of files.
295 * `enabled`: Enables proxying of remote media to the instance’s proxy
296 * `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.
297 * `proxy_opts`: All options defined in `Pleroma.ReverseProxy` documentation, defaults to `[max_body_length: (25*1_048_576)]`.
298 * `whitelist`: List of hosts with scheme to bypass the mediaproxy (e.g. `https://example.com`)
299 * `invalidation`: options for remove media from cache after delete object:
300 * `enabled`: Enables purge cache
301 * `provider`: Which one of the [purge cache strategy](#purge-cache-strategy) to use.
303 ### Purge cache strategy
305 #### Pleroma.Web.MediaProxy.Invalidation.Script
307 This strategy allow perform external shell script to purge cache.
308 Urls of attachments pass to script as arguments.
310 * `script_path`: path to external script.
315 config :pleroma, Pleroma.Web.MediaProxy.Invalidation.Script,
316 script_path: "./installation/nginx-cache-purge.example"
319 #### Pleroma.Web.MediaProxy.Invalidation.Http
321 This strategy allow perform custom http request to purge cache.
323 * `method`: http method. default is `purge`
324 * `headers`: http headers.
325 * `options`: request options.
329 config :pleroma, Pleroma.Web.MediaProxy.Invalidation.Http,
337 ### Pleroma.Web.Metadata (provider)
338 * `providers`: a list of metadata providers to enable. Providers available:
339 * `Pleroma.Web.Metadata.Providers.OpenGraph`
340 * `Pleroma.Web.Metadata.Providers.TwitterCard`
341 * `Pleroma.Web.Metadata.Providers.RelMe` - add links from user bio with rel=me into the `<header>` as `<link rel=me>`.
342 * `Pleroma.Web.Metadata.Providers.Feed` - add a link to a user's Atom feed into the `<header>` as `<link rel=alternate>`.
343 * `unfurl_nsfw`: If set to `true` nsfw attachments will be shown in previews.
345 ### :rich_media (consumer)
346 * `enabled`: if enabled the instance will parse metadata from attached links to generate link previews.
347 * `ignore_hosts`: list of hosts which will be ignored by the metadata parser. For example `["accounts.google.com", "xss.website"]`, defaults to `[]`.
348 * `ignore_tld`: list TLDs (top-level domains) which will ignore for parse metadata. default is ["local", "localdomain", "lan"].
349 * `parsers`: list of Rich Media parsers.
353 ### Pleroma.Web.Endpoint
356 `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.
358 * `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).
359 - `ip` - a tuple consisting of 4 integers
361 * `url` - a list containing the configuration for generating urls, accepts
362 - `host` - the host without the scheme and a post (e.g `example.com`, not `https://example.com:2020`)
363 - `scheme` - e.g `http`, `https`
366 * `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.
370 config :pleroma, Pleroma.Web.Endpoint,
371 url: [host: "example.com", port: 2020, scheme: "https"],
378 This will make Pleroma listen on `127.0.0.1` port `8080` and generate urls starting with `https://example.com:2020`
381 * ``enabled``: Whether the managed content security policy is enabled.
382 * ``sts``: Whether to additionally send a `Strict-Transport-Security` header.
383 * ``sts_max_age``: The maximum age for the `Strict-Transport-Security` header if sent.
384 * ``ct_max_age``: The maximum age for the `Expect-CT` header if sent.
385 * ``referrer_policy``: The referrer policy to use, either `"same-origin"` or `"no-referrer"`.
386 * ``report_uri``: Adds the specified url to `report-uri` and `report-to` group in CSP header.
388 ### Pleroma.Plugs.RemoteIp
391 If your instance is not behind at least one reverse proxy, you should not enable this plug.
393 `Pleroma.Plugs.RemoteIp` is a shim to call [`RemoteIp`](https://git.pleroma.social/pleroma/remote_ip) but with runtime configuration.
397 * `enabled` - Enable/disable the plug. Defaults to `false`.
398 * `headers` - A list of strings naming the `req_headers` to use when deriving the `remote_ip`. Order does not matter. Defaults to `["x-forwarded-for"]`.
399 * `proxies` - A list of strings in [CIDR](https://en.wikipedia.org/wiki/CIDR) notation specifying the IPs of known proxies. Defaults to `[]`.
400 * `reserved` - Defaults to [localhost](https://en.wikipedia.org/wiki/Localhost) and [private network](https://en.wikipedia.org/wiki/Private_network).
406 If your instance is behind a reverse proxy ensure [`Pleroma.Plugs.RemoteIp`](#pleroma-plugs-remoteip) is enabled (it is enabled by default).
408 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:
410 * The first element: `scale` (Integer). The time scale in milliseconds.
411 * The second element: `limit` (Integer). How many requests to limit in the time scale provided.
413 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.
418 config :pleroma, :rate_limit,
419 authentication: {60_000, 15},
420 search: [{1000, 10}, {1000, 30}]
425 1. In 60 seconds, 15 authentication attempts can be performed from the same IP address.
426 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.
428 Supported rate limiters:
430 * `:search` - Account/Status search.
431 * `:timeline` - Timeline requests (each timeline has it's own limiter).
432 * `:app_account_creation` - Account registration from the API.
433 * `:relations_actions` - Following/Unfollowing in general.
434 * `:relation_id_action` - Following/Unfollowing for a specific user.
435 * `:statuses_actions` - Status actions such as: (un)repeating, (un)favouriting, creating, deleting.
436 * `:status_id_action` - (un)Repeating/(un)Favouriting a particular status.
437 * `:authentication` - Authentication actions, i.e getting an OAuth token.
438 * `:password_reset` - Requesting password reset emails.
439 * `:account_confirmation_resend` - Requesting resending account confirmation emails.
440 * `:ap_routes` - Requesting statuses via ActivityPub.
444 The expiration time for the web responses cache. Values should be in milliseconds or `nil` to disable expiration.
448 * `:activity_pub` - activity pub routes (except question activities). Defaults to `nil` (no expiration).
449 * `:activity_pub_question` - activity pub routes (question activities). Defaults to `30_000` (30 seconds).
455 * `proxy_url`: an upstream proxy to fetch posts and/or media with, (default: `nil`)
456 * `send_user_agent`: should we include a user agent with HTTP requests? (default: `true`)
457 * `user_agent`: what user agent should we use? (default: `:default`), must be string or `:default`
458 * `adapter`: array of adapter options
462 Advanced. Tweaks Hackney (http client) connections pools.
464 There's three pools used:
466 * `:federation` for the federation jobs.
467 You may want this pool max_connections to be at least equal to the number of federator jobs + retry queue jobs.
468 * `:media` for rich media, media proxy
469 * `:upload` for uploaded media (if using a remote uploader and `proxy_remote: true`)
471 For each pool, the options are:
473 * `max_connections` - how much connections a pool can hold
474 * `timeout` - retention duration for connections
477 ### :connections_pool
481 Settings for HTTP connection pool.
483 * `:connection_acquisition_wait` - Timeout to acquire a connection from pool.The total max time is this value multiplied by the number of retries.
484 * `connection_acquisition_retries` - Number of attempts to acquire the connection from the pool if it is overloaded. Each attempt is timed `:connection_acquisition_wait` apart.
485 * `:max_connections` - Maximum number of connections in the pool.
486 * `:await_up_timeout` - Timeout to connect to the host.
487 * `:reclaim_multiplier` - Multiplied by `:max_connections` this will be the maximum number of idle connections that will be reclaimed in case the pool is overloaded.
493 Settings for request pools. These pools are limited on top of `:connections_pool`.
495 There are four pools used:
497 * `:federation` for the federation jobs. You may want this pool's max_connections to be at least equal to the number of federator jobs + retry queue jobs.
498 * `:media` - for rich media, media proxy.
499 * `:upload` - for proxying media when a remote uploader is used and `proxy_remote: true`.
500 * `:default` - for other requests.
502 For each pool, the options are:
504 * `:size` - limit to how much requests can be concurrently executed.
505 * `:timeout` - timeout while `gun` will wait for response
506 * `:max_waiting` - limit to how much requests can be waiting for others to finish, after this is reached, subsequent requests will be dropped.
512 * `enabled`: Whether the captcha should be shown on registration.
513 * `method`: The method/service to use for captcha.
514 * `seconds_valid`: The time in seconds for which the captcha is valid.
516 ### Captcha providers
518 #### Pleroma.Captcha.Native
520 A built-in captcha provider. Enabled by default.
522 #### Pleroma.Captcha.Kocaptcha
524 Kocaptcha is a very simple captcha service with a single API endpoint,
525 the source code is here: [kocaptcha](https://github.com/koto-bank/kocaptcha). The default endpoint
526 `https://captcha.kotobank.ch` is hosted by the developer.
528 * `endpoint`: the Kocaptcha endpoint to use.
534 * `uploader`: Which one of the [uploaders](#uploaders) to use.
535 * `filters`: List of [upload filters](#upload-filters) to use.
536 * `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`
537 * `base_url`: The base URL to access a user-uploaded file. Useful when you want to proxy the media files via another host.
538 * `proxy_remote`: If you're using a remote uploader, Pleroma will proxy media requests instead of redirecting to it.
539 * `proxy_opts`: Proxy options, see `Pleroma.ReverseProxy` documentation.
540 * `filename_display_max_length`: Set max length of a filename to display. 0 = no limit. Default: 30.
543 `strip_exif` has been replaced by `Pleroma.Upload.Filter.Mogrify`.
547 #### Pleroma.Uploaders.Local
549 * `uploads`: Which directory to store the user-uploads in, relative to pleroma’s working directory.
551 #### Pleroma.Uploaders.S3
553 Don't forget to configure [Ex AWS S3](#ex-aws-s3-settings)
555 * `bucket`: S3 bucket name.
556 * `bucket_namespace`: S3 bucket namespace.
557 * `public_endpoint`: S3 endpoint that the user finally accesses(ex. "https://s3.dualstack.ap-northeast-1.amazonaws.com")
558 * `truncated_namespace`: If you use S3 compatible service such as Digital Ocean Spaces or CDN, set folder name or "" etc.
559 For example, when using CDN to S3 virtual host format, set "".
560 At this time, write CNAME to CDN in public_endpoint.
561 * `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.
563 #### Ex AWS S3 settings
565 * `access_key_id`: Access key ID
566 * `secret_access_key`: Secret access key
573 access_key_id: "xxxxxxxxxx",
574 secret_access_key: "yyyyyyyyyy",
575 host: "s3.eu-central-1.amazonaws.com"
580 #### Pleroma.Upload.Filter.AnonymizeFilename
582 This filter replaces the filename (not the path) of an upload. For complete obfuscation, add
583 `Pleroma.Upload.Filter.Dedupe` before AnonymizeFilename.
585 * `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}`.
587 #### Pleroma.Upload.Filter.Dedupe
589 No specific configuration.
591 #### Pleroma.Upload.Filter.Exiftool
593 This filter only strips the GPS and location metadata with Exiftool leaving color profiles and attributes intact.
595 No specific configuration.
597 #### Pleroma.Upload.Filter.Mogrify
599 * `args`: List of actions for the `mogrify` command like `"strip"` or `["strip", "auto-orient", {"implode", "1"}]`.
603 ### Pleroma.Emails.Mailer
604 * `adapter`: one of the mail adapters listed in [Swoosh readme](https://github.com/swoosh/swoosh#adapters), or `Swoosh.Adapters.Local` for in-memory mailbox.
605 * `api_key` / `password` and / or other adapter-specific settings, per the above documentation.
606 * `enabled`: Allows enable/disable send emails. Default: `false`.
608 An example for Sendgrid adapter:
611 config :pleroma, Pleroma.Emails.Mailer,
613 adapter: Swoosh.Adapters.Sendgrid,
614 api_key: "YOUR_API_KEY"
617 An example for SMTP adapter:
620 config :pleroma, Pleroma.Emails.Mailer,
622 adapter: Swoosh.Adapters.SMTP,
623 relay: "smtp.gmail.com",
624 username: "YOUR_USERNAME@gmail.com",
625 password: "YOUR_SMTP_PASSWORD",
631 ### :email_notifications
633 Email notifications settings.
635 - digest - emails of "what you've missed" for users who have been
636 inactive for a while.
637 - active: globally enable or disable digest emails
638 - schedule: When to send digest email, in [crontab format](https://en.wikipedia.org/wiki/Cron).
639 "0 0 * * 0" is the default, meaning "once a week at midnight on Sunday morning"
640 - interval: Minimum interval between digest emails to one user
641 - inactivity_threshold: Minimum user inactivity threshold
643 ### Pleroma.Emails.UserEmail
645 - `:logo` - a path to a custom logo. Set it to `nil` to use the default Pleroma logo.
646 - `:styling` - a map with color settings for email templates.
648 ### Pleroma.Emails.NewUsersDigestEmail
650 - `:enabled` - a boolean, enables new users admin digest email when `true`. Defaults to `false`.
656 [Oban](https://github.com/sorentwo/oban) asynchronous job processor configuration.
658 Configuration options described in [Oban readme](https://github.com/sorentwo/oban#usage):
660 * `repo` - app's Ecto repo (`Pleroma.Repo`)
661 * `log` - logs verbosity
662 * `queues` - job queues (see below)
663 * `crontab` - periodic jobs, see [`Oban.Cron`](#obancron)
665 Pleroma has the following queues:
667 * `activity_expiration` - Activity expiration
668 * `federator_outgoing` - Outgoing federation
669 * `federator_incoming` - Incoming federation
670 * `mailer` - Email sender, see [`Pleroma.Emails.Mailer`](#pleromaemailsmailer)
671 * `transmogrifier` - Transmogrifier
672 * `web_push` - Web push notifications
673 * `scheduled_activities` - Scheduled activities, see [`Pleroma.ScheduledActivity`](#pleromascheduledactivity)
677 Pleroma has these periodic job workers:
679 `Pleroma.Workers.Cron.ClearOauthTokenWorker` - a job worker to cleanup expired oauth tokens.
684 config :pleroma, Oban,
687 prune: {:maxlen, 1500},
689 federator_incoming: 50,
690 federator_outgoing: 50
693 {"0 0 * * *", Pleroma.Workers.Cron.ClearOauthTokenWorker}
697 This config contains two queues: `federator_incoming` and `federator_outgoing`. Both have the number of max concurrent jobs set to `50`.
699 #### Migrating `pleroma_job_queue` settings
701 `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).
705 Includes custom worker options not interpretable directly by `Oban`.
707 * `retries` — keyword lists where keys are `Oban` queues (see above) and values are numbers of max attempts for failed jobs.
712 config :pleroma, :workers,
714 federator_incoming: 5,
715 federator_outgoing: 5
719 #### Migrating `Pleroma.Web.Federator.RetryQueue` settings
721 * `max_retries` is replaced with `config :pleroma, :workers, retries: [federator_outgoing: 5]`
722 * `enabled: false` corresponds to `config :pleroma, :workers, retries: [federator_outgoing: 1]`
723 * deprecated options: `max_jobs`, `initial_timeout`
725 ## :web_push_encryption, :vapid_details
727 Web Push Notifications configuration. You can use the mix task `mix web_push.gen.keypair` to generate it.
729 * ``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.
730 * ``public_key``: VAPID public key
731 * ``private_key``: VAPID private key
734 * `backends`: `:console` is used to send logs to stdout, `{ExSyslogger, :ex_syslogger}` to log to syslog, and `Quack.Logger` to log to Slack
736 An example to enable ONLY ExSyslogger (f/ex in ``prod.secret.exs``) with info and debug suppressed:
739 backends: [{ExSyslogger, :ex_syslogger}]
741 config :logger, :ex_syslogger,
745 Another example, keeping console output and adding the pid to syslog output:
748 backends: [:console, {ExSyslogger, :ex_syslogger}]
750 config :logger, :ex_syslogger,
752 option: [:pid, :ndelay]
755 See: [logger’s documentation](https://hexdocs.pm/logger/Logger.html) and [ex_syslogger’s documentation](https://hexdocs.pm/ex_syslogger/)
757 An example of logging info to local syslog, but warn to a Slack channel:
760 backends: [ {ExSyslogger, :ex_syslogger}, Quack.Logger ],
763 config :logger, :ex_syslogger,
766 format: "$metadata[$level] $message"
771 webhook_url: "https://hooks.slack.com/services/YOUR-API-KEY-HERE"
774 See the [Quack Github](https://github.com/azohra/quack) for more details
780 ### RUM indexing for full text search
783 It is recommended to use PostgreSQL v11 or newer. We have seen some minor issues with lower PostgreSQL versions.
785 * `rum_enabled`: If RUM indexes should be used. Defaults to `false`.
787 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.
789 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.
791 To enable them, both the `rum_enabled` flag has to be set and the following special migration has to be run:
793 `mix ecto.migrate --migrations-path priv/repo/optional_migrations/rum_indexing/`
795 This will probably take a long time.
797 ## Alternative client protocols
801 To enable simple command line interface accessible over ssh, add a setting like this to your configuration file:
805 priv_dir = Path.join([app_dir, "priv/ssh_keys"])
810 handler: "Pleroma.BBS.Handler",
812 password_authenticator: "Pleroma.BBS.Authenticator"
815 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`
818 * `enabled`: Enables the gopher interface
819 * `ip`: IP address to bind to
820 * `port`: Port to bind to
821 * `dstport`: Port advertised in urls (optional, defaults to `port`)
828 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:
831 config :pleroma, :admin_token, "somerandomtoken"
837 curl "http://localhost:4000/api/pleroma/admin/users/invites?admin_token=somerandomtoken"
843 curl -H "X-Admin-Token: somerandomtoken" "http://localhost:4000/api/pleroma/admin/users/invites"
846 Warning: it's discouraged to use this feature because of the associated security risk: static / rarely changed instance-wide token is much weaker compared to email-password pair of a real admin user; consider using HTTP Basic Auth or OAuth-based authentication instead.
850 * `Pleroma.Web.Auth.PleromaAuthenticator`: default database authenticator.
851 * `Pleroma.Web.Auth.LDAPAuthenticator`: LDAP authentication.
853 Authentication / authorization settings.
855 * `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`.
856 * `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`.
857 * `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>`).
859 ### Pleroma.Web.Auth.Authenticator
861 * `Pleroma.Web.Auth.PleromaAuthenticator`: default database authenticator.
862 * `Pleroma.Web.Auth.LDAPAuthenticator`: LDAP authentication.
866 Use LDAP for user authentication. When a user logs in to the Pleroma
867 instance, the name and password will be verified by trying to authenticate
868 (bind) to an LDAP server. If a user exists in the LDAP directory but there
869 is no account with the same name yet on the Pleroma instance then a new
870 Pleroma account will be created with the same name as the LDAP user name.
872 * `enabled`: enables LDAP authentication
873 * `host`: LDAP server hostname
874 * `port`: LDAP port, e.g. 389 or 636
875 * `ssl`: true to use SSL, usually implies the port 636
876 * `sslopts`: additional SSL options
877 * `tls`: true to start TLS, usually implies the port 389
878 * `tlsopts`: additional TLS options
879 * `base`: LDAP base, e.g. "dc=example,dc=com"
880 * `uid`: LDAP attribute name to authenticate the user, e.g. when "cn", the filter will be "cn=username,base"
882 ### OAuth consumer mode
884 OAuth consumer mode allows sign in / sign up via external OAuth providers (e.g. Twitter, Facebook, Google, Microsoft, etc.).
885 Implementation is based on Ueberauth; see the list of [available strategies](https://github.com/ueberauth/ueberauth/wiki/List-of-Strategies).
888 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.
891 Each strategy requires separate setup (on external provider side and Pleroma side). Below are the guidelines on setting up most popular strategies.
894 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"`
896 * For Twitter, [register an app](https://developer.twitter.com/en/apps), configure callback URL to https://<your_host>/oauth/twitter/callback
898 * 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/
900 * For Google, [register an app](https://console.developers.google.com), configure callback URL to https://<your_host>/oauth/google/callback
902 * For Microsoft, [register an app](https://portal.azure.com), configure callback URL to https://<your_host>/oauth/microsoft/callback
904 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`,
905 per strategy's documentation (e.g. [ueberauth_twitter](https://github.com/ueberauth/ueberauth_twitter)). Example config basing on environment variables:
909 config :ueberauth, Ueberauth.Strategy.Twitter.OAuth,
910 consumer_key: System.get_env("TWITTER_CONSUMER_KEY"),
911 consumer_secret: System.get_env("TWITTER_CONSUMER_SECRET")
914 config :ueberauth, Ueberauth.Strategy.Facebook.OAuth,
915 client_id: System.get_env("FACEBOOK_APP_ID"),
916 client_secret: System.get_env("FACEBOOK_APP_SECRET"),
917 redirect_uri: System.get_env("FACEBOOK_REDIRECT_URI")
920 config :ueberauth, Ueberauth.Strategy.Google.OAuth,
921 client_id: System.get_env("GOOGLE_CLIENT_ID"),
922 client_secret: System.get_env("GOOGLE_CLIENT_SECRET"),
923 redirect_uri: System.get_env("GOOGLE_REDIRECT_URI")
926 config :ueberauth, Ueberauth.Strategy.Microsoft.OAuth,
927 client_id: System.get_env("MICROSOFT_CLIENT_ID"),
928 client_secret: System.get_env("MICROSOFT_CLIENT_SECRET")
930 config :ueberauth, Ueberauth,
932 microsoft: {Ueberauth.Strategy.Microsoft, [callback_params: []]}
936 # Note: make sure to add `keycloak:ueberauth_keycloak_strategy` entry to `OAUTH_CONSUMER_STRATEGIES` environment variable
937 keycloak_url = "https://publicly-reachable-keycloak-instance.org:8080"
939 config :ueberauth, Ueberauth.Strategy.Keycloak.OAuth,
940 client_id: System.get_env("KEYCLOAK_CLIENT_ID"),
941 client_secret: System.get_env("KEYCLOAK_CLIENT_SECRET"),
943 authorize_url: "#{keycloak_url}/auth/realms/master/protocol/openid-connect/auth",
944 token_url: "#{keycloak_url}/auth/realms/master/protocol/openid-connect/token",
945 userinfo_url: "#{keycloak_url}/auth/realms/master/protocol/openid-connect/userinfo",
948 config :ueberauth, Ueberauth,
950 keycloak: {Ueberauth.Strategy.Keycloak, [uid_field: :email]}
954 ### OAuth 2.0 provider - :oauth2
956 Configure OAuth 2 provider capabilities:
958 * `token_expires_in` - The lifetime in seconds of the access token.
959 * `issue_new_refresh_token` - Keeps old refresh token or generate new refresh token when to obtain an access token.
960 * `clean_expired_tokens` - Enable a background job to clean expired oauth tokens. Defaults to `false`. Interval settings sets in configuration periodic jobs [`Oban.Cron`](#obancron)
965 * `valid_schemes`: List of the scheme part that is considered valid to be an URL.
967 ### Pleroma.Formatter
969 Configuration for Pleroma's link formatter which parses mentions, hashtags, and URLs.
971 * `class` - specify the class to be added to the generated link (default: `false`)
972 * `rel` - specify the rel attribute (default: `ugc`)
973 * `new_window` - adds `target="_blank"` attribute (default: `false`)
974 * `truncate` - Set to a number to truncate URLs longer then the number. Truncated URLs will end in `...` (default: `false`)
975 * `strip_prefix` - Strip the scheme prefix (default: `false`)
976 * `extra` - link URLs with rarely used schemes (magnet, ipfs, irc, etc.) (default: `true`)
977 * `validate_tld` - Set to false to disable TLD validation for URLs/emails. Can be set to :no_scheme to validate TLDs only for urls without a scheme (e.g `example.com` will be validated, but `http://example.loki` won't) (default: `:no_scheme`)
982 config :pleroma, Pleroma.Formatter,
989 validate_tld: :no_scheme
992 ## Custom Runtime Modules (`:modules`)
994 * `runtime_dir`: A path to custom Elixir modules (such as MRF policies).
996 ## :configurable_from_database
998 Boolean, enables/disables in-database configuration. Read [Transfering the config to/from the database](../administration/CLI_tasks/config.md) for more information.
1000 ## :database_config_whitelist
1002 List of valid configuration sections which are allowed to be configured from the
1003 database. Settings stored in the database before the whitelist is configured are
1004 still applied, so it is suggested to only use the whitelist on instances that
1005 have not migrated the config to the database.
1009 config :pleroma, :database_config_whitelist, [
1010 {:pleroma, :instance},
1011 {:pleroma, Pleroma.Web.Metadata},
1016 ### Multi-factor authentication - :two_factor_authentication
1017 * `totp` - a list containing TOTP configuration
1018 - `digits` - Determines the length of a one-time pass-code in characters. Defaults to 6 characters.
1019 - `period` - a period for which the TOTP code will be valid in seconds. Defaults to 30 seconds.
1020 * `backup_codes` - a list containing backup codes configuration
1021 - `number` - number of backup codes to generate.
1022 - `length` - backup code length. Defaults to 16 characters.
1024 ## Restrict entities access for unauthenticated users
1026 ### :restrict_unauthenticated
1028 Restrict access for unauthenticated users to timelines (public and federated), user profiles and statuses.
1030 * `timelines`: public and federated timelines
1031 * `local`: public timeline
1032 * `federated`: federated timeline (includes public timeline)
1033 * `profiles`: user profiles
1036 * `activities`: statuses
1040 Note: setting `restrict_unauthenticated/timelines/local` to `true` has no practical sense if `restrict_unauthenticated/timelines/federated` is set to `false` (since local public activities will still be delivered to unauthenticated users as part of federated timeline).
1042 ## Pleroma.Web.ApiSpec.CastAndValidate
1044 * `:strict` a boolean, enables strict input validation (useful in development, not recommended in production). Defaults to `false`.
1046 ## :instances_favicons
1048 Control favicons for instances.
1050 * `enabled`: Allow/disallow displaying and getting instances favicons