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.RejectNonPublic`: Drops posts with non-public visibility settings (See ``:mrf_rejectnonpublic`` section)
90 * `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:.
91 * `public`: Makes the client API in authentificated mode-only except for user-profiles. Useful for disabling the Local Timeline and The Whole Known Network.
92 * `quarantined_instances`: List of ActivityPub instances where private(DMs, followers-only) activities will not be send.
93 * `managed_config`: Whenether the config for pleroma-fe is configured in this config or in ``static/config.json``
94 * `allowed_post_formats`: MIME-type list of formats allowed to be posted (transformed into HTML)
95 * `mrf_transparency`: Make the content of your Message Rewrite Facility settings public (via nodeinfo).
96 * `scope_copy`: Copy the scope (private/unlisted/public) in replies to posts by default.
97 * `subject_line_behavior`: Allows changing the default behaviour of subject lines in replies. Valid values:
98 * "email": Copy and preprend re:, as in email.
99 * "masto": Copy verbatim, as in Mastodon.
100 * "noop": Don't copy the subject.
101 * `always_show_subject_input`: When set to false, auto-hide the subject field when it's empty.
102 * `extended_nickname_format`: Set to `true` to use extended local nicknames format (allows underscores/dashes). This will break federation with
103 older software for theses nicknames.
104 * `max_pinned_statuses`: The maximum number of pinned statuses. `0` will disable the feature.
105 * `autofollowed_nicknames`: Set to nicknames of (local) users that every new user should automatically follow.
106 * `no_attachment_links`: Set to true to disable automatically adding attachment link text to statuses
107 * `welcome_message`: A message that will be send to a newly registered users as a direct message.
108 * `welcome_user_nickname`: The nickname of the local user that sends the welcome message.
109 * `max_report_comment_size`: The maximum size of the report comment (Default: `1000`)
110 * `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`)
111 * `healthcheck`: if set to true, system data will be shown on ``/api/pleroma/healthcheck``.
112 * `remote_post_retention_days`: the default amount of days to retain remote posts when pruning the database
114 ## :app_account_creation
115 REST API for creating an account settings
116 * `enabled`: Enable/disable registration
117 * `max_requests`: Number of requests allowed for creating accounts
118 * `interval`: Interval for restricting requests for one ip (seconds)
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
232 ## :mrf_rejectnonpublic
233 * `allow_followersonly`: whether to allow followers-only posts
234 * `allow_direct`: whether to allow direct messages
237 * `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.
238 * `reject_threshold`: Number of mentioned users after which the messaged gets rejected. Set to 0 to disable.
241 * `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)
242 * `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)
243 * `replace`: A list of tuples containing `{pattern, replacement}`, `pattern` can be a string or a [regular expression](https://hexdocs.pm/elixir/Regex.html)
246 * `enabled`: Enables proxying of remote media to the instance’s proxy
247 * `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.
248 * `proxy_opts`: All options defined in `Pleroma.ReverseProxy` documentation, defaults to `[max_body_length: (25*1_048_576)]`.
249 * `whitelist`: List of domains to bypass the mediaproxy
252 * `enabled`: Enables the gopher interface
253 * `ip`: IP address to bind to
254 * `port`: Port to bind to
255 * `dstport`: Port advertised in urls (optional, defaults to `port`)
257 ## Pleroma.Web.Endpoint
258 `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
259 * `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
260 - `ip` - a tuple consisting of 4 integers
262 * `url` - a list containing the configuration for generating urls, accepts
263 - `host` - the host without the scheme and a post (e.g `example.com`, not `https://example.com:2020`)
264 - `scheme` - e.g `http`, `https`
267 * `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.
271 **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
275 config :pleroma, Pleroma.Web.Endpoint,
276 url: [host: "example.com", port: 2020, scheme: "https"],
278 # start copied from config.exs
282 {"/api/v1/streaming", Pleroma.Web.MastodonAPI.WebsocketHandler, []},
283 {"/websocket", Phoenix.Endpoint.CowboyWebSocket,
284 {Phoenix.Transports.WebSocket,
285 {Pleroma.Web.Endpoint, Pleroma.Web.UserSocket, websocket_config}}},
286 {:_, Phoenix.Endpoint.Cowboy2Handler, {Pleroma.Web.Endpoint, []}}
288 # end copied from config.exs
295 This will make Pleroma listen on `127.0.0.1` port `8080` and generate urls starting with `https://example.com:2020`
298 * ``accept_blocks``: Whether to accept incoming block activities from other instances
299 * ``unfollow_blocked``: Whether blocks result in people getting unfollowed
300 * ``outgoing_blocks``: Whether to federate blocks to other instances
301 * ``deny_follow_blocked``: Whether to disallow following an account that has blocked the user in question
304 * ``enabled``: Whether the managed content security policy is enabled
305 * ``sts``: Whether to additionally send a `Strict-Transport-Security` header
306 * ``sts_max_age``: The maximum age for the `Strict-Transport-Security` header if sent
307 * ``ct_max_age``: The maximum age for the `Expect-CT` header if sent
308 * ``referrer_policy``: The referrer policy to use, either `"same-origin"` or `"no-referrer"`
309 * ``report_uri``: Adds the specified url to `report-uri` and `report-to` group in CSP header.
311 ## :mrf_user_allowlist
313 The keys in this section are the domain names that the policy should apply to.
314 Each key should be assigned a list of users that should be allowed through by
315 their ActivityPub ID.
320 config :pleroma, :mrf_user_allowlist,
321 "example.org": ["https://example.org/users/admin"]
324 ## :web_push_encryption, :vapid_details
326 Web Push Notifications configuration. You can use the mix task `mix web_push.gen.keypair` to generate it.
328 * ``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.
329 * ``public_key``: VAPID public key
330 * ``private_key``: VAPID private key
333 * `enabled`: Whether the captcha should be shown on registration
334 * `method`: The method/service to use for captcha
335 * `seconds_valid`: The time in seconds for which the captcha is valid
337 ### Pleroma.Captcha.Kocaptcha
338 Kocaptcha is a very simple captcha service with a single API endpoint,
339 the source code is here: https://github.com/koto-bank/kocaptcha. The default endpoint
340 `https://captcha.kotobank.ch` is hosted by the developer.
342 * `endpoint`: the kocaptcha endpoint to use
346 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:
349 config :pleroma, :admin_token, "somerandomtoken"
355 curl "http://localhost:4000/api/pleroma/admin/invite_token?admin_token=somerandomtoken"
358 ## :pleroma_job_queue
360 [Pleroma Job Queue](https://git.pleroma.social/pleroma/pleroma_job_queue) configuration: a list of queues with maximum concurrent jobs.
362 Pleroma has the following queues:
364 * `federator_outgoing` - Outgoing federation
365 * `federator_incoming` - Incoming federation
366 * `mailer` - Email sender, see [`Pleroma.Emails.Mailer`](#pleroma-emails-mailer)
367 * `transmogrifier` - Transmogrifier
368 * `web_push` - Web push notifications
369 * `scheduled_activities` - Scheduled activities, see [`Pleroma.ScheduledActivities`](#pleromascheduledactivity)
374 config :pleroma_job_queue, :queues,
375 federator_incoming: 50,
376 federator_outgoing: 50
379 This config contains two queues: `federator_incoming` and `federator_outgoing`. Both have the `max_jobs` set to `50`.
381 ## Pleroma.Web.Federator.RetryQueue
383 * `enabled`: If set to `true`, failed federation jobs will be retried
384 * `max_jobs`: The maximum amount of parallel federation jobs running at the same time.
385 * `initial_timeout`: The initial timeout in seconds
386 * `max_retries`: The maximum number of times a federation job is retried
388 ## Pleroma.Web.Metadata
389 * `providers`: a list of metadata providers to enable. Providers available:
390 * Pleroma.Web.Metadata.Providers.OpenGraph
391 * Pleroma.Web.Metadata.Providers.TwitterCard
392 * Pleroma.Web.Metadata.Providers.RelMe - add links from user bio with rel=me into the `<header>` as `<link rel=me>`
393 * `unfurl_nsfw`: If set to `true` nsfw attachments will be shown in previews
396 * `enabled`: if enabled the instance will parse metadata from attached links to generate link previews
398 ## :fetch_initial_posts
399 * `enabled`: if enabled, when a new user is federated with, fetch some of their latest posts
400 * `pages`: the amount of pages to fetch
404 Advanced. Tweaks Hackney (http client) connections pools.
406 There's three pools used:
408 * `:federation` for the federation jobs.
409 You may want this pool max_connections to be at least equal to the number of federator jobs + retry queue jobs.
410 * `:media` for rich media, media proxy
411 * `:upload` for uploaded media (if using a remote uploader and `proxy_remote: true`)
413 For each pool, the options are:
415 * `max_connections` - how much connections a pool can hold
416 * `timeout` - retention duration for connections
420 Configuration for the `auto_linker` library:
422 * `class: "auto-linker"` - specify the class to be added to the generated link. false to clear
423 * `rel: "noopener noreferrer"` - override the rel attribute. false to clear
424 * `new_window: true` - set to false to remove `target='_blank'` attribute
425 * `scheme: false` - Set to true to link urls with schema `http://google.com`
426 * `truncate: false` - Set to a number to truncate urls longer then the number. Truncated urls will end in `..`
427 * `strip_prefix: true` - Strip the scheme prefix
428 * `extra: false` - link urls with rarely used schemes (magnet, ipfs, irc, etc.)
444 ## Pleroma.ScheduledActivity
446 * `daily_user_limit`: the number of scheduled activities a user is allowed to create in a single day (Default: `25`)
447 * `total_user_limit`: the number of scheduled activities a user is allowed to create in total (Default: `300`)
448 * `enabled`: whether scheduled activities are sent to the job queue to be executed
450 ## Pleroma.Web.Auth.Authenticator
452 * `Pleroma.Web.Auth.PleromaAuthenticator`: default database authenticator
453 * `Pleroma.Web.Auth.LDAPAuthenticator`: LDAP authentication
457 Use LDAP for user authentication. When a user logs in to the Pleroma
458 instance, the name and password will be verified by trying to authenticate
459 (bind) to an LDAP server. If a user exists in the LDAP directory but there
460 is no account with the same name yet on the Pleroma instance then a new
461 Pleroma account will be created with the same name as the LDAP user name.
463 * `enabled`: enables LDAP authentication
464 * `host`: LDAP server hostname
465 * `port`: LDAP port, e.g. 389 or 636
466 * `ssl`: true to use SSL, usually implies the port 636
467 * `sslopts`: additional SSL options
468 * `tls`: true to start TLS, usually implies the port 389
469 * `tlsopts`: additional TLS options
470 * `base`: LDAP base, e.g. "dc=example,dc=com"
471 * `uid`: LDAP attribute name to authenticate the user, e.g. when "cn", the filter will be "cn=username,base"
475 To enable simple command line interface accessible over ssh, add a setting like this to your configuration file:
479 priv_dir = Path.join([app_dir, "priv/ssh_keys"])
484 handler: "Pleroma.BBS.Handler",
486 password_authenticator: "Pleroma.BBS.Authenticator"
489 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`
493 * `Pleroma.Web.Auth.PleromaAuthenticator`: default database authenticator
494 * `Pleroma.Web.Auth.LDAPAuthenticator`: LDAP authentication
496 Authentication / authorization settings.
498 * `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`.
499 * `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`.
500 * `oauth_consumer_strategies`: the list of enabled OAuth consumer strategies; by default it's set by OAUTH_CONSUMER_STRATEGIES environment variable.
502 ## OAuth consumer mode
504 OAuth consumer mode allows sign in / sign up via external OAuth providers (e.g. Twitter, Facebook, Google, Microsoft, etc.).
505 Implementation is based on Ueberauth; see the list of [available strategies](https://github.com/ueberauth/ueberauth/wiki/List-of-Strategies).
507 Note: each strategy is shipped as a separate dependency; in order to get the strategies, run `OAUTH_CONSUMER_STRATEGIES="..." mix deps.get`,
508 e.g. `OAUTH_CONSUMER_STRATEGIES="twitter facebook google microsoft" mix deps.get`.
509 The server should also be started with `OAUTH_CONSUMER_STRATEGIES="..." mix phx.server` in case you enable any strategies.
511 Note: each strategy requires separate setup (on external provider side and Pleroma side). Below are the guidelines on setting up most popular strategies.
513 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"`
515 * For Twitter, [register an app](https://developer.twitter.com/en/apps), configure callback URL to https://<your_host>/oauth/twitter/callback
517 * 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/
519 * For Google, [register an app](https://console.developers.google.com), configure callback URL to https://<your_host>/oauth/google/callback
521 * For Microsoft, [register an app](https://portal.azure.com), configure callback URL to https://<your_host>/oauth/microsoft/callback
523 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`,
524 per strategy's documentation (e.g. [ueberauth_twitter](https://github.com/ueberauth/ueberauth_twitter)). Example config basing on environment variables:
528 config :ueberauth, Ueberauth.Strategy.Twitter.OAuth,
529 consumer_key: System.get_env("TWITTER_CONSUMER_KEY"),
530 consumer_secret: System.get_env("TWITTER_CONSUMER_SECRET")
533 config :ueberauth, Ueberauth.Strategy.Facebook.OAuth,
534 client_id: System.get_env("FACEBOOK_APP_ID"),
535 client_secret: System.get_env("FACEBOOK_APP_SECRET"),
536 redirect_uri: System.get_env("FACEBOOK_REDIRECT_URI")
539 config :ueberauth, Ueberauth.Strategy.Google.OAuth,
540 client_id: System.get_env("GOOGLE_CLIENT_ID"),
541 client_secret: System.get_env("GOOGLE_CLIENT_SECRET"),
542 redirect_uri: System.get_env("GOOGLE_REDIRECT_URI")
545 config :ueberauth, Ueberauth.Strategy.Microsoft.OAuth,
546 client_id: System.get_env("MICROSOFT_CLIENT_ID"),
547 client_secret: System.get_env("MICROSOFT_CLIENT_SECRET")
549 config :ueberauth, Ueberauth,
551 microsoft: {Ueberauth.Strategy.Microsoft, [callback_params: []]}
555 ## OAuth 2.0 provider - :oauth2
557 Configure OAuth 2 provider capabilities:
559 * `token_expires_in` - The lifetime in seconds of the access token.
560 * `issue_new_refresh_token` - Keeps old refresh token or generate new refresh token when to obtain an access token.
561 * `clean_expired_tokens` - Enable a background job to clean expired oauth tokens. Defaults to `false`.
562 * `clean_expired_tokens_interval` - Interval to run the job to clean expired tokens. Defaults to `86_400_000` (24 hours).
565 * `shortcode_globs`: Location of custom emoji files. `*` can be used as a wildcard. Example `["/emoji/custom/**/*.png"]`
566 * `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"]]`
567 * `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).
571 ### RUM indexing for full text search
572 * `rum_enabled`: If RUM indexes should be used. Defaults to `false`.
574 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.
576 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.
578 To enable them, both the `rum_enabled` flag has to be set and the following special migration has to be run:
580 `mix ecto.migrate --migrations-path priv/repo/optional_migrations/rum_indexing/`
582 This will probably take a long time.