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 * `registrations_open`: Enable registrations for anyone, invitations can be enabled when false.
75 * `invites_enabled`: Enable user invitations for admins (depends on `registrations_open: false`).
76 * `account_activation_required`: Require users to confirm their emails before signing in.
77 * `federating`: Enable federation with other instances
78 * `federation_reachability_timeout_days`: Timeout (in days) of each external federation target being unreachable prior to pausing federating to it.
79 * `allow_relay`: Enable Pleroma’s Relay, which makes it possible to follow a whole instance
80 * `rewrite_policy`: Message Rewrite Policy, either one or a list. Here are the ones available by default:
81 * `Pleroma.Web.ActivityPub.MRF.NoOpPolicy`: Doesn’t modify activities (default)
82 * `Pleroma.Web.ActivityPub.MRF.DropPolicy`: Drops all activities. It generally doesn’t makes sense to use in production
83 * `Pleroma.Web.ActivityPub.MRF.SimplePolicy`: Restrict the visibility of activities from certains instances (See ``:mrf_simple`` section)
84 * `Pleroma.Web.ActivityPub.MRF.RejectNonPublic`: Drops posts with non-public visibility settings (See ``:mrf_rejectnonpublic`` section)
85 * `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:.
86 * `public`: Makes the client API in authentificated mode-only except for user-profiles. Useful for disabling the Local Timeline and The Whole Known Network.
87 * `quarantined_instances`: List of ActivityPub instances where private(DMs, followers-only) activities will not be send.
88 * `managed_config`: Whenether the config for pleroma-fe is configured in this config or in ``static/config.json``
89 * `allowed_post_formats`: MIME-type list of formats allowed to be posted (transformed into HTML)
90 * `mrf_transparency`: Make the content of your Message Rewrite Facility settings public (via nodeinfo).
91 * `scope_copy`: Copy the scope (private/unlisted/public) in replies to posts by default.
92 * `subject_line_behavior`: Allows changing the default behaviour of subject lines in replies. Valid values:
93 * "email": Copy and preprend re:, as in email.
94 * "masto": Copy verbatim, as in Mastodon.
95 * "noop": Don't copy the subject.
96 * `always_show_subject_input`: When set to false, auto-hide the subject field when it's empty.
97 * `extended_nickname_format`: Set to `true` to use extended local nicknames format (allows underscores/dashes). This will break federation with
98 older software for theses nicknames.
99 * `max_pinned_statuses`: The maximum number of pinned statuses. `0` will disable the feature.
100 * `autofollowed_nicknames`: Set to nicknames of (local) users that every new user should automatically follow.
101 * `no_attachment_links`: Set to true to disable automatically adding attachment link text to statuses
102 * `welcome_message`: A message that will be send to a newly registered users as a direct message.
103 * `welcome_user_nickname`: The nickname of the local user that sends the welcome message.
104 * `max_report_comment_size`: The maximum size of the report comment (Default: `1000`)
105 * `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`)
106 * `healthcheck`: if set to true, system data will be shown on ``/api/pleroma/healthcheck``.
107 * `remote_post_retention_days`: the default amount of days to retain remote posts when pruning the database
109 ## :app_account_creation
110 REST API for creating an account settings
111 * `enabled`: Enable/disable registration
112 * `max_requests`: Number of requests allowed for creating accounts
113 * `interval`: Interval for restricting requests for one ip (seconds)
116 * `backends`: `:console` is used to send logs to stdout, `{ExSyslogger, :ex_syslogger}` to log to syslog, and `Quack.Logger` to log to Slack
118 An example to enable ONLY ExSyslogger (f/ex in ``prod.secret.exs``) with info and debug suppressed:
121 backends: [{ExSyslogger, :ex_syslogger}]
123 config :logger, :ex_syslogger,
127 Another example, keeping console output and adding the pid to syslog output:
130 backends: [:console, {ExSyslogger, :ex_syslogger}]
132 config :logger, :ex_syslogger,
134 option: [:pid, :ndelay]
137 See: [logger’s documentation](https://hexdocs.pm/logger/Logger.html) and [ex_syslogger’s documentation](https://hexdocs.pm/ex_syslogger/)
139 An example of logging info to local syslog, but warn to a Slack channel:
142 backends: [ {ExSyslogger, :ex_syslogger}, Quack.Logger ],
145 config :logger, :ex_syslogger,
148 format: "$metadata[$level] $message"
153 webhook_url: "https://hooks.slack.com/services/YOUR-API-KEY-HERE"
156 See the [Quack Github](https://github.com/azohra/quack) for more details
158 ## :frontend_configurations
160 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.
162 Frontends can access these settings at `/api/pleroma/frontend_configurations`
164 To add your own configuration for PleromaFE, use it like this:
167 config :pleroma, :frontend_configurations,
169 theme: "pleroma-dark",
170 # ... see /priv/static/static/config.json for the available keys.
173 showInstanceSpecificPanel: true
177 These settings **need to be complete**, they will override the defaults.
179 NOTE: for versions < 1.0, you need to set [`:fe`](#fe) to false, as shown a few lines below.
182 __THIS IS DEPRECATED__
184 If you are using this method, please change it to the [`frontend_configurations`](#frontend_configurations) method.
185 Please **set this option to false** in your config like this:
188 config :pleroma, :fe, false
191 This section is used to configure Pleroma-FE, unless ``:managed_config`` in ``:instance`` is set to false.
193 * `theme`: Which theme to use, they are defined in ``styles.json``
194 * `logo`: URL of the logo, defaults to Pleroma’s logo
195 * `logo_mask`: Whether to use only the logo's shape as a mask (true) or as a regular image (false)
196 * `logo_margin`: What margin to use around the logo
197 * `background`: URL of the background, unless viewing a user profile with a background that is set
198 * `redirect_root_no_login`: relative URL which indicates where to redirect when a user isn’t logged in.
199 * `redirect_root_login`: relative URL which indicates where to redirect when a user is logged in.
200 * `show_instance_panel`: Whenether to show the instance’s specific panel.
201 * `scope_options_enabled`: Enable setting an notice visibility and subject/CW when posting
202 * `formatting_options_enabled`: Enable setting a formatting different than plain-text (ie. HTML, Markdown) when posting, relates to ``:instance, allowed_post_formats``
203 * `collapse_message_with_subjects`: When a message has a subject(aka Content Warning), collapse it by default
204 * `hide_post_stats`: Hide notices statistics(repeats, favorites, …)
205 * `hide_user_stats`: Hide profile statistics(posts, posts per day, followers, followings, …)
209 This section configures assets to be used with various frontends. Currently the only option
210 relates to mascots on the mastodon frontend
212 * `mascots`: KeywordList of mascots, each element __MUST__ contain both a `url` and a
214 * `default_mascot`: An element from `mascots` - This will be used as the default mascot
215 on MastoFE (default: `:pleroma_fox_tan`)
218 * `media_removal`: List of instances to remove medias from
219 * `media_nsfw`: List of instances to put medias as NSFW(sensitive) from
220 * `federated_timeline_removal`: List of instances to remove from Federated (aka The Whole Known Network) Timeline
221 * `reject`: List of instances to reject any activities from
222 * `accept`: List of instances to accept any activities from
224 ## :mrf_rejectnonpublic
225 * `allow_followersonly`: whether to allow followers-only posts
226 * `allow_direct`: whether to allow direct messages
229 * `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.
230 * `reject_threshold`: Number of mentioned users after which the messaged gets rejected. Set to 0 to disable.
233 * `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)
234 * `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)
235 * `replace`: A list of tuples containing `{pattern, replacement}`, `pattern` can be a string or a [regular expression](https://hexdocs.pm/elixir/Regex.html)
238 * `enabled`: Enables proxying of remote media to the instance’s proxy
239 * `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.
240 * `proxy_opts`: All options defined in `Pleroma.ReverseProxy` documentation, defaults to `[max_body_length: (25*1_048_576)]`.
241 * `whitelist`: List of domains to bypass the mediaproxy
244 * `enabled`: Enables the gopher interface
245 * `ip`: IP address to bind to
246 * `port`: Port to bind to
247 * `dstport`: Port advertised in urls (optional, defaults to `port`)
249 ## Pleroma.Web.Endpoint
250 `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
251 * `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
252 - `ip` - a tuple consisting of 4 integers
254 * `url` - a list containing the configuration for generating urls, accepts
255 - `host` - the host without the scheme and a post (e.g `example.com`, not `https://example.com:2020`)
256 - `scheme` - e.g `http`, `https`
259 * `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.
263 **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
267 config :pleroma, Pleroma.Web.Endpoint,
268 url: [host: "example.com", port: 2020, scheme: "https"],
270 # start copied from config.exs
274 {"/api/v1/streaming", Pleroma.Web.MastodonAPI.WebsocketHandler, []},
275 {"/websocket", Phoenix.Endpoint.CowboyWebSocket,
276 {Phoenix.Transports.WebSocket,
277 {Pleroma.Web.Endpoint, Pleroma.Web.UserSocket, websocket_config}}},
278 {:_, Phoenix.Endpoint.Cowboy2Handler, {Pleroma.Web.Endpoint, []}}
280 # end copied from config.exs
287 This will make Pleroma listen on `127.0.0.1` port `8080` and generate urls starting with `https://example.com:2020`
290 * ``accept_blocks``: Whether to accept incoming block activities from other instances
291 * ``unfollow_blocked``: Whether blocks result in people getting unfollowed
292 * ``outgoing_blocks``: Whether to federate blocks to other instances
293 * ``deny_follow_blocked``: Whether to disallow following an account that has blocked the user in question
296 * ``enabled``: Whether the managed content security policy is enabled
297 * ``sts``: Whether to additionally send a `Strict-Transport-Security` header
298 * ``sts_max_age``: The maximum age for the `Strict-Transport-Security` header if sent
299 * ``ct_max_age``: The maximum age for the `Expect-CT` header if sent
300 * ``referrer_policy``: The referrer policy to use, either `"same-origin"` or `"no-referrer"`
301 * ``report_uri``: Adds the specified url to `report-uri` and `report-to` group in CSP header.
303 ## :mrf_user_allowlist
305 The keys in this section are the domain names that the policy should apply to.
306 Each key should be assigned a list of users that should be allowed through by
307 their ActivityPub ID.
312 config :pleroma, :mrf_user_allowlist,
313 "example.org": ["https://example.org/users/admin"]
316 ## :web_push_encryption, :vapid_details
318 Web Push Notifications configuration. You can use the mix task `mix web_push.gen.keypair` to generate it.
320 * ``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.
321 * ``public_key``: VAPID public key
322 * ``private_key``: VAPID private key
325 * `enabled`: Whether the captcha should be shown on registration
326 * `method`: The method/service to use for captcha
327 * `seconds_valid`: The time in seconds for which the captcha is valid
329 ### Pleroma.Captcha.Kocaptcha
330 Kocaptcha is a very simple captcha service with a single API endpoint,
331 the source code is here: https://github.com/koto-bank/kocaptcha. The default endpoint
332 `https://captcha.kotobank.ch` is hosted by the developer.
334 * `endpoint`: the kocaptcha endpoint to use
338 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:
341 config :pleroma, :admin_token, "somerandomtoken"
347 curl "http://localhost:4000/api/pleroma/admin/invite_token?admin_token=somerandomtoken"
350 ## :pleroma_job_queue
352 [Pleroma Job Queue](https://git.pleroma.social/pleroma/pleroma_job_queue) configuration: a list of queues with maximum concurrent jobs.
354 Pleroma has the following queues:
356 * `federator_outgoing` - Outgoing federation
357 * `federator_incoming` - Incoming federation
358 * `mailer` - Email sender, see [`Pleroma.Emails.Mailer`](#pleroma-emails-mailer)
359 * `transmogrifier` - Transmogrifier
360 * `web_push` - Web push notifications
361 * `scheduled_activities` - Scheduled activities, see [`Pleroma.ScheduledActivities`](#pleromascheduledactivity)
366 config :pleroma_job_queue, :queues,
367 federator_incoming: 50,
368 federator_outgoing: 50
371 This config contains two queues: `federator_incoming` and `federator_outgoing`. Both have the `max_jobs` set to `50`.
373 ## Pleroma.Web.Federator.RetryQueue
375 * `enabled`: If set to `true`, failed federation jobs will be retried
376 * `max_jobs`: The maximum amount of parallel federation jobs running at the same time.
377 * `initial_timeout`: The initial timeout in seconds
378 * `max_retries`: The maximum number of times a federation job is retried
380 ## Pleroma.Web.Metadata
381 * `providers`: a list of metadata providers to enable. Providers available:
382 * Pleroma.Web.Metadata.Providers.OpenGraph
383 * Pleroma.Web.Metadata.Providers.TwitterCard
384 * Pleroma.Web.Metadata.Providers.RelMe - add links from user bio with rel=me into the `<header>` as `<link rel=me>`
385 * `unfurl_nsfw`: If set to `true` nsfw attachments will be shown in previews
388 * `enabled`: if enabled the instance will parse metadata from attached links to generate link previews
390 ## :fetch_initial_posts
391 * `enabled`: if enabled, when a new user is federated with, fetch some of their latest posts
392 * `pages`: the amount of pages to fetch
396 Advanced. Tweaks Hackney (http client) connections pools.
398 There's three pools used:
400 * `:federation` for the federation jobs.
401 You may want this pool max_connections to be at least equal to the number of federator jobs + retry queue jobs.
402 * `:media` for rich media, media proxy
403 * `:upload` for uploaded media (if using a remote uploader and `proxy_remote: true`)
405 For each pool, the options are:
407 * `max_connections` - how much connections a pool can hold
408 * `timeout` - retention duration for connections
412 Configuration for the `auto_linker` library:
414 * `class: "auto-linker"` - specify the class to be added to the generated link. false to clear
415 * `rel: "noopener noreferrer"` - override the rel attribute. false to clear
416 * `new_window: true` - set to false to remove `target='_blank'` attribute
417 * `scheme: false` - Set to true to link urls with schema `http://google.com`
418 * `truncate: false` - Set to a number to truncate urls longer then the number. Truncated urls will end in `..`
419 * `strip_prefix: true` - Strip the scheme prefix
420 * `extra: false` - link urls with rarely used schemes (magnet, ipfs, irc, etc.)
436 ## Pleroma.ScheduledActivity
438 * `daily_user_limit`: the number of scheduled activities a user is allowed to create in a single day (Default: `25`)
439 * `total_user_limit`: the number of scheduled activities a user is allowed to create in total (Default: `300`)
440 * `enabled`: whether scheduled activities are sent to the job queue to be executed
442 ## Pleroma.Web.Auth.Authenticator
444 * `Pleroma.Web.Auth.PleromaAuthenticator`: default database authenticator
445 * `Pleroma.Web.Auth.LDAPAuthenticator`: LDAP authentication
449 Use LDAP for user authentication. When a user logs in to the Pleroma
450 instance, the name and password will be verified by trying to authenticate
451 (bind) to an LDAP server. If a user exists in the LDAP directory but there
452 is no account with the same name yet on the Pleroma instance then a new
453 Pleroma account will be created with the same name as the LDAP user name.
455 * `enabled`: enables LDAP authentication
456 * `host`: LDAP server hostname
457 * `port`: LDAP port, e.g. 389 or 636
458 * `ssl`: true to use SSL, usually implies the port 636
459 * `sslopts`: additional SSL options
460 * `tls`: true to start TLS, usually implies the port 389
461 * `tlsopts`: additional TLS options
462 * `base`: LDAP base, e.g. "dc=example,dc=com"
463 * `uid`: LDAP attribute name to authenticate the user, e.g. when "cn", the filter will be "cn=username,base"
467 To enable simple command line interface accessible over ssh, add a setting like this to your configuration file:
471 priv_dir = Path.join([app_dir, "priv/ssh_keys"])
476 handler: "Pleroma.BBS.Handler",
478 password_authenticator: "Pleroma.BBS.Authenticator"
481 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`
485 * `Pleroma.Web.Auth.PleromaAuthenticator`: default database authenticator
486 * `Pleroma.Web.Auth.LDAPAuthenticator`: LDAP authentication
488 Authentication / authorization settings.
490 * `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`.
491 * `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`.
492 * `oauth_consumer_strategies`: the list of enabled OAuth consumer strategies; by default it's set by OAUTH_CONSUMER_STRATEGIES environment variable.
494 ## OAuth consumer mode
496 OAuth consumer mode allows sign in / sign up via external OAuth providers (e.g. Twitter, Facebook, Google, Microsoft, etc.).
497 Implementation is based on Ueberauth; see the list of [available strategies](https://github.com/ueberauth/ueberauth/wiki/List-of-Strategies).
499 Note: each strategy is shipped as a separate dependency; in order to get the strategies, run `OAUTH_CONSUMER_STRATEGIES="..." mix deps.get`,
500 e.g. `OAUTH_CONSUMER_STRATEGIES="twitter facebook google microsoft" mix deps.get`.
501 The server should also be started with `OAUTH_CONSUMER_STRATEGIES="..." mix phx.server` in case you enable any strategies.
503 Note: each strategy requires separate setup (on external provider side and Pleroma side). Below are the guidelines on setting up most popular strategies.
505 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"`
507 * For Twitter, [register an app](https://developer.twitter.com/en/apps), configure callback URL to https://<your_host>/oauth/twitter/callback
509 * 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/
511 * For Google, [register an app](https://console.developers.google.com), configure callback URL to https://<your_host>/oauth/google/callback
513 * For Microsoft, [register an app](https://portal.azure.com), configure callback URL to https://<your_host>/oauth/microsoft/callback
515 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`,
516 per strategy's documentation (e.g. [ueberauth_twitter](https://github.com/ueberauth/ueberauth_twitter)). Example config basing on environment variables:
520 config :ueberauth, Ueberauth.Strategy.Twitter.OAuth,
521 consumer_key: System.get_env("TWITTER_CONSUMER_KEY"),
522 consumer_secret: System.get_env("TWITTER_CONSUMER_SECRET")
525 config :ueberauth, Ueberauth.Strategy.Facebook.OAuth,
526 client_id: System.get_env("FACEBOOK_APP_ID"),
527 client_secret: System.get_env("FACEBOOK_APP_SECRET"),
528 redirect_uri: System.get_env("FACEBOOK_REDIRECT_URI")
531 config :ueberauth, Ueberauth.Strategy.Google.OAuth,
532 client_id: System.get_env("GOOGLE_CLIENT_ID"),
533 client_secret: System.get_env("GOOGLE_CLIENT_SECRET"),
534 redirect_uri: System.get_env("GOOGLE_REDIRECT_URI")
537 config :ueberauth, Ueberauth.Strategy.Microsoft.OAuth,
538 client_id: System.get_env("MICROSOFT_CLIENT_ID"),
539 client_secret: System.get_env("MICROSOFT_CLIENT_SECRET")
541 config :ueberauth, Ueberauth,
543 microsoft: {Ueberauth.Strategy.Microsoft, [callback_params: []]}
547 ## OAuth 2.0 provider - :oauth2
549 Configure OAuth 2 provider capabilities:
551 * `token_expires_in` - The lifetime in seconds of the access token.
552 * `issue_new_refresh_token` - Keeps old refresh token or generate new refresh token when to obtain an access token.
553 * `clean_expired_tokens` - Enable a background job to clean expired oauth tokens. Defaults to `false`.
554 * `clean_expired_tokens_interval` - Interval to run the job to clean expired tokens. Defaults to `86_400_000` (24 hours).
557 * `shortcode_globs`: Location of custom emoji files. `*` can be used as a wildcard. Example `["/emoji/custom/**/*.png"]`
558 * `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"]]`
559 * `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).
563 ### RUM indexing for full text search
564 * `rum_enabled`: If RUM indexes should be used. Defaults to `false`.
566 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.
568 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.
570 To enable them, both the `rum_enabled` flag has to be set and the following special migration has to be run:
572 `mix ecto.migrate --migrations-path priv/repo/optional_migrations/rum_indexing/`
574 This will probably take a long time.