3 This file describe the configuration, it is recommended to edit the relevant *.secret.exs file instead of the others founds in the ``config`` directory.
4 If you run Pleroma with ``MIX_ENV=prod`` the file is ``prod.secret.exs``, otherwise it is ``dev.secret.exs``.
7 * `uploader`: Select which `Pleroma.Uploaders` to use
8 * `filters`: List of `Pleroma.Upload.Filter` to use.
9 * `link_name`: When enabled Pleroma will add a `name` parameter to the url of the upload, for example `https://instance.tld/media/corndog.png?name=corndog.png`. This is needed to provide the correct filename in Content-Disposition headers when using filters like `Pleroma.Upload.Filter.Dedupe`
10 * `base_url`: The base URL to access a user-uploaded file. Useful when you want to proxy the media files via another host.
11 * `proxy_remote`: If you\'re using a remote uploader, Pleroma will proxy media requests instead of redirecting to it.
12 * `proxy_opts`: Proxy options, see `Pleroma.ReverseProxy` documentation.
14 Note: `strip_exif` has been replaced by `Pleroma.Upload.Filter.Mogrify`.
16 ## Pleroma.Uploaders.Local
17 * `uploads`: Which directory to store the user-uploads in, relative to pleroma’s working directory
19 ## Pleroma.Uploaders.S3
20 * `bucket`: S3 bucket name
21 * `public_endpoint`: S3 endpoint that the user finally accesses(ex. "https://s3.dualstack.ap-northeast-1.amazonaws.com")
22 * `truncated_namespace`: If you use S3 compatible service such as Digital Ocean Spaces or CDN, set folder name or "" etc.
23 For example, when using CDN to S3 virtual host format, set "".
24 At this time, write CNAME to CDN in public_endpoint.
26 ## Pleroma.Upload.Filter.Mogrify
28 * `args`: List of actions for the `mogrify` command like `"strip"` or `["strip", "auto-orient", {"impode", "1"}]`.
30 ## Pleroma.Upload.Filter.Dedupe
32 No specific configuration.
34 ## Pleroma.Upload.Filter.AnonymizeFilename
36 This filter replaces the filename (not the path) of an upload. For complete obfuscation, add
37 `Pleroma.Upload.Filter.Dedupe` before AnonymizeFilename.
39 * `text`: Text to replace filenames in links. If empty, `{random}.extension` will be used. You can get the original filename extension by using `{extension}`, for example `custom-file-name.{extension}`.
41 ## Pleroma.Emails.Mailer
42 * `adapter`: one of the mail adapters listed in [Swoosh readme](https://github.com/swoosh/swoosh#adapters), or `Swoosh.Adapters.Local` for in-memory mailbox.
43 * `api_key` / `password` and / or other adapter-specific settings, per the above documentation.
45 An example for Sendgrid adapter:
48 config :pleroma, Pleroma.Emails.Mailer,
49 adapter: Swoosh.Adapters.Sendgrid,
50 api_key: "YOUR_API_KEY"
53 An example for SMTP adapter:
56 config :pleroma, Pleroma.Emails.Mailer,
57 adapter: Swoosh.Adapters.SMTP,
58 relay: "smtp.gmail.com",
59 username: "YOUR_USERNAME@gmail.com",
60 password: "YOUR_SMTP_PASSWORD",
68 * `valid_schemes`: List of the scheme part that is considered valid to be an URL
71 * `name`: The instance’s name
72 * `email`: Email used to reach an Administrator/Moderator of the instance
73 * `notify_email`: Email used for notifications.
74 * `description`: The instance’s description, can be seen in nodeinfo and ``/api/v1/instance``
75 * `limit`: Posts character limit (CW/Subject included in the counter)
76 * `remote_limit`: Hard character limit beyond which remote posts will be dropped.
77 * `upload_limit`: File size limit of uploads (except for avatar, background, banner)
78 * `avatar_upload_limit`: File size limit of user’s profile avatars
79 * `background_upload_limit`: File size limit of user’s profile backgrounds
80 * `banner_upload_limit`: File size limit of user’s profile banners
81 * `poll_limits`: A map with poll limits for **local** polls
82 * `max_options`: Maximum number of options
83 * `max_option_chars`: Maximum number of characters per option
84 * `min_expiration`: Minimum expiration time (in seconds)
85 * `max_expiration`: Maximum expiration time (in seconds)
86 * `registrations_open`: Enable registrations for anyone, invitations can be enabled when false.
87 * `invites_enabled`: Enable user invitations for admins (depends on `registrations_open: false`).
88 * `account_activation_required`: Require users to confirm their emails before signing in.
89 * `federating`: Enable federation with other instances
90 * `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.
91 * `federation_reachability_timeout_days`: Timeout (in days) of each external federation target being unreachable prior to pausing federating to it.
92 * `allow_relay`: Enable Pleroma’s Relay, which makes it possible to follow a whole instance
93 * `rewrite_policy`: Message Rewrite Policy, either one or a list. Here are the ones available by default:
94 * `Pleroma.Web.ActivityPub.MRF.NoOpPolicy`: Doesn’t modify activities (default)
95 * `Pleroma.Web.ActivityPub.MRF.DropPolicy`: Drops all activities. It generally doesn’t makes sense to use in production
96 * `Pleroma.Web.ActivityPub.MRF.SimplePolicy`: Restrict the visibility of activities from certains instances (See ``:mrf_simple`` section)
97 * `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)
98 * `Pleroma.Web.ActivityPub.MRF.SubchainPolicy`: Selectively runs other MRF policies when messages match (see ``:mrf_subchain`` section)
99 * `Pleroma.Web.ActivityPub.MRF.RejectNonPublic`: Drops posts with non-public visibility settings (See ``:mrf_rejectnonpublic`` section)
100 * `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:.
101 * `Pleroma.Web.ActivityPub.MRF.AntiLinkSpamPolicy`: Rejects posts from likely spambots by rejecting posts from new users that contain links.
102 * `Pleroma.Web.ActivityPub.MRF.MediaProxyWarmingPolicy`: Crawls attachments using their MediaProxy URLs so that the MediaProxy cache is primed.
103 * `public`: Makes the client API in authentificated mode-only except for user-profiles. Useful for disabling the Local Timeline and The Whole Known Network.
104 * `quarantined_instances`: List of ActivityPub instances where private(DMs, followers-only) activities will not be send.
105 * `managed_config`: Whenether the config for pleroma-fe is configured in this config or in ``static/config.json``
106 * `allowed_post_formats`: MIME-type list of formats allowed to be posted (transformed into HTML)
107 * `mrf_transparency`: Make the content of your Message Rewrite Facility settings public (via nodeinfo).
108 * `scope_copy`: Copy the scope (private/unlisted/public) in replies to posts by default.
109 * `subject_line_behavior`: Allows changing the default behaviour of subject lines in replies. Valid values:
110 * "email": Copy and preprend re:, as in email.
111 * "masto": Copy verbatim, as in Mastodon.
112 * "noop": Don't copy the subject.
113 * `always_show_subject_input`: When set to false, auto-hide the subject field when it's empty.
114 * `extended_nickname_format`: Set to `true` to use extended local nicknames format (allows underscores/dashes). This will break federation with
115 older software for theses nicknames.
116 * `max_pinned_statuses`: The maximum number of pinned statuses. `0` will disable the feature.
117 * `autofollowed_nicknames`: Set to nicknames of (local) users that every new user should automatically follow.
118 * `no_attachment_links`: Set to true to disable automatically adding attachment link text to statuses
119 * `welcome_message`: A message that will be send to a newly registered users as a direct message.
120 * `welcome_user_nickname`: The nickname of the local user that sends the welcome message.
121 * `max_report_comment_size`: The maximum size of the report comment (Default: `1000`)
122 * `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`.
123 * `healthcheck`: If set to true, system data will be shown on ``/api/pleroma/healthcheck``.
124 * `remote_post_retention_days`: The default amount of days to retain remote posts when pruning the database.
125 * `skip_thread_containment`: Skip filter out broken threads. The default is `false`.
126 * `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`.
127 * `dynamic_configuration`: Allow transferring configuration to DB with the subsequent customization from Admin api.
128 * `external_user_synchronization`: Following/followers counters synchronization settings.
129 * `enabled`: Enables synchronization
130 * `interval`: Interval between synchronization.
131 * `max_retries`: Max rettries for host. After exceeding the limit, the check will not be carried out for users from this host.
132 * `limit`: Users batch size for processing in one time.
137 * `backends`: `:console` is used to send logs to stdout, `{ExSyslogger, :ex_syslogger}` to log to syslog, and `Quack.Logger` to log to Slack
139 An example to enable ONLY ExSyslogger (f/ex in ``prod.secret.exs``) with info and debug suppressed:
142 backends: [{ExSyslogger, :ex_syslogger}]
144 config :logger, :ex_syslogger,
148 Another example, keeping console output and adding the pid to syslog output:
151 backends: [:console, {ExSyslogger, :ex_syslogger}]
153 config :logger, :ex_syslogger,
155 option: [:pid, :ndelay]
158 See: [logger’s documentation](https://hexdocs.pm/logger/Logger.html) and [ex_syslogger’s documentation](https://hexdocs.pm/ex_syslogger/)
160 An example of logging info to local syslog, but warn to a Slack channel:
163 backends: [ {ExSyslogger, :ex_syslogger}, Quack.Logger ],
166 config :logger, :ex_syslogger,
169 format: "$metadata[$level] $message"
174 webhook_url: "https://hooks.slack.com/services/YOUR-API-KEY-HERE"
177 See the [Quack Github](https://github.com/azohra/quack) for more details
179 ## :frontend_configurations
181 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.
183 Frontends can access these settings at `/api/pleroma/frontend_configurations`
185 To add your own configuration for PleromaFE, use it like this:
188 config :pleroma, :frontend_configurations,
190 theme: "pleroma-dark",
191 # ... see /priv/static/static/config.json for the available keys.
194 showInstanceSpecificPanel: true
198 These settings **need to be complete**, they will override the defaults.
200 NOTE: for versions < 1.0, you need to set [`:fe`](#fe) to false, as shown a few lines below.
203 __THIS IS DEPRECATED__
205 If you are using this method, please change it to the [`frontend_configurations`](#frontend_configurations) method.
206 Please **set this option to false** in your config like this:
209 config :pleroma, :fe, false
212 This section is used to configure Pleroma-FE, unless ``:managed_config`` in ``:instance`` is set to false.
214 * `theme`: Which theme to use, they are defined in ``styles.json``
215 * `logo`: URL of the logo, defaults to Pleroma’s logo
216 * `logo_mask`: Whether to use only the logo's shape as a mask (true) or as a regular image (false)
217 * `logo_margin`: What margin to use around the logo
218 * `background`: URL of the background, unless viewing a user profile with a background that is set
219 * `redirect_root_no_login`: relative URL which indicates where to redirect when a user isn’t logged in.
220 * `redirect_root_login`: relative URL which indicates where to redirect when a user is logged in.
221 * `show_instance_panel`: Whenether to show the instance’s specific panel.
222 * `scope_options_enabled`: Enable setting an notice visibility and subject/CW when posting
223 * `formatting_options_enabled`: Enable setting a formatting different than plain-text (ie. HTML, Markdown) when posting, relates to ``:instance, allowed_post_formats``
224 * `collapse_message_with_subjects`: When a message has a subject(aka Content Warning), collapse it by default
225 * `hide_post_stats`: Hide notices statistics(repeats, favorites, …)
226 * `hide_user_stats`: Hide profile statistics(posts, posts per day, followers, followings, …)
230 This section configures assets to be used with various frontends. Currently the only option
231 relates to mascots on the mastodon frontend
233 * `mascots`: KeywordList of mascots, each element __MUST__ contain both a `url` and a
235 * `default_mascot`: An element from `mascots` - This will be used as the default mascot
236 on MastoFE (default: `:pleroma_fox_tan`)
239 * `media_removal`: List of instances to remove medias from
240 * `media_nsfw`: List of instances to put medias as NSFW(sensitive) from
241 * `federated_timeline_removal`: List of instances to remove from Federated (aka The Whole Known Network) Timeline
242 * `reject`: List of instances to reject any activities from
243 * `accept`: List of instances to accept any activities from
244 * `report_removal`: List of instances to reject reports from
245 * `avatar_removal`: List of instances to strip avatars from
246 * `banner_removal`: List of instances to strip banners from
249 This policy processes messages through an alternate pipeline when a given message matches certain criteria.
250 All criteria are configured as a map of regular expressions to lists of policy modules.
252 * `match_actor`: Matches a series of regular expressions against the actor field.
257 config :pleroma, :mrf_subchain,
259 ~r/https:\/\/example.com/s => [Pleroma.Web.ActivityPub.MRF.DropPolicy]
263 ## :mrf_rejectnonpublic
264 * `allow_followersonly`: whether to allow followers-only posts
265 * `allow_direct`: whether to allow direct messages
268 * `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.
269 * `reject_threshold`: Number of mentioned users after which the messaged gets rejected. Set to 0 to disable.
272 * `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)
273 * `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)
274 * `replace`: A list of tuples containing `{pattern, replacement}`, `pattern` can be a string or a [regular expression](https://hexdocs.pm/elixir/Regex.html)
277 * `enabled`: Enables proxying of remote media to the instance’s proxy
278 * `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.
279 * `proxy_opts`: All options defined in `Pleroma.ReverseProxy` documentation, defaults to `[max_body_length: (25*1_048_576)]`.
280 * `whitelist`: List of domains to bypass the mediaproxy
283 * `enabled`: Enables the gopher interface
284 * `ip`: IP address to bind to
285 * `port`: Port to bind to
286 * `dstport`: Port advertised in urls (optional, defaults to `port`)
288 ## Pleroma.Web.Endpoint
289 `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
290 * `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).
291 - `ip` - a tuple consisting of 4 integers
293 * `url` - a list containing the configuration for generating urls, accepts
294 - `host` - the host without the scheme and a post (e.g `example.com`, not `https://example.com:2020`)
295 - `scheme` - e.g `http`, `https`
298 * `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.
302 **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
306 config :pleroma, Pleroma.Web.Endpoint,
307 url: [host: "example.com", port: 2020, scheme: "https"],
309 # start copied from config.exs
313 {"/api/v1/streaming", Pleroma.Web.MastodonAPI.WebsocketHandler, []},
314 {"/websocket", Phoenix.Endpoint.CowboyWebSocket,
315 {Phoenix.Transports.WebSocket,
316 {Pleroma.Web.Endpoint, Pleroma.Web.UserSocket, websocket_config}}},
317 {:_, Phoenix.Endpoint.Cowboy2Handler, {Pleroma.Web.Endpoint, []}}
319 # end copied from config.exs
326 This will make Pleroma listen on `127.0.0.1` port `8080` and generate urls starting with `https://example.com:2020`
329 * ``accept_blocks``: Whether to accept incoming block activities from other instances
330 * ``unfollow_blocked``: Whether blocks result in people getting unfollowed
331 * ``outgoing_blocks``: Whether to federate blocks to other instances
332 * ``deny_follow_blocked``: Whether to disallow following an account that has blocked the user in question
335 * ``enabled``: Whether the managed content security policy is enabled
336 * ``sts``: Whether to additionally send a `Strict-Transport-Security` header
337 * ``sts_max_age``: The maximum age for the `Strict-Transport-Security` header if sent
338 * ``ct_max_age``: The maximum age for the `Expect-CT` header if sent
339 * ``referrer_policy``: The referrer policy to use, either `"same-origin"` or `"no-referrer"`
340 * ``report_uri``: Adds the specified url to `report-uri` and `report-to` group in CSP header.
342 ## :mrf_user_allowlist
344 The keys in this section are the domain names that the policy should apply to.
345 Each key should be assigned a list of users that should be allowed through by
346 their ActivityPub ID.
351 config :pleroma, :mrf_user_allowlist,
352 "example.org": ["https://example.org/users/admin"]
355 ## :web_push_encryption, :vapid_details
357 Web Push Notifications configuration. You can use the mix task `mix web_push.gen.keypair` to generate it.
359 * ``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.
360 * ``public_key``: VAPID public key
361 * ``private_key``: VAPID private key
364 * `enabled`: Whether the captcha should be shown on registration
365 * `method`: The method/service to use for captcha
366 * `seconds_valid`: The time in seconds for which the captcha is valid
368 ### Pleroma.Captcha.Kocaptcha
369 Kocaptcha is a very simple captcha service with a single API endpoint,
370 the source code is here: https://github.com/koto-bank/kocaptcha. The default endpoint
371 `https://captcha.kotobank.ch` is hosted by the developer.
373 * `endpoint`: the kocaptcha endpoint to use
377 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:
380 config :pleroma, :admin_token, "somerandomtoken"
386 curl "http://localhost:4000/api/pleroma/admin/invite_token?admin_token=somerandomtoken"
389 ## :pleroma_job_queue
391 [Pleroma Job Queue](https://git.pleroma.social/pleroma/pleroma_job_queue) configuration: a list of queues with maximum concurrent jobs.
393 Pleroma has the following queues:
395 * `federator_outgoing` - Outgoing federation
396 * `federator_incoming` - Incoming federation
397 * `mailer` - Email sender, see [`Pleroma.Emails.Mailer`](#pleroma-emails-mailer)
398 * `transmogrifier` - Transmogrifier
399 * `web_push` - Web push notifications
400 * `scheduled_activities` - Scheduled activities, see [`Pleroma.ScheduledActivities`](#pleromascheduledactivity)
405 config :pleroma_job_queue, :queues,
406 federator_incoming: 50,
407 federator_outgoing: 50
410 This config contains two queues: `federator_incoming` and `federator_outgoing`. Both have the `max_jobs` set to `50`.
412 ## Pleroma.Web.Federator.RetryQueue
414 * `enabled`: If set to `true`, failed federation jobs will be retried
415 * `max_jobs`: The maximum amount of parallel federation jobs running at the same time.
416 * `initial_timeout`: The initial timeout in seconds
417 * `max_retries`: The maximum number of times a federation job is retried
419 ## Pleroma.Web.Metadata
420 * `providers`: a list of metadata providers to enable. Providers available:
421 * Pleroma.Web.Metadata.Providers.OpenGraph
422 * Pleroma.Web.Metadata.Providers.TwitterCard
423 * Pleroma.Web.Metadata.Providers.RelMe - add links from user bio with rel=me into the `<header>` as `<link rel=me>`
424 * `unfurl_nsfw`: If set to `true` nsfw attachments will be shown in previews
427 * `enabled`: if enabled the instance will parse metadata from attached links to generate link previews
428 * `ignore_hosts`: list of hosts which will be ignored by the metadata parser. For example `["accounts.google.com", "xss.website"]`, defaults to `[]`.
429 * `ignore_tld`: list TLDs (top-level domains) which will ignore for parse metadata. default is ["local", "localdomain", "lan"]
431 ## :fetch_initial_posts
432 * `enabled`: if enabled, when a new user is federated with, fetch some of their latest posts
433 * `pages`: the amount of pages to fetch
437 Advanced. Tweaks Hackney (http client) connections pools.
439 There's three pools used:
441 * `:federation` for the federation jobs.
442 You may want this pool max_connections to be at least equal to the number of federator jobs + retry queue jobs.
443 * `:media` for rich media, media proxy
444 * `:upload` for uploaded media (if using a remote uploader and `proxy_remote: true`)
446 For each pool, the options are:
448 * `max_connections` - how much connections a pool can hold
449 * `timeout` - retention duration for connections
453 Configuration for the `auto_linker` library:
455 * `class: "auto-linker"` - specify the class to be added to the generated link. false to clear
456 * `rel: "noopener noreferrer"` - override the rel attribute. false to clear
457 * `new_window: true` - set to false to remove `target='_blank'` attribute
458 * `scheme: false` - Set to true to link urls with schema `http://google.com`
459 * `truncate: false` - Set to a number to truncate urls longer then the number. Truncated urls will end in `..`
460 * `strip_prefix: true` - Strip the scheme prefix
461 * `extra: false` - link urls with rarely used schemes (magnet, ipfs, irc, etc.)
477 ## Pleroma.ScheduledActivity
479 * `daily_user_limit`: the number of scheduled activities a user is allowed to create in a single day (Default: `25`)
480 * `total_user_limit`: the number of scheduled activities a user is allowed to create in total (Default: `300`)
481 * `enabled`: whether scheduled activities are sent to the job queue to be executed
483 ## Pleroma.Web.Auth.Authenticator
485 * `Pleroma.Web.Auth.PleromaAuthenticator`: default database authenticator
486 * `Pleroma.Web.Auth.LDAPAuthenticator`: LDAP authentication
490 Use LDAP for user authentication. When a user logs in to the Pleroma
491 instance, the name and password will be verified by trying to authenticate
492 (bind) to an LDAP server. If a user exists in the LDAP directory but there
493 is no account with the same name yet on the Pleroma instance then a new
494 Pleroma account will be created with the same name as the LDAP user name.
496 * `enabled`: enables LDAP authentication
497 * `host`: LDAP server hostname
498 * `port`: LDAP port, e.g. 389 or 636
499 * `ssl`: true to use SSL, usually implies the port 636
500 * `sslopts`: additional SSL options
501 * `tls`: true to start TLS, usually implies the port 389
502 * `tlsopts`: additional TLS options
503 * `base`: LDAP base, e.g. "dc=example,dc=com"
504 * `uid`: LDAP attribute name to authenticate the user, e.g. when "cn", the filter will be "cn=username,base"
508 To enable simple command line interface accessible over ssh, add a setting like this to your configuration file:
512 priv_dir = Path.join([app_dir, "priv/ssh_keys"])
517 handler: "Pleroma.BBS.Handler",
519 password_authenticator: "Pleroma.BBS.Authenticator"
522 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`
526 * `Pleroma.Web.Auth.PleromaAuthenticator`: default database authenticator
527 * `Pleroma.Web.Auth.LDAPAuthenticator`: LDAP authentication
529 Authentication / authorization settings.
531 * `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`.
532 * `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`.
533 * `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>`).
535 ## OAuth consumer mode
537 OAuth consumer mode allows sign in / sign up via external OAuth providers (e.g. Twitter, Facebook, Google, Microsoft, etc.).
538 Implementation is based on Ueberauth; see the list of [available strategies](https://github.com/ueberauth/ueberauth/wiki/List-of-Strategies).
540 Note: each strategy is shipped as a separate dependency; in order to get the strategies, run `OAUTH_CONSUMER_STRATEGIES="..." mix deps.get`,
541 e.g. `OAUTH_CONSUMER_STRATEGIES="twitter facebook google microsoft" mix deps.get`.
542 The server should also be started with `OAUTH_CONSUMER_STRATEGIES="..." mix phx.server` in case you enable any strategies.
544 Note: each strategy requires separate setup (on external provider side and Pleroma side). Below are the guidelines on setting up most popular strategies.
546 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"`
548 * For Twitter, [register an app](https://developer.twitter.com/en/apps), configure callback URL to https://<your_host>/oauth/twitter/callback
550 * 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/
552 * For Google, [register an app](https://console.developers.google.com), configure callback URL to https://<your_host>/oauth/google/callback
554 * For Microsoft, [register an app](https://portal.azure.com), configure callback URL to https://<your_host>/oauth/microsoft/callback
556 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`,
557 per strategy's documentation (e.g. [ueberauth_twitter](https://github.com/ueberauth/ueberauth_twitter)). Example config basing on environment variables:
561 config :ueberauth, Ueberauth.Strategy.Twitter.OAuth,
562 consumer_key: System.get_env("TWITTER_CONSUMER_KEY"),
563 consumer_secret: System.get_env("TWITTER_CONSUMER_SECRET")
566 config :ueberauth, Ueberauth.Strategy.Facebook.OAuth,
567 client_id: System.get_env("FACEBOOK_APP_ID"),
568 client_secret: System.get_env("FACEBOOK_APP_SECRET"),
569 redirect_uri: System.get_env("FACEBOOK_REDIRECT_URI")
572 config :ueberauth, Ueberauth.Strategy.Google.OAuth,
573 client_id: System.get_env("GOOGLE_CLIENT_ID"),
574 client_secret: System.get_env("GOOGLE_CLIENT_SECRET"),
575 redirect_uri: System.get_env("GOOGLE_REDIRECT_URI")
578 config :ueberauth, Ueberauth.Strategy.Microsoft.OAuth,
579 client_id: System.get_env("MICROSOFT_CLIENT_ID"),
580 client_secret: System.get_env("MICROSOFT_CLIENT_SECRET")
582 config :ueberauth, Ueberauth,
584 microsoft: {Ueberauth.Strategy.Microsoft, [callback_params: []]}
588 # Note: make sure to add `keycloak:ueberauth_keycloak_strategy` entry to `OAUTH_CONSUMER_STRATEGIES` environment variable
589 keycloak_url = "https://publicly-reachable-keycloak-instance.org:8080"
591 config :ueberauth, Ueberauth.Strategy.Keycloak.OAuth,
592 client_id: System.get_env("KEYCLOAK_CLIENT_ID"),
593 client_secret: System.get_env("KEYCLOAK_CLIENT_SECRET"),
595 authorize_url: "#{keycloak_url}/auth/realms/master/protocol/openid-connect/auth",
596 token_url: "#{keycloak_url}/auth/realms/master/protocol/openid-connect/token",
597 userinfo_url: "#{keycloak_url}/auth/realms/master/protocol/openid-connect/userinfo",
600 config :ueberauth, Ueberauth,
602 keycloak: {Ueberauth.Strategy.Keycloak, [uid_field: :email]}
606 ## OAuth 2.0 provider - :oauth2
608 Configure OAuth 2 provider capabilities:
610 * `token_expires_in` - The lifetime in seconds of the access token.
611 * `issue_new_refresh_token` - Keeps old refresh token or generate new refresh token when to obtain an access token.
612 * `clean_expired_tokens` - Enable a background job to clean expired oauth tokens. Defaults to `false`.
613 * `clean_expired_tokens_interval` - Interval to run the job to clean expired tokens. Defaults to `86_400_000` (24 hours).
616 * `shortcode_globs`: Location of custom emoji files. `*` can be used as a wildcard. Example `["/emoji/custom/**/*.png"]`
617 * `pack_extensions`: A list of file extensions for emojis, when no emoji.txt for a pack is present. Example `[".png", ".gif"]`
618 * `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"]]`
619 * `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).
623 ### RUM indexing for full text search
624 * `rum_enabled`: If RUM indexes should be used. Defaults to `false`.
626 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.
628 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.
630 To enable them, both the `rum_enabled` flag has to be set and the following special migration has to be run:
632 `mix ecto.migrate --migrations-path priv/repo/optional_migrations/rum_indexing/`
634 This will probably take a long time.
638 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:
640 * The first element: `scale` (Integer). The time scale in milliseconds.
641 * The second element: `limit` (Integer). How many requests to limit in the time scale provided.
643 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.
645 See [`Pleroma.Plugs.RateLimiter`](Pleroma.Plugs.RateLimiter.html) documentation for examples.