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.Upload.Filter.Mogrify
21 * `args`: List of actions for the `mogrify` command like `"strip"` or `["strip", "auto-orient", {"impode", "1"}]`.
23 ## Pleroma.Upload.Filter.Dedupe
25 No specific configuration.
27 ## Pleroma.Upload.Filter.AnonymizeFilename
29 This filter replaces the filename (not the path) of an upload. For complete obfuscation, add
30 `Pleroma.Upload.Filter.Dedupe` before AnonymizeFilename.
32 * `text`: Text to replace filenames in links. If empty, `{random}.extension` will be used.
34 ## Pleroma.Emails.Mailer
35 * `adapter`: one of the mail adapters listed in [Swoosh readme](https://github.com/swoosh/swoosh#adapters), or `Swoosh.Adapters.Local` for in-memory mailbox.
36 * `api_key` / `password` and / or other adapter-specific settings, per the above documentation.
38 An example for Sendgrid adapter:
41 config :pleroma, Pleroma.Emails.Mailer,
42 adapter: Swoosh.Adapters.Sendgrid,
43 api_key: "YOUR_API_KEY"
46 An example for SMTP adapter:
49 config :pleroma, Pleroma.Emails.Mailer,
50 adapter: Swoosh.Adapters.SMTP,
51 relay: "smtp.gmail.com",
52 username: "YOUR_USERNAME@gmail.com",
53 password: "YOUR_SMTP_PASSWORD",
61 * `valid_schemes`: List of the scheme part that is considered valid to be an URL
64 * `name`: The instance’s name
65 * `email`: Email used to reach an Administrator/Moderator of the instance
66 * `notify_email`: Email used for notifications.
67 * `description`: The instance’s description, can be seen in nodeinfo and ``/api/v1/instance``
68 * `limit`: Posts character limit (CW/Subject included in the counter)
69 * `remote_limit`: Hard character limit beyond which remote posts will be dropped.
70 * `upload_limit`: File size limit of uploads (except for avatar, background, banner)
71 * `avatar_upload_limit`: File size limit of user’s profile avatars
72 * `background_upload_limit`: File size limit of user’s profile backgrounds
73 * `banner_upload_limit`: File size limit of user’s profile banners
74 * `poll_limits`: A map with poll limits for **local** polls
75 * `max_options`: Maximum number of options
76 * `max_option_chars`: Maximum number of characters per option
77 * `min_expiration`: Minimum expiration time (in seconds)
78 * `max_expiration`: Maximum expiration time (in seconds)
79 * `registrations_open`: Enable registrations for anyone, invitations can be enabled when false.
80 * `invites_enabled`: Enable user invitations for admins (depends on `registrations_open: false`).
81 * `account_activation_required`: Require users to confirm their emails before signing in.
82 * `federating`: Enable federation with other instances
83 * `federation_reachability_timeout_days`: Timeout (in days) of each external federation target being unreachable prior to pausing federating to it.
84 * `allow_relay`: Enable Pleroma’s Relay, which makes it possible to follow a whole instance
85 * `rewrite_policy`: Message Rewrite Policy, either one or a list. Here are the ones available by default:
86 * `Pleroma.Web.ActivityPub.MRF.NoOpPolicy`: Doesn’t modify activities (default)
87 * `Pleroma.Web.ActivityPub.MRF.DropPolicy`: Drops all activities. It generally doesn’t makes sense to use in production
88 * `Pleroma.Web.ActivityPub.MRF.SimplePolicy`: Restrict the visibility of activities from certains instances (See ``:mrf_simple`` section)
89 * `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)
90 * `Pleroma.Web.ActivityPub.MRF.SubchainPolicy`: Selectively runs other MRF policies when messages match (see ``:mrf_subchain`` section)
91 * `Pleroma.Web.ActivityPub.MRF.RejectNonPublic`: Drops posts with non-public visibility settings (See ``:mrf_rejectnonpublic`` section)
92 * `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:.
93 * `public`: Makes the client API in authentificated mode-only except for user-profiles. Useful for disabling the Local Timeline and The Whole Known Network.
94 * `quarantined_instances`: List of ActivityPub instances where private(DMs, followers-only) activities will not be send.
95 * `managed_config`: Whenether the config for pleroma-fe is configured in this config or in ``static/config.json``
96 * `allowed_post_formats`: MIME-type list of formats allowed to be posted (transformed into HTML)
97 * `mrf_transparency`: Make the content of your Message Rewrite Facility settings public (via nodeinfo).
98 * `scope_copy`: Copy the scope (private/unlisted/public) in replies to posts by default.
99 * `subject_line_behavior`: Allows changing the default behaviour of subject lines in replies. Valid values:
100 * "email": Copy and preprend re:, as in email.
101 * "masto": Copy verbatim, as in Mastodon.
102 * "noop": Don't copy the subject.
103 * `always_show_subject_input`: When set to false, auto-hide the subject field when it's empty.
104 * `extended_nickname_format`: Set to `true` to use extended local nicknames format (allows underscores/dashes). This will break federation with
105 older software for theses nicknames.
106 * `max_pinned_statuses`: The maximum number of pinned statuses. `0` will disable the feature.
107 * `autofollowed_nicknames`: Set to nicknames of (local) users that every new user should automatically follow.
108 * `no_attachment_links`: Set to true to disable automatically adding attachment link text to statuses
109 * `welcome_message`: A message that will be send to a newly registered users as a direct message.
110 * `welcome_user_nickname`: The nickname of the local user that sends the welcome message.
111 * `max_report_comment_size`: The maximum size of the report comment (Default: `1000`)
112 * `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`.
113 * `healthcheck`: If set to true, system data will be shown on ``/api/pleroma/healthcheck``.
114 * `remote_post_retention_days`: The default amount of days to retain remote posts when pruning the database.
115 * `skip_thread_containment`: Skip filter out broken threads. The default is `false`.
116 * `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`.
117 * `dynamic_configuration`: Allow transferring configuration to DB with the subsequent customization from Admin api.
121 * `backends`: `:console` is used to send logs to stdout, `{ExSyslogger, :ex_syslogger}` to log to syslog, and `Quack.Logger` to log to Slack
123 An example to enable ONLY ExSyslogger (f/ex in ``prod.secret.exs``) with info and debug suppressed:
126 backends: [{ExSyslogger, :ex_syslogger}]
128 config :logger, :ex_syslogger,
132 Another example, keeping console output and adding the pid to syslog output:
135 backends: [:console, {ExSyslogger, :ex_syslogger}]
137 config :logger, :ex_syslogger,
139 option: [:pid, :ndelay]
142 See: [logger’s documentation](https://hexdocs.pm/logger/Logger.html) and [ex_syslogger’s documentation](https://hexdocs.pm/ex_syslogger/)
144 An example of logging info to local syslog, but warn to a Slack channel:
147 backends: [ {ExSyslogger, :ex_syslogger}, Quack.Logger ],
150 config :logger, :ex_syslogger,
153 format: "$metadata[$level] $message"
158 webhook_url: "https://hooks.slack.com/services/YOUR-API-KEY-HERE"
161 See the [Quack Github](https://github.com/azohra/quack) for more details
163 ## :frontend_configurations
165 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.
167 Frontends can access these settings at `/api/pleroma/frontend_configurations`
169 To add your own configuration for PleromaFE, use it like this:
172 config :pleroma, :frontend_configurations,
174 theme: "pleroma-dark",
175 # ... see /priv/static/static/config.json for the available keys.
178 showInstanceSpecificPanel: true
182 These settings **need to be complete**, they will override the defaults.
184 NOTE: for versions < 1.0, you need to set [`:fe`](#fe) to false, as shown a few lines below.
187 __THIS IS DEPRECATED__
189 If you are using this method, please change it to the [`frontend_configurations`](#frontend_configurations) method.
190 Please **set this option to false** in your config like this:
193 config :pleroma, :fe, false
196 This section is used to configure Pleroma-FE, unless ``:managed_config`` in ``:instance`` is set to false.
198 * `theme`: Which theme to use, they are defined in ``styles.json``
199 * `logo`: URL of the logo, defaults to Pleroma’s logo
200 * `logo_mask`: Whether to use only the logo's shape as a mask (true) or as a regular image (false)
201 * `logo_margin`: What margin to use around the logo
202 * `background`: URL of the background, unless viewing a user profile with a background that is set
203 * `redirect_root_no_login`: relative URL which indicates where to redirect when a user isn’t logged in.
204 * `redirect_root_login`: relative URL which indicates where to redirect when a user is logged in.
205 * `show_instance_panel`: Whenether to show the instance’s specific panel.
206 * `scope_options_enabled`: Enable setting an notice visibility and subject/CW when posting
207 * `formatting_options_enabled`: Enable setting a formatting different than plain-text (ie. HTML, Markdown) when posting, relates to ``:instance, allowed_post_formats``
208 * `collapse_message_with_subjects`: When a message has a subject(aka Content Warning), collapse it by default
209 * `hide_post_stats`: Hide notices statistics(repeats, favorites, …)
210 * `hide_user_stats`: Hide profile statistics(posts, posts per day, followers, followings, …)
214 This section configures assets to be used with various frontends. Currently the only option
215 relates to mascots on the mastodon frontend
217 * `mascots`: KeywordList of mascots, each element __MUST__ contain both a `url` and a
219 * `default_mascot`: An element from `mascots` - This will be used as the default mascot
220 on MastoFE (default: `:pleroma_fox_tan`)
223 * `media_removal`: List of instances to remove medias from
224 * `media_nsfw`: List of instances to put medias as NSFW(sensitive) from
225 * `federated_timeline_removal`: List of instances to remove from Federated (aka The Whole Known Network) Timeline
226 * `reject`: List of instances to reject any activities from
227 * `accept`: List of instances to accept any activities from
228 * `report_removal`: List of instances to reject reports from
229 * `avatar_removal`: List of instances to strip avatars from
230 * `banner_removal`: List of instances to strip banners from
233 This policy processes messages through an alternate pipeline when a given message matches certain criteria.
234 All criteria are configured as a map of regular expressions to lists of policy modules.
236 * `match_actor`: Matches a series of regular expressions against the actor field.
241 config :pleroma, :mrf_subchain,
243 ~r/https:\/\/example.com/s => [Pleroma.Web.ActivityPub.MRF.DropPolicy]
247 ## :mrf_rejectnonpublic
248 * `allow_followersonly`: whether to allow followers-only posts
249 * `allow_direct`: whether to allow direct messages
252 * `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.
253 * `reject_threshold`: Number of mentioned users after which the messaged gets rejected. Set to 0 to disable.
256 * `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)
257 * `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)
258 * `replace`: A list of tuples containing `{pattern, replacement}`, `pattern` can be a string or a [regular expression](https://hexdocs.pm/elixir/Regex.html)
261 * `enabled`: Enables proxying of remote media to the instance’s proxy
262 * `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.
263 * `proxy_opts`: All options defined in `Pleroma.ReverseProxy` documentation, defaults to `[max_body_length: (25*1_048_576)]`.
264 * `whitelist`: List of domains to bypass the mediaproxy
267 * `enabled`: Enables the gopher interface
268 * `ip`: IP address to bind to
269 * `port`: Port to bind to
270 * `dstport`: Port advertised in urls (optional, defaults to `port`)
272 ## Pleroma.Web.Endpoint
273 `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
274 * `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
275 - `ip` - a tuple consisting of 4 integers
277 * `url` - a list containing the configuration for generating urls, accepts
278 - `host` - the host without the scheme and a post (e.g `example.com`, not `https://example.com:2020`)
279 - `scheme` - e.g `http`, `https`
282 * `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.
286 **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
290 config :pleroma, Pleroma.Web.Endpoint,
291 url: [host: "example.com", port: 2020, scheme: "https"],
293 # start copied from config.exs
297 {"/api/v1/streaming", Pleroma.Web.MastodonAPI.WebsocketHandler, []},
298 {"/websocket", Phoenix.Endpoint.CowboyWebSocket,
299 {Phoenix.Transports.WebSocket,
300 {Pleroma.Web.Endpoint, Pleroma.Web.UserSocket, websocket_config}}},
301 {:_, Phoenix.Endpoint.Cowboy2Handler, {Pleroma.Web.Endpoint, []}}
303 # end copied from config.exs
310 This will make Pleroma listen on `127.0.0.1` port `8080` and generate urls starting with `https://example.com:2020`
313 * ``accept_blocks``: Whether to accept incoming block activities from other instances
314 * ``unfollow_blocked``: Whether blocks result in people getting unfollowed
315 * ``outgoing_blocks``: Whether to federate blocks to other instances
316 * ``deny_follow_blocked``: Whether to disallow following an account that has blocked the user in question
319 * ``enabled``: Whether the managed content security policy is enabled
320 * ``sts``: Whether to additionally send a `Strict-Transport-Security` header
321 * ``sts_max_age``: The maximum age for the `Strict-Transport-Security` header if sent
322 * ``ct_max_age``: The maximum age for the `Expect-CT` header if sent
323 * ``referrer_policy``: The referrer policy to use, either `"same-origin"` or `"no-referrer"`
324 * ``report_uri``: Adds the specified url to `report-uri` and `report-to` group in CSP header.
326 ## :mrf_user_allowlist
328 The keys in this section are the domain names that the policy should apply to.
329 Each key should be assigned a list of users that should be allowed through by
330 their ActivityPub ID.
335 config :pleroma, :mrf_user_allowlist,
336 "example.org": ["https://example.org/users/admin"]
339 ## :web_push_encryption, :vapid_details
341 Web Push Notifications configuration. You can use the mix task `mix web_push.gen.keypair` to generate it.
343 * ``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.
344 * ``public_key``: VAPID public key
345 * ``private_key``: VAPID private key
348 * `enabled`: Whether the captcha should be shown on registration
349 * `method`: The method/service to use for captcha
350 * `seconds_valid`: The time in seconds for which the captcha is valid
352 ### Pleroma.Captcha.Kocaptcha
353 Kocaptcha is a very simple captcha service with a single API endpoint,
354 the source code is here: https://github.com/koto-bank/kocaptcha. The default endpoint
355 `https://captcha.kotobank.ch` is hosted by the developer.
357 * `endpoint`: the kocaptcha endpoint to use
361 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:
364 config :pleroma, :admin_token, "somerandomtoken"
370 curl "http://localhost:4000/api/pleroma/admin/invite_token?admin_token=somerandomtoken"
373 ## :pleroma_job_queue
375 [Pleroma Job Queue](https://git.pleroma.social/pleroma/pleroma_job_queue) configuration: a list of queues with maximum concurrent jobs.
377 Pleroma has the following queues:
379 * `federator_outgoing` - Outgoing federation
380 * `federator_incoming` - Incoming federation
381 * `mailer` - Email sender, see [`Pleroma.Emails.Mailer`](#pleroma-emails-mailer)
382 * `transmogrifier` - Transmogrifier
383 * `web_push` - Web push notifications
384 * `scheduled_activities` - Scheduled activities, see [`Pleroma.ScheduledActivities`](#pleromascheduledactivity)
389 config :pleroma_job_queue, :queues,
390 federator_incoming: 50,
391 federator_outgoing: 50
394 This config contains two queues: `federator_incoming` and `federator_outgoing`. Both have the `max_jobs` set to `50`.
396 ## Pleroma.Web.Federator.RetryQueue
398 * `enabled`: If set to `true`, failed federation jobs will be retried
399 * `max_jobs`: The maximum amount of parallel federation jobs running at the same time.
400 * `initial_timeout`: The initial timeout in seconds
401 * `max_retries`: The maximum number of times a federation job is retried
403 ## Pleroma.Web.Metadata
404 * `providers`: a list of metadata providers to enable. Providers available:
405 * Pleroma.Web.Metadata.Providers.OpenGraph
406 * Pleroma.Web.Metadata.Providers.TwitterCard
407 * Pleroma.Web.Metadata.Providers.RelMe - add links from user bio with rel=me into the `<header>` as `<link rel=me>`
408 * `unfurl_nsfw`: If set to `true` nsfw attachments will be shown in previews
411 * `enabled`: if enabled the instance will parse metadata from attached links to generate link previews
413 ## :fetch_initial_posts
414 * `enabled`: if enabled, when a new user is federated with, fetch some of their latest posts
415 * `pages`: the amount of pages to fetch
419 Advanced. Tweaks Hackney (http client) connections pools.
421 There's three pools used:
423 * `:federation` for the federation jobs.
424 You may want this pool max_connections to be at least equal to the number of federator jobs + retry queue jobs.
425 * `:media` for rich media, media proxy
426 * `:upload` for uploaded media (if using a remote uploader and `proxy_remote: true`)
428 For each pool, the options are:
430 * `max_connections` - how much connections a pool can hold
431 * `timeout` - retention duration for connections
435 Configuration for the `auto_linker` library:
437 * `class: "auto-linker"` - specify the class to be added to the generated link. false to clear
438 * `rel: "noopener noreferrer"` - override the rel attribute. false to clear
439 * `new_window: true` - set to false to remove `target='_blank'` attribute
440 * `scheme: false` - Set to true to link urls with schema `http://google.com`
441 * `truncate: false` - Set to a number to truncate urls longer then the number. Truncated urls will end in `..`
442 * `strip_prefix: true` - Strip the scheme prefix
443 * `extra: false` - link urls with rarely used schemes (magnet, ipfs, irc, etc.)
459 ## Pleroma.ScheduledActivity
461 * `daily_user_limit`: the number of scheduled activities a user is allowed to create in a single day (Default: `25`)
462 * `total_user_limit`: the number of scheduled activities a user is allowed to create in total (Default: `300`)
463 * `enabled`: whether scheduled activities are sent to the job queue to be executed
465 ## Pleroma.Web.Auth.Authenticator
467 * `Pleroma.Web.Auth.PleromaAuthenticator`: default database authenticator
468 * `Pleroma.Web.Auth.LDAPAuthenticator`: LDAP authentication
472 Use LDAP for user authentication. When a user logs in to the Pleroma
473 instance, the name and password will be verified by trying to authenticate
474 (bind) to an LDAP server. If a user exists in the LDAP directory but there
475 is no account with the same name yet on the Pleroma instance then a new
476 Pleroma account will be created with the same name as the LDAP user name.
478 * `enabled`: enables LDAP authentication
479 * `host`: LDAP server hostname
480 * `port`: LDAP port, e.g. 389 or 636
481 * `ssl`: true to use SSL, usually implies the port 636
482 * `sslopts`: additional SSL options
483 * `tls`: true to start TLS, usually implies the port 389
484 * `tlsopts`: additional TLS options
485 * `base`: LDAP base, e.g. "dc=example,dc=com"
486 * `uid`: LDAP attribute name to authenticate the user, e.g. when "cn", the filter will be "cn=username,base"
490 To enable simple command line interface accessible over ssh, add a setting like this to your configuration file:
494 priv_dir = Path.join([app_dir, "priv/ssh_keys"])
499 handler: "Pleroma.BBS.Handler",
501 password_authenticator: "Pleroma.BBS.Authenticator"
504 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`
508 * `Pleroma.Web.Auth.PleromaAuthenticator`: default database authenticator
509 * `Pleroma.Web.Auth.LDAPAuthenticator`: LDAP authentication
511 Authentication / authorization settings.
513 * `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`.
514 * `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`.
515 * `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>`).
517 ## OAuth consumer mode
519 OAuth consumer mode allows sign in / sign up via external OAuth providers (e.g. Twitter, Facebook, Google, Microsoft, etc.).
520 Implementation is based on Ueberauth; see the list of [available strategies](https://github.com/ueberauth/ueberauth/wiki/List-of-Strategies).
522 Note: each strategy is shipped as a separate dependency; in order to get the strategies, run `OAUTH_CONSUMER_STRATEGIES="..." mix deps.get`,
523 e.g. `OAUTH_CONSUMER_STRATEGIES="twitter facebook google microsoft" mix deps.get`.
524 The server should also be started with `OAUTH_CONSUMER_STRATEGIES="..." mix phx.server` in case you enable any strategies.
526 Note: each strategy requires separate setup (on external provider side and Pleroma side). Below are the guidelines on setting up most popular strategies.
528 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"`
530 * For Twitter, [register an app](https://developer.twitter.com/en/apps), configure callback URL to https://<your_host>/oauth/twitter/callback
532 * 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/
534 * For Google, [register an app](https://console.developers.google.com), configure callback URL to https://<your_host>/oauth/google/callback
536 * For Microsoft, [register an app](https://portal.azure.com), configure callback URL to https://<your_host>/oauth/microsoft/callback
538 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`,
539 per strategy's documentation (e.g. [ueberauth_twitter](https://github.com/ueberauth/ueberauth_twitter)). Example config basing on environment variables:
543 config :ueberauth, Ueberauth.Strategy.Twitter.OAuth,
544 consumer_key: System.get_env("TWITTER_CONSUMER_KEY"),
545 consumer_secret: System.get_env("TWITTER_CONSUMER_SECRET")
548 config :ueberauth, Ueberauth.Strategy.Facebook.OAuth,
549 client_id: System.get_env("FACEBOOK_APP_ID"),
550 client_secret: System.get_env("FACEBOOK_APP_SECRET"),
551 redirect_uri: System.get_env("FACEBOOK_REDIRECT_URI")
554 config :ueberauth, Ueberauth.Strategy.Google.OAuth,
555 client_id: System.get_env("GOOGLE_CLIENT_ID"),
556 client_secret: System.get_env("GOOGLE_CLIENT_SECRET"),
557 redirect_uri: System.get_env("GOOGLE_REDIRECT_URI")
560 config :ueberauth, Ueberauth.Strategy.Microsoft.OAuth,
561 client_id: System.get_env("MICROSOFT_CLIENT_ID"),
562 client_secret: System.get_env("MICROSOFT_CLIENT_SECRET")
564 config :ueberauth, Ueberauth,
566 microsoft: {Ueberauth.Strategy.Microsoft, [callback_params: []]}
570 # Note: make sure to add `keycloak:ueberauth_keycloak_strategy` entry to `OAUTH_CONSUMER_STRATEGIES` environment variable
571 keycloak_url = "https://publicly-reachable-keycloak-instance.org:8080"
573 config :ueberauth, Ueberauth.Strategy.Keycloak.OAuth,
574 client_id: System.get_env("KEYCLOAK_CLIENT_ID"),
575 client_secret: System.get_env("KEYCLOAK_CLIENT_SECRET"),
577 authorize_url: "#{keycloak_url}/auth/realms/master/protocol/openid-connect/auth",
578 token_url: "#{keycloak_url}/auth/realms/master/protocol/openid-connect/token",
579 userinfo_url: "#{keycloak_url}/auth/realms/master/protocol/openid-connect/userinfo",
582 config :ueberauth, Ueberauth,
584 keycloak: {Ueberauth.Strategy.Keycloak, [uid_field: :email]}
588 ## OAuth 2.0 provider - :oauth2
590 Configure OAuth 2 provider capabilities:
592 * `token_expires_in` - The lifetime in seconds of the access token.
593 * `issue_new_refresh_token` - Keeps old refresh token or generate new refresh token when to obtain an access token.
594 * `clean_expired_tokens` - Enable a background job to clean expired oauth tokens. Defaults to `false`.
595 * `clean_expired_tokens_interval` - Interval to run the job to clean expired tokens. Defaults to `86_400_000` (24 hours).
598 * `shortcode_globs`: Location of custom emoji files. `*` can be used as a wildcard. Example `["/emoji/custom/**/*.png"]`
599 * `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"]]`
600 * `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).
604 ### RUM indexing for full text search
605 * `rum_enabled`: If RUM indexes should be used. Defaults to `false`.
607 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.
609 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.
611 To enable them, both the `rum_enabled` flag has to be set and the following special migration has to be run:
613 `mix ecto.migrate --migrations-path priv/repo/optional_migrations/rum_indexing/`
615 This will probably take a long time.
619 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:
621 * The first element: `scale` (Integer). The time scale in milliseconds.
622 * The second element: `limit` (Integer). How many requests to limit in the time scale provided.
624 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.
626 See [`Pleroma.Plugs.RateLimiter`](Pleroma.Plugs.RateLimiter.html) documentation for examples.