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).
11 * `uploader`: Select which `Pleroma.Uploaders` to use
12 * `filters`: List of `Pleroma.Upload.Filter` to use.
13 * `link_name`: When enabled Pleroma will add a `name` parameter to the url of the upload, for example `https://instance.tld/media/corndog.png?name=corndog.png`. This is needed to provide the correct filename in Content-Disposition headers when using filters like `Pleroma.Upload.Filter.Dedupe`
14 * `base_url`: The base URL to access a user-uploaded file. Useful when you want to proxy the media files via another host.
15 * `proxy_remote`: If you're using a remote uploader, Pleroma will proxy media requests instead of redirecting to it.
16 * `proxy_opts`: Proxy options, see `Pleroma.ReverseProxy` documentation.
18 Note: `strip_exif` has been replaced by `Pleroma.Upload.Filter.Mogrify`.
20 ## Pleroma.Uploaders.Local
21 * `uploads`: Which directory to store the user-uploads in, relative to pleroma’s working directory
23 ## Pleroma.Uploaders.S3
24 * `bucket`: S3 bucket name
25 * `bucket_namespace`: S3 bucket namespace
26 * `public_endpoint`: S3 endpoint that the user finally accesses(ex. "https://s3.dualstack.ap-northeast-1.amazonaws.com")
27 * `truncated_namespace`: If you use S3 compatible service such as Digital Ocean Spaces or CDN, set folder name or "" etc.
28 For example, when using CDN to S3 virtual host format, set "".
29 At this time, write CNAME to CDN in public_endpoint.
30 * `streaming_enabled`: Enable streaming uploads, when enabled the file will be sent to the server in chunks as it's being read. This may be unsupported by some providers, try disabling this if you have upload problems.
32 ## Pleroma.Upload.Filter.Mogrify
34 * `args`: List of actions for the `mogrify` command like `"strip"` or `["strip", "auto-orient", {"implode", "1"}]`.
36 ## Pleroma.Upload.Filter.Dedupe
38 No specific configuration.
40 ## Pleroma.Upload.Filter.AnonymizeFilename
42 This filter replaces the filename (not the path) of an upload. For complete obfuscation, add
43 `Pleroma.Upload.Filter.Dedupe` before AnonymizeFilename.
45 * `text`: Text to replace filenames in links. If empty, `{random}.extension` will be used. You can get the original filename extension by using `{extension}`, for example `custom-file-name.{extension}`.
47 ## Pleroma.Emails.Mailer
48 * `adapter`: one of the mail adapters listed in [Swoosh readme](https://github.com/swoosh/swoosh#adapters), or `Swoosh.Adapters.Local` for in-memory mailbox.
49 * `api_key` / `password` and / or other adapter-specific settings, per the above documentation.
50 * `enabled`: Allows enable/disable send emails. Default: `false`.
52 An example for Sendgrid adapter:
55 config :pleroma, Pleroma.Emails.Mailer,
56 adapter: Swoosh.Adapters.Sendgrid,
57 api_key: "YOUR_API_KEY"
60 An example for SMTP adapter:
63 config :pleroma, Pleroma.Emails.Mailer,
64 adapter: Swoosh.Adapters.SMTP,
65 relay: "smtp.gmail.com",
66 username: "YOUR_USERNAME@gmail.com",
67 password: "YOUR_SMTP_PASSWORD",
75 * `valid_schemes`: List of the scheme part that is considered valid to be an URL
78 * `name`: The instance’s name
79 * `email`: Email used to reach an Administrator/Moderator of the instance
80 * `notify_email`: Email used for notifications.
81 * `description`: The instance’s description, can be seen in nodeinfo and ``/api/v1/instance``
82 * `limit`: Posts character limit (CW/Subject included in the counter)
83 * `remote_limit`: Hard character limit beyond which remote posts will be dropped.
84 * `upload_limit`: File size limit of uploads (except for avatar, background, banner)
85 * `avatar_upload_limit`: File size limit of user’s profile avatars
86 * `background_upload_limit`: File size limit of user’s profile backgrounds
87 * `banner_upload_limit`: File size limit of user’s profile banners
88 * `poll_limits`: A map with poll limits for **local** polls
89 * `max_options`: Maximum number of options
90 * `max_option_chars`: Maximum number of characters per option
91 * `min_expiration`: Minimum expiration time (in seconds)
92 * `max_expiration`: Maximum expiration time (in seconds)
93 * `registrations_open`: Enable registrations for anyone, invitations can be enabled when false.
94 * `invites_enabled`: Enable user invitations for admins (depends on `registrations_open: false`).
95 * `account_activation_required`: Require users to confirm their emails before signing in.
96 * `federating`: Enable federation with other instances
97 * `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.
98 * `federation_reachability_timeout_days`: Timeout (in days) of each external federation target being unreachable prior to pausing federating to it.
99 * `allow_relay`: Enable Pleroma’s Relay, which makes it possible to follow a whole instance
100 * `rewrite_policy`: Message Rewrite Policy, either one or a list. Here are the ones available by default:
101 * `Pleroma.Web.ActivityPub.MRF.NoOpPolicy`: Doesn’t modify activities (default)
102 * `Pleroma.Web.ActivityPub.MRF.DropPolicy`: Drops all activities. It generally doesn’t makes sense to use in production
103 * `Pleroma.Web.ActivityPub.MRF.SimplePolicy`: Restrict the visibility of activities from certains instances (See ``:mrf_simple`` section)
104 * `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)
105 * `Pleroma.Web.ActivityPub.MRF.SubchainPolicy`: Selectively runs other MRF policies when messages match (see ``:mrf_subchain`` section)
106 * `Pleroma.Web.ActivityPub.MRF.RejectNonPublic`: Drops posts with non-public visibility settings (See ``:mrf_rejectnonpublic`` section)
107 * `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:.
108 * `Pleroma.Web.ActivityPub.MRF.AntiLinkSpamPolicy`: Rejects posts from likely spambots by rejecting posts from new users that contain links.
109 * `Pleroma.Web.ActivityPub.MRF.MediaProxyWarmingPolicy`: Crawls attachments using their MediaProxy URLs so that the MediaProxy cache is primed.
110 * `Pleroma.Web.ActivityPub.MRF.MentionPolicy`: Drops posts mentioning configurable users. (see `:mrf_mention` section)
111 * `Pleroma.Web.ActivityPub.MRF.VocabularyPolicy`: Restricts activities to a configured set of vocabulary. (see `:mrf_vocabulary` section)
112 * `public`: Makes the client API in authentificated mode-only except for user-profiles. Useful for disabling the Local Timeline and The Whole Known Network.
113 * `quarantined_instances`: List of ActivityPub instances where private(DMs, followers-only) activities will not be send.
114 * `managed_config`: Whenether the config for pleroma-fe is configured in this config or in ``static/config.json``
115 * `allowed_post_formats`: MIME-type list of formats allowed to be posted (transformed into HTML)
116 * `mrf_transparency`: Make the content of your Message Rewrite Facility settings public (via nodeinfo).
117 * `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.
118 * `scope_copy`: Copy the scope (private/unlisted/public) in replies to posts by default.
119 * `subject_line_behavior`: Allows changing the default behaviour of subject lines in replies. Valid values:
120 * "email": Copy and preprend re:, as in email.
121 * "masto": Copy verbatim, as in Mastodon.
122 * "noop": Don't copy the subject.
123 * `always_show_subject_input`: When set to false, auto-hide the subject field when it's empty.
124 * `extended_nickname_format`: Set to `true` to use extended local nicknames format (allows underscores/dashes). This will break federation with
125 older software for theses nicknames.
126 * `max_pinned_statuses`: The maximum number of pinned statuses. `0` will disable the feature.
127 * `autofollowed_nicknames`: Set to nicknames of (local) users that every new user should automatically follow.
128 * `no_attachment_links`: Set to true to disable automatically adding attachment link text to statuses
129 * `welcome_message`: A message that will be send to a newly registered users as a direct message.
130 * `welcome_user_nickname`: The nickname of the local user that sends the welcome message.
131 * `max_report_comment_size`: The maximum size of the report comment (Default: `1000`)
132 * `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`.
133 * `healthcheck`: If set to true, system data will be shown on ``/api/pleroma/healthcheck``.
134 * `remote_post_retention_days`: The default amount of days to retain remote posts when pruning the database.
135 * `user_bio_length`: A user bio maximum length (default: `5000`)
136 * `user_name_length`: A user name maximum length (default: `100`)
137 * `skip_thread_containment`: Skip filter out broken threads. The default is `false`.
138 * `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`.
139 * `dynamic_configuration`: Allow transferring configuration to DB with the subsequent customization from Admin api.
140 * `max_account_fields`: The maximum number of custom fields in the user profile (default: `10`)
141 * `max_remote_account_fields`: The maximum number of custom fields in the remote user profile (default: `20`)
142 * `account_field_name_length`: An account field name maximum length (default: `512`)
143 * `account_field_value_length`: An account field value maximum length (default: `2048`)
144 * `external_user_synchronization`: Enabling following/followers counters synchronization for external users.
149 * `backends`: `:console` is used to send logs to stdout, `{ExSyslogger, :ex_syslogger}` to log to syslog, and `Quack.Logger` to log to Slack
151 An example to enable ONLY ExSyslogger (f/ex in ``prod.secret.exs``) with info and debug suppressed:
154 backends: [{ExSyslogger, :ex_syslogger}]
156 config :logger, :ex_syslogger,
160 Another example, keeping console output and adding the pid to syslog output:
163 backends: [:console, {ExSyslogger, :ex_syslogger}]
165 config :logger, :ex_syslogger,
167 option: [:pid, :ndelay]
170 See: [logger’s documentation](https://hexdocs.pm/logger/Logger.html) and [ex_syslogger’s documentation](https://hexdocs.pm/ex_syslogger/)
172 An example of logging info to local syslog, but warn to a Slack channel:
175 backends: [ {ExSyslogger, :ex_syslogger}, Quack.Logger ],
178 config :logger, :ex_syslogger,
181 format: "$metadata[$level] $message"
186 webhook_url: "https://hooks.slack.com/services/YOUR-API-KEY-HERE"
189 See the [Quack Github](https://github.com/azohra/quack) for more details
191 ## :frontend_configurations
193 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.
195 Frontends can access these settings at `/api/pleroma/frontend_configurations`
197 To add your own configuration for PleromaFE, use it like this:
200 config :pleroma, :frontend_configurations,
202 theme: "pleroma-dark",
203 # ... see /priv/static/static/config.json for the available keys.
206 showInstanceSpecificPanel: true
210 These settings **need to be complete**, they will override the defaults.
212 NOTE: for versions < 1.0, you need to set [`:fe`](#fe) to false, as shown a few lines below.
216 __THIS IS DEPRECATED__
218 If you are using this method, please change it to the [`frontend_configurations`](#frontend_configurations) method.
219 Please **set this option to false** in your config like this:
222 config :pleroma, :fe, false
225 This section is used to configure Pleroma-FE, unless ``:managed_config`` in ``:instance`` is set to false.
227 * `theme`: Which theme to use, they are defined in ``styles.json``
228 * `logo`: URL of the logo, defaults to Pleroma’s logo
229 * `logo_mask`: Whether to use only the logo's shape as a mask (true) or as a regular image (false)
230 * `logo_margin`: What margin to use around the logo
231 * `background`: URL of the background, unless viewing a user profile with a background that is set
232 * `redirect_root_no_login`: relative URL which indicates where to redirect when a user isn’t logged in.
233 * `redirect_root_login`: relative URL which indicates where to redirect when a user is logged in.
234 * `show_instance_panel`: Whenether to show the instance’s specific panel.
235 * `scope_options_enabled`: Enable setting an notice visibility and subject/CW when posting
236 * `formatting_options_enabled`: Enable setting a formatting different than plain-text (ie. HTML, Markdown) when posting, relates to ``:instance, allowed_post_formats``
237 * `collapse_message_with_subjects`: When a message has a subject(aka Content Warning), collapse it by default
238 * `hide_post_stats`: Hide notices statistics(repeats, favorites, …)
239 * `hide_user_stats`: Hide profile statistics(posts, posts per day, followers, followings, …)
243 This section configures assets to be used with various frontends. Currently the only option
244 relates to mascots on the mastodon frontend
246 * `mascots`: KeywordList of mascots, each element __MUST__ contain both a `url` and a
248 * `default_mascot`: An element from `mascots` - This will be used as the default mascot
249 on MastoFE (default: `:pleroma_fox_tan`)
252 * `media_removal`: List of instances to remove medias from
253 * `media_nsfw`: List of instances to put medias as NSFW(sensitive) from
254 * `federated_timeline_removal`: List of instances to remove from Federated (aka The Whole Known Network) Timeline
255 * `reject`: List of instances to reject any activities from
256 * `accept`: List of instances to accept any activities from
257 * `report_removal`: List of instances to reject reports from
258 * `avatar_removal`: List of instances to strip avatars from
259 * `banner_removal`: List of instances to strip banners from
262 This policy processes messages through an alternate pipeline when a given message matches certain criteria.
263 All criteria are configured as a map of regular expressions to lists of policy modules.
265 * `match_actor`: Matches a series of regular expressions against the actor field.
270 config :pleroma, :mrf_subchain,
272 ~r/https:\/\/example.com/s => [Pleroma.Web.ActivityPub.MRF.DropPolicy]
276 ## :mrf_rejectnonpublic
277 * `allow_followersonly`: whether to allow followers-only posts
278 * `allow_direct`: whether to allow direct messages
281 * `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.
282 * `reject_threshold`: Number of mentioned users after which the messaged gets rejected. Set to 0 to disable.
285 * `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)
286 * `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)
287 * `replace`: A list of tuples containing `{pattern, replacement}`, `pattern` can be a string or a [regular expression](https://hexdocs.pm/elixir/Regex.html)
290 * `actors`: A list of actors, for which to drop any posts mentioning.
293 * `accept`: A list of ActivityStreams terms to accept. If empty, all supported messages are accepted.
294 * `reject`: A list of ActivityStreams terms to reject. If empty, no messages are rejected.
297 * `enabled`: Enables proxying of remote media to the instance’s proxy
298 * `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.
299 * `proxy_opts`: All options defined in `Pleroma.ReverseProxy` documentation, defaults to `[max_body_length: (25*1_048_576)]`.
300 * `whitelist`: List of domains to bypass the mediaproxy
303 * `enabled`: Enables the gopher interface
304 * `ip`: IP address to bind to
305 * `port`: Port to bind to
306 * `dstport`: Port advertised in urls (optional, defaults to `port`)
308 ## Pleroma.Web.Endpoint
309 `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
310 * `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).
311 - `ip` - a tuple consisting of 4 integers
313 * `url` - a list containing the configuration for generating urls, accepts
314 - `host` - the host without the scheme and a post (e.g `example.com`, not `https://example.com:2020`)
315 - `scheme` - e.g `http`, `https`
318 * `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.
322 **Important note**: if you modify anything inside these lists, default `config.exs` values will be overwritten, which may result in breakage, to make sure this does not happen please copy the default value for the list from `config.exs` and modify/add only what you need
326 config :pleroma, Pleroma.Web.Endpoint,
327 url: [host: "example.com", port: 2020, scheme: "https"],
329 # start copied from config.exs
333 {"/api/v1/streaming", Pleroma.Web.MastodonAPI.WebsocketHandler, []},
334 {"/websocket", Phoenix.Endpoint.CowboyWebSocket,
335 {Phoenix.Transports.WebSocket,
336 {Pleroma.Web.Endpoint, Pleroma.Web.UserSocket, websocket_config}}},
337 {:_, Phoenix.Endpoint.Cowboy2Handler, {Pleroma.Web.Endpoint, []}}
339 # end copied from config.exs
346 This will make Pleroma listen on `127.0.0.1` port `8080` and generate urls starting with `https://example.com:2020`
349 * ``unfollow_blocked``: Whether blocks result in people getting unfollowed
350 * ``outgoing_blocks``: Whether to federate blocks to other instances
351 * ``deny_follow_blocked``: Whether to disallow following an account that has blocked the user in question
352 * ``sign_object_fetches``: Sign object fetches with HTTP signatures
355 * ``enabled``: Whether the managed content security policy is enabled
356 * ``sts``: Whether to additionally send a `Strict-Transport-Security` header
357 * ``sts_max_age``: The maximum age for the `Strict-Transport-Security` header if sent
358 * ``ct_max_age``: The maximum age for the `Expect-CT` header if sent
359 * ``referrer_policy``: The referrer policy to use, either `"same-origin"` or `"no-referrer"`
360 * ``report_uri``: Adds the specified url to `report-uri` and `report-to` group in CSP header.
362 ## :mrf_user_allowlist
364 The keys in this section are the domain names that the policy should apply to.
365 Each key should be assigned a list of users that should be allowed through by
366 their ActivityPub ID.
371 config :pleroma, :mrf_user_allowlist,
372 "example.org": ["https://example.org/users/admin"]
375 ## :web_push_encryption, :vapid_details
377 Web Push Notifications configuration. You can use the mix task `mix web_push.gen.keypair` to generate it.
379 * ``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.
380 * ``public_key``: VAPID public key
381 * ``private_key``: VAPID private key
384 * `enabled`: Whether the captcha should be shown on registration
385 * `method`: The method/service to use for captcha
386 * `seconds_valid`: The time in seconds for which the captcha is valid
388 ### Pleroma.Captcha.Kocaptcha
389 Kocaptcha is a very simple captcha service with a single API endpoint,
390 the source code is here: https://github.com/koto-bank/kocaptcha. The default endpoint
391 `https://captcha.kotobank.ch` is hosted by the developer.
393 * `endpoint`: the kocaptcha endpoint to use
397 Allows to set a token that can be used to authenticate with the admin api without using an actual user by giving it as the 'admin_token' parameter. Example:
400 config :pleroma, :admin_token, "somerandomtoken"
406 curl "http://localhost:4000/api/pleroma/admin/invite_token?admin_token=somerandomtoken"
411 [Oban](https://github.com/sorentwo/oban) asynchronous job processor configuration.
413 Configuration options described in [Oban readme](https://github.com/sorentwo/oban#usage):
414 * `repo` - app's Ecto repo (`Pleroma.Repo`)
415 * `verbose` - logs verbosity
416 * `prune` - non-retryable jobs [pruning settings](https://github.com/sorentwo/oban#pruning) (`:disabled` / `{:maxlen, value}` / `{:maxage, value}`)
417 * `queues` - job queues (see below)
419 Pleroma has the following queues:
421 * `activity_expiration` - Activity expiration
422 * `federator_outgoing` - Outgoing federation
423 * `federator_incoming` - Incoming federation
424 * `mailer` - Email sender, see [`Pleroma.Emails.Mailer`](#pleromaemailsmailer)
425 * `transmogrifier` - Transmogrifier
426 * `web_push` - Web push notifications
427 * `scheduled_activities` - Scheduled activities, see [`Pleroma.ScheduledActivity`](#pleromascheduledactivity)
432 config :pleroma, Oban,
435 prune: {:maxlen, 1500},
437 federator_incoming: 50,
438 federator_outgoing: 50
442 This config contains two queues: `federator_incoming` and `federator_outgoing`. Both have the number of max concurrent jobs set to `50`.
444 ### Migrating `pleroma_job_queue` settings
446 `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).
448 ### Note on running with PostgreSQL in silent mode
450 If you are running PostgreSQL in [`silent_mode`](https://postgresqlco.nf/en/doc/param/silent_mode?version=9.1), it's advised to set [`log_destination`](https://postgresqlco.nf/en/doc/param/log_destination?version=9.1) to `syslog`,
451 otherwise `postmaster.log` file may grow because of "you don't own a lock of type ShareLock" warnings (see https://github.com/sorentwo/oban/issues/52).
455 Includes custom worker options not interpretable directly by `Oban`.
457 * `retries` — keyword lists where keys are `Oban` queues (see above) and values are numbers of max attempts for failed jobs.
462 config :pleroma, :workers,
464 federator_incoming: 5,
465 federator_outgoing: 5
469 ### Migrating `Pleroma.Web.Federator.RetryQueue` settings
471 * `max_retries` is replaced with `config :pleroma, :workers, retries: [federator_outgoing: 5]`
472 * `enabled: false` corresponds to `config :pleroma, :workers, retries: [federator_outgoing: 1]`
473 * deprecated options: `max_jobs`, `initial_timeout`
475 ## Pleroma.Web.Metadata
476 * `providers`: a list of metadata providers to enable. Providers available:
477 * Pleroma.Web.Metadata.Providers.OpenGraph
478 * Pleroma.Web.Metadata.Providers.TwitterCard
479 * Pleroma.Web.Metadata.Providers.RelMe - add links from user bio with rel=me into the `<header>` as `<link rel=me>`
480 * `unfurl_nsfw`: If set to `true` nsfw attachments will be shown in previews
483 * `enabled`: if enabled the instance will parse metadata from attached links to generate link previews
484 * `ignore_hosts`: list of hosts which will be ignored by the metadata parser. For example `["accounts.google.com", "xss.website"]`, defaults to `[]`.
485 * `ignore_tld`: list TLDs (top-level domains) which will ignore for parse metadata. default is ["local", "localdomain", "lan"]
486 * `parsers`: list of Rich Media parsers
488 ## :fetch_initial_posts
489 * `enabled`: if enabled, when a new user is federated with, fetch some of their latest posts
490 * `pages`: the amount of pages to fetch
494 Advanced. Tweaks Hackney (http client) connections pools.
496 There's three pools used:
498 * `:federation` for the federation jobs.
499 You may want this pool max_connections to be at least equal to the number of federator jobs + retry queue jobs.
500 * `:media` for rich media, media proxy
501 * `:upload` for uploaded media (if using a remote uploader and `proxy_remote: true`)
503 For each pool, the options are:
505 * `max_connections` - how much connections a pool can hold
506 * `timeout` - retention duration for connections
510 Configuration for the `auto_linker` library:
512 * `class: "auto-linker"` - specify the class to be added to the generated link. false to clear
513 * `rel: "noopener noreferrer"` - override the rel attribute. false to clear
514 * `new_window: true` - set to false to remove `target='_blank'` attribute
515 * `scheme: false` - Set to true to link urls with schema `http://google.com`
516 * `truncate: false` - Set to a number to truncate urls longer then the number. Truncated urls will end in `..`
517 * `strip_prefix: true` - Strip the scheme prefix
518 * `extra: false` - link urls with rarely used schemes (magnet, ipfs, irc, etc.)
536 Configuration for [Quantum](https://github.com/quantum-elixir/quantum-core) jobs scheduler.
538 See [Quantum readme](https://github.com/quantum-elixir/quantum-core#usage) for the list of supported options.
543 config :pleroma, Pleroma.Scheduler,
547 jobs: [{"0 */6 * * * *", {Pleroma.Web.Websub, :refresh_subscriptions, []}}]
550 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)).
552 ## Pleroma.ScheduledActivity
554 * `daily_user_limit`: the number of scheduled activities a user is allowed to create in a single day (Default: `25`)
555 * `total_user_limit`: the number of scheduled activities a user is allowed to create in total (Default: `300`)
556 * `enabled`: whether scheduled activities are sent to the job queue to be executed
558 ## Pleroma.ActivityExpiration
560 # `enabled`: whether expired activities will be sent to the job queue to be deleted
562 ## Pleroma.Web.Auth.Authenticator
564 * `Pleroma.Web.Auth.PleromaAuthenticator`: default database authenticator
565 * `Pleroma.Web.Auth.LDAPAuthenticator`: LDAP authentication
569 Use LDAP for user authentication. When a user logs in to the Pleroma
570 instance, the name and password will be verified by trying to authenticate
571 (bind) to an LDAP server. If a user exists in the LDAP directory but there
572 is no account with the same name yet on the Pleroma instance then a new
573 Pleroma account will be created with the same name as the LDAP user name.
575 * `enabled`: enables LDAP authentication
576 * `host`: LDAP server hostname
577 * `port`: LDAP port, e.g. 389 or 636
578 * `ssl`: true to use SSL, usually implies the port 636
579 * `sslopts`: additional SSL options
580 * `tls`: true to start TLS, usually implies the port 389
581 * `tlsopts`: additional TLS options
582 * `base`: LDAP base, e.g. "dc=example,dc=com"
583 * `uid`: LDAP attribute name to authenticate the user, e.g. when "cn", the filter will be "cn=username,base"
587 To enable simple command line interface accessible over ssh, add a setting like this to your configuration file:
591 priv_dir = Path.join([app_dir, "priv/ssh_keys"])
596 handler: "Pleroma.BBS.Handler",
598 password_authenticator: "Pleroma.BBS.Authenticator"
601 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`
605 * `Pleroma.Web.Auth.PleromaAuthenticator`: default database authenticator
606 * `Pleroma.Web.Auth.LDAPAuthenticator`: LDAP authentication
608 Authentication / authorization settings.
610 * `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`.
611 * `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`.
612 * `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>`).
614 ## :email_notifications
616 Email notifications settings.
618 - digest - emails of "what you've missed" for users who have been
619 inactive for a while.
620 - active: globally enable or disable digest emails
621 - schedule: When to send digest email, in [crontab format](https://en.wikipedia.org/wiki/Cron).
622 "0 0 * * 0" is the default, meaning "once a week at midnight on Sunday morning"
623 - interval: Minimum interval between digest emails to one user
624 - inactivity_threshold: Minimum user inactivity threshold
626 ## Pleroma.Emails.UserEmail
628 - `:logo` - a path to a custom logo. Set it to `nil` to use the default Pleroma logo.
629 - `:styling` - a map with color settings for email templates.
631 ## OAuth consumer mode
633 OAuth consumer mode allows sign in / sign up via external OAuth providers (e.g. Twitter, Facebook, Google, Microsoft, etc.).
634 Implementation is based on Ueberauth; see the list of [available strategies](https://github.com/ueberauth/ueberauth/wiki/List-of-Strategies).
636 Note: each strategy is shipped as a separate dependency; in order to get the strategies, run `OAUTH_CONSUMER_STRATEGIES="..." mix deps.get`,
637 e.g. `OAUTH_CONSUMER_STRATEGIES="twitter facebook google microsoft" mix deps.get`.
638 The server should also be started with `OAUTH_CONSUMER_STRATEGIES="..." mix phx.server` in case you enable any strategies.
640 Note: each strategy requires separate setup (on external provider side and Pleroma side). Below are the guidelines on setting up most popular strategies.
642 Note: make sure that `"SameSite=Lax"` is set in `extra_cookie_attrs` when you have this feature enabled. OAuth consumer mode will not work with `"SameSite=Strict"`
644 * For Twitter, [register an app](https://developer.twitter.com/en/apps), configure callback URL to https://<your_host>/oauth/twitter/callback
646 * 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/
648 * For Google, [register an app](https://console.developers.google.com), configure callback URL to https://<your_host>/oauth/google/callback
650 * For Microsoft, [register an app](https://portal.azure.com), configure callback URL to https://<your_host>/oauth/microsoft/callback
652 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`,
653 per strategy's documentation (e.g. [ueberauth_twitter](https://github.com/ueberauth/ueberauth_twitter)). Example config basing on environment variables:
657 config :ueberauth, Ueberauth.Strategy.Twitter.OAuth,
658 consumer_key: System.get_env("TWITTER_CONSUMER_KEY"),
659 consumer_secret: System.get_env("TWITTER_CONSUMER_SECRET")
662 config :ueberauth, Ueberauth.Strategy.Facebook.OAuth,
663 client_id: System.get_env("FACEBOOK_APP_ID"),
664 client_secret: System.get_env("FACEBOOK_APP_SECRET"),
665 redirect_uri: System.get_env("FACEBOOK_REDIRECT_URI")
668 config :ueberauth, Ueberauth.Strategy.Google.OAuth,
669 client_id: System.get_env("GOOGLE_CLIENT_ID"),
670 client_secret: System.get_env("GOOGLE_CLIENT_SECRET"),
671 redirect_uri: System.get_env("GOOGLE_REDIRECT_URI")
674 config :ueberauth, Ueberauth.Strategy.Microsoft.OAuth,
675 client_id: System.get_env("MICROSOFT_CLIENT_ID"),
676 client_secret: System.get_env("MICROSOFT_CLIENT_SECRET")
678 config :ueberauth, Ueberauth,
680 microsoft: {Ueberauth.Strategy.Microsoft, [callback_params: []]}
684 # Note: make sure to add `keycloak:ueberauth_keycloak_strategy` entry to `OAUTH_CONSUMER_STRATEGIES` environment variable
685 keycloak_url = "https://publicly-reachable-keycloak-instance.org:8080"
687 config :ueberauth, Ueberauth.Strategy.Keycloak.OAuth,
688 client_id: System.get_env("KEYCLOAK_CLIENT_ID"),
689 client_secret: System.get_env("KEYCLOAK_CLIENT_SECRET"),
691 authorize_url: "#{keycloak_url}/auth/realms/master/protocol/openid-connect/auth",
692 token_url: "#{keycloak_url}/auth/realms/master/protocol/openid-connect/token",
693 userinfo_url: "#{keycloak_url}/auth/realms/master/protocol/openid-connect/userinfo",
696 config :ueberauth, Ueberauth,
698 keycloak: {Ueberauth.Strategy.Keycloak, [uid_field: :email]}
702 ## OAuth 2.0 provider - :oauth2
704 Configure OAuth 2 provider capabilities:
706 * `token_expires_in` - The lifetime in seconds of the access token.
707 * `issue_new_refresh_token` - Keeps old refresh token or generate new refresh token when to obtain an access token.
708 * `clean_expired_tokens` - Enable a background job to clean expired oauth tokens. Defaults to `false`.
709 * `clean_expired_tokens_interval` - Interval to run the job to clean expired tokens. Defaults to `86_400_000` (24 hours).
712 * `shortcode_globs`: Location of custom emoji files. `*` can be used as a wildcard. Example `["/emoji/custom/**/*.png"]`
713 * `pack_extensions`: A list of file extensions for emojis, when no emoji.txt for a pack is present. Example `[".png", ".gif"]`
714 * `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"]]`
715 * `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).
716 * `shared_pack_cache_seconds_per_file`: When an emoji pack is shared, the archive is created and cached in
717 memory for this amount of seconds multiplied by the number of files.
721 ### RUM indexing for full text search
722 * `rum_enabled`: If RUM indexes should be used. Defaults to `false`.
724 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.
726 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.
728 To enable them, both the `rum_enabled` flag has to be set and the following special migration has to be run:
730 `mix ecto.migrate --migrations-path priv/repo/optional_migrations/rum_indexing/`
732 This will probably take a long time.
736 This is an advanced feature and disabled by default.
738 If your instance is behind a reverse proxy you must enable and configure [`Pleroma.Plugs.RemoteIp`](#pleroma-plugs-remoteip).
740 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:
742 * The first element: `scale` (Integer). The time scale in milliseconds.
743 * The second element: `limit` (Integer). How many requests to limit in the time scale provided.
745 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.
747 Supported rate limiters:
749 * `:search` for the search requests (account & status search etc.)
750 * `:app_account_creation` for registering user accounts from the same IP address
751 * `:relations_actions` for actions on relations with all users (follow, unfollow)
752 * `:relation_id_action` for actions on relation with a specific user (follow, unfollow)
753 * `:statuses_actions` for create / delete / fav / unfav / reblog / unreblog actions on any statuses
754 * `:status_id_action` for fav / unfav or reblog / unreblog actions on the same status by the same user
758 The expiration time for the web responses cache. Values should be in milliseconds or `nil` to disable expiration.
762 * `:activity_pub` - activity pub routes (except question activities). Defaults to `nil` (no expiration).
763 * `:activity_pub_question` - activity pub routes (question activities). Defaults to `30_000` (30 seconds).
765 ## Pleroma.Plugs.RemoteIp
767 **If your instance is not behind at least one reverse proxy, you should not enable this plug.**
769 `Pleroma.Plugs.RemoteIp` is a shim to call [`RemoteIp`](https://git.pleroma.social/pleroma/remote_ip) but with runtime configuration.
773 * `enabled` - Enable/disable the plug. Defaults to `false`.
774 * `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]`.
775 * `proxies` - A list of strings in [CIDR](https://en.wikipedia.org/wiki/CIDR) notation specifying the IPs of known proxies. Defaults to `[]`.
776 * `reserved` - Defaults to [localhost](https://en.wikipedia.org/wiki/Localhost) and [private network](https://en.wikipedia.org/wiki/Private_network).