Merge remote-tracking branch 'pleroma/develop' into alias-router-helpers
[akkoma] / docs / configuration / cheatsheet.md
1 # Configuration Cheat Sheet
2
3 This is a cheat sheet for Pleroma configuration file, any setting possible to configure should be listed here.
4
5 For OTP installations the configuration is typically stored in `/etc/pleroma/config.exs`.
6
7 For from source installations Pleroma configuration works by first importing the base config `config/config.exs`, then overriding it by the environment config `config/$MIX_ENV.exs` and then overriding it by user config `config/$MIX_ENV.secret.exs`. In from source installations you should always make the changes to the user config and NEVER to the base config to avoid breakages and merge conflicts. So for production you change/add configuration to `config/prod.secret.exs`.
8
9 To add configuration to your config file, you can copy it from the base config. The latest version of it can be viewed [here](https://git.pleroma.social/pleroma/pleroma/blob/develop/config/config.exs). You can also use this file if you don't know how an option is supposed to be formatted.
10
11 ## :chat
12
13 * `enabled` - Enables the backend chat. Defaults to `true`.
14
15 ## :instance
16 * `name`: The instance’s name.
17 * `email`: Email used to reach an Administrator/Moderator of the instance.
18 * `notify_email`: Email used for notifications.
19 * `description`: The instance’s description, can be seen in nodeinfo and ``/api/v1/instance``.
20 * `limit`: Posts character limit (CW/Subject included in the counter).
21 * `description_limit`: The character limit for image descriptions.
22 * `chat_limit`: Character limit of the instance chat messages.
23 * `remote_limit`: Hard character limit beyond which remote posts will be dropped.
24 * `upload_limit`: File size limit of uploads (except for avatar, background, banner).
25 * `avatar_upload_limit`: File size limit of user’s profile avatars.
26 * `background_upload_limit`: File size limit of user’s profile backgrounds.
27 * `banner_upload_limit`: File size limit of user’s profile banners.
28 * `poll_limits`: A map with poll limits for **local** polls.
29 * `max_options`: Maximum number of options.
30 * `max_option_chars`: Maximum number of characters per option.
31 * `min_expiration`: Minimum expiration time (in seconds).
32 * `max_expiration`: Maximum expiration time (in seconds).
33 * `registrations_open`: Enable registrations for anyone, invitations can be enabled when false.
34 * `invites_enabled`: Enable user invitations for admins (depends on `registrations_open: false`).
35 * `account_activation_required`: Require users to confirm their emails before signing in.
36 * `account_approval_required`: Require users to be manually approved by an admin before signing in.
37 * `federating`: Enable federation with other instances.
38 * `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.
39 * `federation_reachability_timeout_days`: Timeout (in days) of each external federation target being unreachable prior to pausing federating to it.
40 * `allow_relay`: Enable Pleroma’s Relay, which makes it possible to follow a whole instance.
41 * `public`: Makes the client API in authenticated mode-only except for user-profiles. Useful for disabling the Local Timeline and The Whole Known Network. Note that there is a dependent setting restricting or allowing unauthenticated access to specific resources, see `restrict_unauthenticated` for more details.
42 * `quarantined_instances`: List of ActivityPub instances where private (DMs, followers-only) activities will not be send.
43 * `allowed_post_formats`: MIME-type list of formats allowed to be posted (transformed into HTML).
44 * `extended_nickname_format`: Set to `true` to use extended local nicknames format (allows underscores/dashes). This will break federation with
45 older software for theses nicknames.
46 * `max_pinned_statuses`: The maximum number of pinned statuses. `0` will disable the feature.
47 * `autofollowed_nicknames`: Set to nicknames of (local) users that every new user should automatically follow.
48 * `autofollowing_nicknames`: Set to nicknames of (local) users that automatically follows every newly registered user.
49 * `attachment_links`: Set to true to enable automatically adding attachment link text to statuses.
50 * `max_report_comment_size`: The maximum size of the report comment (Default: `1000`).
51 * `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`.
52 * `healthcheck`: If set to true, system data will be shown on ``/api/v1/pleroma/healthcheck``.
53 * `remote_post_retention_days`: The default amount of days to retain remote posts when pruning the database.
54 * `user_bio_length`: A user bio maximum length (default: `5000`).
55 * `user_name_length`: A user name maximum length (default: `100`).
56 * `skip_thread_containment`: Skip filter out broken threads. The default is `false`.
57 * `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`.
58 * `max_account_fields`: The maximum number of custom fields in the user profile (default: `10`).
59 * `max_remote_account_fields`: The maximum number of custom fields in the remote user profile (default: `20`).
60 * `account_field_name_length`: An account field name maximum length (default: `512`).
61 * `account_field_value_length`: An account field value maximum length (default: `2048`).
62 * `registration_reason_length`: Maximum registration reason length (default: `500`).
63 * `external_user_synchronization`: Enabling following/followers counters synchronization for external users.
64 * `cleanup_attachments`: Remove attachments along with statuses. Does not affect duplicate files and attachments without status. Enabling this will increase load to database when deleting statuses on larger instances.
65 * `show_reactions`: Let favourites and emoji reactions be viewed through the API (default: `true`).
66 * `password_reset_token_validity`: The time after which reset tokens aren't accepted anymore, in seconds (default: one day).
67
68 ## :database
69 * `improved_hashtag_timeline`: Setting to force toggle / force disable improved hashtags timeline. `:enabled` forces hashtags to be fetched from `hashtags` table for hashtags timeline. `:disabled` forces object-embedded hashtags to be used (slower). Keep it `:auto` for automatic behaviour (it is auto-set to `:enabled` [unless overridden] when HashtagsTableMigrator completes).
70
71 ## Background migrations
72 * `populate_hashtags_table/sleep_interval_ms`: Sleep interval between each chunk of processed records in order to decrease the load on the system (defaults to 0 and should be keep default on most instances).
73 * `populate_hashtags_table/fault_rate_allowance`: Max rate of failed objects to actually processed objects in order to enable the feature (any value from 0.0 which tolerates no errors to 1.0 which will enable the feature even if hashtags transfer failed for all records).
74
75 ## Welcome
76 * `direct_message`: - welcome message sent as a direct message.
77 * `enabled`: Enables the send a direct message to a newly registered user. Defaults to `false`.
78 * `sender_nickname`: The nickname of the local user that sends the welcome message.
79 * `message`: A message that will be send to a newly registered users as a direct message.
80 * `chat_message`: - welcome message sent as a chat message.
81 * `enabled`: Enables the send a chat message to a newly registered user. Defaults to `false`.
82 * `sender_nickname`: The nickname of the local user that sends the welcome message.
83 * `message`: A message that will be send to a newly registered users as a chat message.
84 * `email`: - welcome message sent as a email.
85 * `enabled`: Enables the send a welcome email to a newly registered user. Defaults to `false`.
86 * `sender`: The email address or tuple with `{nickname, email}` that will use as sender to the welcome email.
87 * `subject`: A subject of welcome email.
88 * `html`: A html that will be send to a newly registered users as a email.
89 * `text`: A text that will be send to a newly registered users as a email.
90
91 Example:
92
93 ```elixir
94 config :pleroma, :welcome,
95 direct_message: [
96 enabled: true,
97 sender_nickname: "lain",
98 message: "Hi! Welcome on board!"
99 ],
100 email: [
101 enabled: true,
102 sender: {"Pleroma App", "welcome@pleroma.app"},
103 subject: "Welcome to <%= instance_name %>",
104 html: "Welcome to <%= instance_name %>",
105 text: "Welcome to <%= instance_name %>"
106 ]
107 ```
108
109 ## Message rewrite facility
110
111 ### :mrf
112 * `policies`: Message Rewrite Policy, either one or a list. Here are the ones available by default:
113 * `Pleroma.Web.ActivityPub.MRF.NoOpPolicy`: Doesn’t modify activities (default).
114 * `Pleroma.Web.ActivityPub.MRF.DropPolicy`: Drops all activities. It generally doesn’t makes sense to use in production.
115 * `Pleroma.Web.ActivityPub.MRF.SimplePolicy`: Restrict the visibility of activities from certains instances (See [`:mrf_simple`](#mrf_simple)).
116 * `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).
117 * `Pleroma.Web.ActivityPub.MRF.SubchainPolicy`: Selectively runs other MRF policies when messages match (See [`:mrf_subchain`](#mrf_subchain)).
118 * `Pleroma.Web.ActivityPub.MRF.RejectNonPublic`: Drops posts with non-public visibility settings (See [`:mrf_rejectnonpublic`](#mrf_rejectnonpublic)).
119 * `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:.
120 * `Pleroma.Web.ActivityPub.MRF.AntiLinkSpamPolicy`: Rejects posts from likely spambots by rejecting posts from new users that contain links.
121 * `Pleroma.Web.ActivityPub.MRF.MediaProxyWarmingPolicy`: Crawls attachments using their MediaProxy URLs so that the MediaProxy cache is primed.
122 * `Pleroma.Web.ActivityPub.MRF.MentionPolicy`: Drops posts mentioning configurable users. (See [`:mrf_mention`](#mrf_mention)).
123 * `Pleroma.Web.ActivityPub.MRF.VocabularyPolicy`: Restricts activities to a configured set of vocabulary. (See [`:mrf_vocabulary`](#mrf_vocabulary)).
124 * `Pleroma.Web.ActivityPub.MRF.ObjectAgePolicy`: Rejects or delists posts based on their age when received. (See [`:mrf_object_age`](#mrf_object_age)).
125 * `Pleroma.Web.ActivityPub.MRF.ActivityExpirationPolicy`: Sets a default expiration on all posts made by users of the local instance. Requires `Pleroma.Workers.PurgeExpiredActivity` to be enabled for processing the scheduled delections.
126 * `Pleroma.Web.ActivityPub.MRF.ForceBotUnlistedPolicy`: Makes all bot posts to disappear from public timelines.
127 * `Pleroma.Web.ActivityPub.MRF.FollowBotPolicy`: Automatically follows newly discovered users from the specified bot account. Local accounts, locked accounts, and users with "#nobot" in their bio are respected and excluded from being followed.
128 * `transparency`: Make the content of your Message Rewrite Facility settings public (via nodeinfo).
129 * `transparency_exclusions`: Exclude specific instance names from MRF transparency. The use of the exclusions feature will be disclosed in nodeinfo as a boolean value.
130
131 ## Federation
132 ### MRF policies
133
134 !!! note
135 Configuring MRF policies is not enough for them to take effect. You have to enable them by specifying their module in `policies` under [:mrf](#mrf) section.
136
137 #### :mrf_simple
138 * `media_removal`: List of instances to remove media from.
139 * `media_nsfw`: List of instances to put media as NSFW(sensitive) from.
140 * `federated_timeline_removal`: List of instances to remove from Federated (aka The Whole Known Network) Timeline.
141 * `reject`: List of instances to reject any activities from.
142 * `accept`: List of instances to accept any activities from.
143 * `followers_only`: List of instances to decrease post visibility to only the followers, including for DM mentions.
144 * `report_removal`: List of instances to reject reports from.
145 * `avatar_removal`: List of instances to strip avatars from.
146 * `banner_removal`: List of instances to strip banners from.
147
148 #### :mrf_subchain
149 This policy processes messages through an alternate pipeline when a given message matches certain criteria.
150 All criteria are configured as a map of regular expressions to lists of policy modules.
151
152 * `match_actor`: Matches a series of regular expressions against the actor field.
153
154 Example:
155
156 ```elixir
157 config :pleroma, :mrf_subchain,
158 match_actor: %{
159 ~r/https:\/\/example.com/s => [Pleroma.Web.ActivityPub.MRF.DropPolicy]
160 }
161 ```
162
163 #### :mrf_rejectnonpublic
164 * `allow_followersonly`: whether to allow followers-only posts.
165 * `allow_direct`: whether to allow direct messages.
166
167 #### :mrf_hellthread
168 * `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.
169 * `reject_threshold`: Number of mentioned users after which the messaged gets rejected. Set to 0 to disable.
170
171 #### :mrf_keyword
172 * `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).
173 * `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).
174 * `replace`: A list of tuples containing `{pattern, replacement}`, `pattern` can be a string or a [regular expression](https://hexdocs.pm/elixir/Regex.html).
175
176 #### :mrf_mention
177 * `actors`: A list of actors, for which to drop any posts mentioning.
178
179 #### :mrf_vocabulary
180 * `accept`: A list of ActivityStreams terms to accept. If empty, all supported messages are accepted.
181 * `reject`: A list of ActivityStreams terms to reject. If empty, no messages are rejected.
182
183 #### :mrf_user_allowlist
184
185 The keys in this section are the domain names that the policy should apply to.
186 Each key should be assigned a list of users that should be allowed through by
187 their ActivityPub ID.
188
189 An example:
190
191 ```elixir
192 config :pleroma, :mrf_user_allowlist, %{
193 "example.org" => ["https://example.org/users/admin"]
194 }
195 ```
196
197 #### :mrf_object_age
198 * `threshold`: Required time offset (in seconds) compared to your server clock of an incoming post before actions are taken.
199 e.g., A value of 900 results in any post with a timestamp older than 15 minutes will be acted upon.
200 * `actions`: A list of actions to apply to the post:
201 * `:delist` removes the post from public timelines
202 * `:strip_followers` removes followers from the ActivityPub recipient list, ensuring they won't be delivered to home timelines
203 * `:reject` rejects the message entirely
204
205 #### :mrf_steal_emoji
206 * `hosts`: List of hosts to steal emojis from
207 * `rejected_shortcodes`: Regex-list of shortcodes to reject
208 * `size_limit`: File size limit (in bytes), checked before an emoji is saved to the disk
209
210 #### :mrf_activity_expiration
211
212 * `days`: Default global expiration time for all local Create activities (in days)
213
214 #### :mrf_hashtag
215
216 * `sensitive`: List of hashtags to mark activities as sensitive (default: `nsfw`)
217 * `federated_timeline_removal`: List of hashtags to remove activities from the federated timeline (aka TWNK)
218 * `reject`: List of hashtags to reject activities from
219
220 Notes:
221 - The hashtags in the configuration do not have a leading `#`.
222 - This MRF Policy is always enabled, if you want to disable it you have to set empty lists
223
224 #### :mrf_follow_bot
225
226 * `follower_nickname`: The name of the bot account to use for following newly discovered users. Using `followbot` or similar is strongly suggested.
227
228
229 ### :activitypub
230 * `unfollow_blocked`: Whether blocks result in people getting unfollowed
231 * `outgoing_blocks`: Whether to federate blocks to other instances
232 * `deny_follow_blocked`: Whether to disallow following an account that has blocked the user in question
233 * `sign_object_fetches`: Sign object fetches with HTTP signatures
234 * `authorized_fetch_mode`: Require HTTP signatures for AP fetches
235
236 ## Pleroma.User
237
238 * `restricted_nicknames`: List of nicknames users may not register with.
239 * `email_blacklist`: List of email domains users may not register with.
240
241 ## Pleroma.ScheduledActivity
242
243 * `daily_user_limit`: the number of scheduled activities a user is allowed to create in a single day (Default: `25`)
244 * `total_user_limit`: the number of scheduled activities a user is allowed to create in total (Default: `300`)
245 * `enabled`: whether scheduled activities are sent to the job queue to be executed
246
247 ### :frontend_configurations
248
249 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. You can find the documentation for `pleroma_fe` configuration into [Pleroma-FE configuration and customization for instance administrators](/frontend/CONFIGURATION/#options).
250
251 Frontends can access these settings at `/api/v1/pleroma/frontend_configurations`
252
253 To add your own configuration for PleromaFE, use it like this:
254
255 ```elixir
256 config :pleroma, :frontend_configurations,
257 pleroma_fe: %{
258 theme: "pleroma-dark",
259 # ... see /priv/static/static/config.json for the available keys.
260 },
261 masto_fe: %{
262 showInstanceSpecificPanel: true
263 }
264 ```
265
266 These settings **need to be complete**, they will override the defaults.
267
268 ### :static_fe
269
270 Render profiles and posts using server-generated HTML that is viewable without using JavaScript.
271
272 Available options:
273
274 * `enabled` - Enables the rendering of static HTML. Defaults to `false`.
275
276 ### :assets
277
278 This section configures assets to be used with various frontends. Currently the only option
279 relates to mascots on the mastodon frontend
280
281 * `mascots`: KeywordList of mascots, each element __MUST__ contain both a `url` and a
282 `mime_type` key.
283 * `default_mascot`: An element from `mascots` - This will be used as the default mascot
284 on MastoFE (default: `:pleroma_fox_tan`).
285
286 ### :manifest
287
288 This section describe PWA manifest instance-specific values. Currently this option relate only for MastoFE.
289
290 * `icons`: Describe the icons of the app, this a list of maps describing icons in the same way as the
291 [spec](https://www.w3.org/TR/appmanifest/#imageresource-and-its-members) describes it.
292
293 Example:
294
295 ```elixir
296 config :pleroma, :manifest,
297 icons: [
298 %{
299 src: "/static/logo.png"
300 },
301 %{
302 src: "/static/icon.png",
303 type: "image/png"
304 },
305 %{
306 src: "/static/icon.ico",
307 sizes: "72x72 96x96 128x128 256x256"
308 }
309 ]
310 ```
311
312 * `theme_color`: Describe the theme color of the app. (Example: `"#282c37"`, `"rebeccapurple"`).
313 * `background_color`: Describe the background color of the app. (Example: `"#191b22"`, `"aliceblue"`).
314
315 ## :emoji
316
317 * `shortcode_globs`: Location of custom emoji files. `*` can be used as a wildcard. Example `["/emoji/custom/**/*.png"]`
318 * `pack_extensions`: A list of file extensions for emojis, when no emoji.txt for a pack is present. Example `[".png", ".gif"]`
319 * `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"]]`
320 * `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).
321 * `shared_pack_cache_seconds_per_file`: When an emoji pack is shared, the archive is created and cached in
322 memory for this amount of seconds multiplied by the number of files.
323
324 ## :media_proxy
325
326 * `enabled`: Enables proxying of remote media to the instance’s proxy
327 * `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.
328 * `proxy_opts`: All options defined in `Pleroma.ReverseProxy` documentation, defaults to `[max_body_length: (25*1_048_576)]`.
329 * `whitelist`: List of hosts with scheme to bypass the mediaproxy (e.g. `https://example.com`)
330 * `invalidation`: options for remove media from cache after delete object:
331 * `enabled`: Enables purge cache
332 * `provider`: Which one of the [purge cache strategy](#purge-cache-strategy) to use.
333
334 ## :media_preview_proxy
335
336 * `enabled`: Enables proxying of remote media preview to the instance’s proxy. Requires enabled media proxy (`media_proxy/enabled`).
337 * `thumbnail_max_width`: Max width of preview thumbnail for images (video preview always has original dimensions).
338 * `thumbnail_max_height`: Max height of preview thumbnail for images (video preview always has original dimensions).
339 * `image_quality`: Quality of the output. Ranges from 0 (min quality) to 100 (max quality).
340 * `min_content_length`: Min content length to perform preview, in bytes. If greater than 0, media smaller in size will be served as is, without thumbnailing.
341
342 ### Purge cache strategy
343
344 #### Pleroma.Web.MediaProxy.Invalidation.Script
345
346 This strategy allow perform external shell script to purge cache.
347 Urls of attachments are passed to the script as arguments.
348
349 * `script_path`: Path to the external script.
350 * `url_format`: Set to `:htcacheclean` if using Apache's htcacheclean utility.
351
352 Example:
353
354 ```elixir
355 config :pleroma, Pleroma.Web.MediaProxy.Invalidation.Script,
356 script_path: "./installation/nginx-cache-purge.example"
357 ```
358
359 #### Pleroma.Web.MediaProxy.Invalidation.Http
360
361 This strategy allow perform custom http request to purge cache.
362
363 * `method`: http method. default is `purge`
364 * `headers`: http headers.
365 * `options`: request options.
366
367 Example:
368 ```elixir
369 config :pleroma, Pleroma.Web.MediaProxy.Invalidation.Http,
370 method: :purge,
371 headers: [],
372 options: []
373 ```
374
375 ## Link previews
376
377 ### Pleroma.Web.Metadata (provider)
378 * `providers`: a list of metadata providers to enable. Providers available:
379 * `Pleroma.Web.Metadata.Providers.OpenGraph`
380 * `Pleroma.Web.Metadata.Providers.TwitterCard`
381 * `unfurl_nsfw`: If set to `true` nsfw attachments will be shown in previews.
382
383 ### :rich_media (consumer)
384 * `enabled`: if enabled the instance will parse metadata from attached links to generate link previews.
385 * `ignore_hosts`: list of hosts which will be ignored by the metadata parser. For example `["accounts.google.com", "xss.website"]`, defaults to `[]`.
386 * `ignore_tld`: list TLDs (top-level domains) which will ignore for parse metadata. default is ["local", "localdomain", "lan"].
387 * `parsers`: list of Rich Media parsers.
388 * `failure_backoff`: Amount of milliseconds after request failure, during which the request will not be retried.
389
390 ## HTTP server
391
392 ### Pleroma.Web.Endpoint
393
394 !!! note
395 `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.
396
397 * `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).
398 - `ip` - a tuple consisting of 4 integers
399 - `port`
400 * `url` - a list containing the configuration for generating urls, accepts
401 - `host` - the host without the scheme and a post (e.g `example.com`, not `https://example.com:2020`)
402 - `scheme` - e.g `http`, `https`
403 - `port`
404 - `path`
405 * `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.
406
407 Example:
408 ```elixir
409 config :pleroma, Pleroma.Web.Endpoint,
410 url: [host: "example.com", port: 2020, scheme: "https"],
411 http: [
412 port: 8080,
413 ip: {127, 0, 0, 1}
414 ]
415 ```
416
417 This will make Pleroma listen on `127.0.0.1` port `8080` and generate urls starting with `https://example.com:2020`
418
419 ### :http_security
420 * ``enabled``: Whether the managed content security policy is enabled.
421 * ``sts``: Whether to additionally send a `Strict-Transport-Security` header.
422 * ``sts_max_age``: The maximum age for the `Strict-Transport-Security` header if sent.
423 * ``ct_max_age``: The maximum age for the `Expect-CT` header if sent.
424 * ``referrer_policy``: The referrer policy to use, either `"same-origin"` or `"no-referrer"`.
425 * ``report_uri``: Adds the specified url to `report-uri` and `report-to` group in CSP header.
426
427 ### Pleroma.Web.Plugs.RemoteIp
428
429 !!! warning
430 If your instance is not behind at least one reverse proxy, you should not enable this plug.
431
432 `Pleroma.Web.Plugs.RemoteIp` is a shim to call [`RemoteIp`](https://git.pleroma.social/pleroma/remote_ip) but with runtime configuration.
433
434 Available options:
435
436 * `enabled` - Enable/disable the plug. Defaults to `false`.
437 * `headers` - A list of strings naming the HTTP headers to use when deriving the true client IP address. Defaults to `["x-forwarded-for"]`.
438 * `proxies` - A list of upstream proxy IP subnets in CIDR notation from which we will parse the content of `headers`. Defaults to `[]`. IPv4 entries without a bitmask will be assumed to be /32 and IPv6 /128.
439 * `reserved` - A list of reserved IP subnets in CIDR notation which should be ignored if found in `headers`. Defaults to `["127.0.0.0/8", "::1/128", "fc00::/7", "10.0.0.0/8", "172.16.0.0/12", "192.168.0.0/16"]`.
440
441
442 ### :rate_limit
443
444 !!! note
445 If your instance is behind a reverse proxy ensure [`Pleroma.Web.Plugs.RemoteIp`](#pleroma-plugs-remoteip) is enabled (it is enabled by default).
446
447 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:
448
449 * The first element: `scale` (Integer). The time scale in milliseconds.
450 * The second element: `limit` (Integer). How many requests to limit in the time scale provided.
451
452 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.
453
454 For example:
455
456 ```elixir
457 config :pleroma, :rate_limit,
458 authentication: {60_000, 15},
459 search: [{1000, 10}, {1000, 30}]
460 ```
461
462 Means that:
463
464 1. In 60 seconds, 15 authentication attempts can be performed from the same IP address.
465 2. In 1 second, 10 search requests can be performed from the same IP adress by unauthenticated users, while authenticated users can perform 30 search requests per second.
466
467 Supported rate limiters:
468
469 * `:search` - Account/Status search.
470 * `:timeline` - Timeline requests (each timeline has it's own limiter).
471 * `:app_account_creation` - Account registration from the API.
472 * `:relations_actions` - Following/Unfollowing in general.
473 * `:relation_id_action` - Following/Unfollowing for a specific user.
474 * `:statuses_actions` - Status actions such as: (un)repeating, (un)favouriting, creating, deleting.
475 * `:status_id_action` - (un)Repeating/(un)Favouriting a particular status.
476 * `:authentication` - Authentication actions, i.e getting an OAuth token.
477 * `:password_reset` - Requesting password reset emails.
478 * `:account_confirmation_resend` - Requesting resending account confirmation emails.
479 * `:ap_routes` - Requesting statuses via ActivityPub.
480
481 ### :web_cache_ttl
482
483 The expiration time for the web responses cache. Values should be in milliseconds or `nil` to disable expiration.
484
485 Available caches:
486
487 * `:activity_pub` - activity pub routes (except question activities). Defaults to `nil` (no expiration).
488 * `:activity_pub_question` - activity pub routes (question activities). Defaults to `30_000` (30 seconds).
489
490 ## HTTP client
491
492 ### :http
493
494 * `proxy_url`: an upstream proxy to fetch posts and/or media with, (default: `nil`)
495 * `send_user_agent`: should we include a user agent with HTTP requests? (default: `true`)
496 * `user_agent`: what user agent should we use? (default: `:default`), must be string or `:default`
497 * `adapter`: array of adapter options
498
499 ### :hackney_pools
500
501 Advanced. Tweaks Hackney (http client) connections pools.
502
503 There's three pools used:
504
505 * `:federation` for the federation jobs.
506 You may want this pool max_connections to be at least equal to the number of federator jobs + retry queue jobs.
507 * `:media` for rich media, media proxy
508 * `:upload` for uploaded media (if using a remote uploader and `proxy_remote: true`)
509
510 For each pool, the options are:
511
512 * `max_connections` - how much connections a pool can hold
513 * `timeout` - retention duration for connections
514
515
516 ### :connections_pool
517
518 *For `gun` adapter*
519
520 Settings for HTTP connection pool.
521
522 * `:connection_acquisition_wait` - Timeout to acquire a connection from pool.The total max time is this value multiplied by the number of retries.
523 * `connection_acquisition_retries` - Number of attempts to acquire the connection from the pool if it is overloaded. Each attempt is timed `:connection_acquisition_wait` apart.
524 * `:max_connections` - Maximum number of connections in the pool.
525 * `:connect_timeout` - Timeout to connect to the host.
526 * `:reclaim_multiplier` - Multiplied by `:max_connections` this will be the maximum number of idle connections that will be reclaimed in case the pool is overloaded.
527
528 ### :pools
529
530 *For `gun` adapter*
531
532 Settings for request pools. These pools are limited on top of `:connections_pool`.
533
534 There are four pools used:
535
536 * `:federation` for the federation jobs. You may want this pool's max_connections to be at least equal to the number of federator jobs + retry queue jobs.
537 * `:media` - for rich media, media proxy.
538 * `:upload` - for proxying media when a remote uploader is used and `proxy_remote: true`.
539 * `:default` - for other requests.
540
541 For each pool, the options are:
542
543 * `:size` - limit to how much requests can be concurrently executed.
544 * `:recv_timeout` - timeout while `gun` will wait for response
545 * `:max_waiting` - limit to how much requests can be waiting for others to finish, after this is reached, subsequent requests will be dropped.
546
547 ## Captcha
548
549 ### Pleroma.Captcha
550
551 * `enabled`: Whether the captcha should be shown on registration.
552 * `method`: The method/service to use for captcha.
553 * `seconds_valid`: The time in seconds for which the captcha is valid.
554
555 ### Captcha providers
556
557 #### Pleroma.Captcha.Native
558
559 A built-in captcha provider. Enabled by default.
560
561 #### Pleroma.Captcha.Kocaptcha
562
563 Kocaptcha is a very simple captcha service with a single API endpoint,
564 the source code is here: [kocaptcha](https://github.com/koto-bank/kocaptcha). The default endpoint
565 `https://captcha.kotobank.ch` is hosted by the developer.
566
567 * `endpoint`: the Kocaptcha endpoint to use.
568
569 ## Uploads
570
571 ### Pleroma.Upload
572
573 * `uploader`: Which one of the [uploaders](#uploaders) to use.
574 * `filters`: List of [upload filters](#upload-filters) to use.
575 * `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`
576 * `base_url`: The base URL to access a user-uploaded file. Useful when you want to host the media files via another domain or are using a 3rd party S3 provider.
577 * `proxy_remote`: If you're using a remote uploader, Pleroma will proxy media requests instead of redirecting to it.
578 * `proxy_opts`: Proxy options, see `Pleroma.ReverseProxy` documentation.
579 * `filename_display_max_length`: Set max length of a filename to display. 0 = no limit. Default: 30.
580 * `default_description`: Sets which default description an image has if none is set explicitly. Options: nil (default) - Don't set a default, :filename - use the filename of the file, a string (e.g. "attachment") - Use this string
581
582 !!! warning
583 `strip_exif` has been replaced by `Pleroma.Upload.Filter.Mogrify`.
584
585 ### Uploaders
586
587 #### Pleroma.Uploaders.Local
588
589 * `uploads`: Which directory to store the user-uploads in, relative to pleroma’s working directory.
590
591 #### Pleroma.Uploaders.S3
592
593 Don't forget to configure [Ex AWS S3](#ex-aws-s3-settings)
594
595 * `bucket`: S3 bucket name.
596 * `bucket_namespace`: S3 bucket namespace.
597 * `truncated_namespace`: If you use S3 compatible service such as Digital Ocean Spaces or CDN, set folder name or "" etc.
598 * `streaming_enabled`: Enable streaming uploads, when enabled the file will be sent to the server in chunks as it's being read. This may be unsupported by some providers, try disabling this if you have upload problems.
599
600 #### Ex AWS S3 settings
601
602 * `access_key_id`: Access key ID
603 * `secret_access_key`: Secret access key
604 * `host`: S3 host
605
606 Example:
607
608 ```elixir
609 config :ex_aws, :s3,
610 access_key_id: "xxxxxxxxxx",
611 secret_access_key: "yyyyyyyyyy",
612 host: "s3.eu-central-1.amazonaws.com"
613 ```
614
615 ### Upload filters
616
617 #### Pleroma.Upload.Filter.AnonymizeFilename
618
619 This filter replaces the filename (not the path) of an upload. For complete obfuscation, add
620 `Pleroma.Upload.Filter.Dedupe` before AnonymizeFilename.
621
622 * `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}`.
623
624 #### Pleroma.Upload.Filter.Dedupe
625
626 No specific configuration.
627
628 #### Pleroma.Upload.Filter.Exiftool
629
630 This filter only strips the GPS and location metadata with Exiftool leaving color profiles and attributes intact.
631
632 No specific configuration.
633
634 #### Pleroma.Upload.Filter.Mogrify
635
636 * `args`: List of actions for the `mogrify` command like `"strip"` or `["strip", "auto-orient", {"implode", "1"}]`.
637
638 ## Email
639
640 ### Pleroma.Emails.Mailer
641 * `adapter`: one of the mail adapters listed in [Swoosh readme](https://github.com/swoosh/swoosh#adapters), or `Swoosh.Adapters.Local` for in-memory mailbox.
642 * `api_key` / `password` and / or other adapter-specific settings, per the above documentation.
643 * `enabled`: Allows enable/disable send emails. Default: `false`.
644
645 An example for Sendgrid adapter:
646
647 ```elixir
648 config :pleroma, Pleroma.Emails.Mailer,
649 enabled: true,
650 adapter: Swoosh.Adapters.Sendgrid,
651 api_key: "YOUR_API_KEY"
652 ```
653
654 An example for SMTP adapter:
655
656 ```elixir
657 config :pleroma, Pleroma.Emails.Mailer,
658 enabled: true,
659 adapter: Swoosh.Adapters.SMTP,
660 relay: "smtp.gmail.com",
661 username: "YOUR_USERNAME@gmail.com",
662 password: "YOUR_SMTP_PASSWORD",
663 port: 465,
664 ssl: true,
665 auth: :always
666 ```
667
668 ### :email_notifications
669
670 Email notifications settings.
671
672 - digest - emails of "what you've missed" for users who have been
673 inactive for a while.
674 - active: globally enable or disable digest emails
675 - schedule: When to send digest email, in [crontab format](https://en.wikipedia.org/wiki/Cron).
676 "0 0 * * 0" is the default, meaning "once a week at midnight on Sunday morning"
677 - interval: Minimum interval between digest emails to one user
678 - inactivity_threshold: Minimum user inactivity threshold
679
680 ### Pleroma.Emails.UserEmail
681
682 - `:logo` - a path to a custom logo. Set it to `nil` to use the default Pleroma logo.
683 - `:styling` - a map with color settings for email templates.
684
685 ### Pleroma.Emails.NewUsersDigestEmail
686
687 - `:enabled` - a boolean, enables new users admin digest email when `true`. Defaults to `false`.
688
689 ## Background jobs
690
691 ### Oban
692
693 [Oban](https://github.com/sorentwo/oban) asynchronous job processor configuration.
694
695 Configuration options described in [Oban readme](https://github.com/sorentwo/oban#usage):
696
697 * `repo` - app's Ecto repo (`Pleroma.Repo`)
698 * `log` - logs verbosity
699 * `queues` - job queues (see below)
700 * `crontab` - periodic jobs, see [`Oban.Cron`](#obancron)
701
702 Pleroma has the following queues:
703
704 * `activity_expiration` - Activity expiration
705 * `federator_outgoing` - Outgoing federation
706 * `federator_incoming` - Incoming federation
707 * `mailer` - Email sender, see [`Pleroma.Emails.Mailer`](#pleromaemailsmailer)
708 * `transmogrifier` - Transmogrifier
709 * `web_push` - Web push notifications
710 * `scheduled_activities` - Scheduled activities, see [`Pleroma.ScheduledActivity`](#pleromascheduledactivity)
711
712 #### Oban.Cron
713
714 Pleroma has these periodic job workers:
715
716 * `Pleroma.Workers.Cron.DigestEmailsWorker` - digest emails for users with new mentions and follows
717 * `Pleroma.Workers.Cron.NewUsersDigestWorker` - digest emails for admins with new registrations
718
719 ```elixir
720 config :pleroma, Oban,
721 repo: Pleroma.Repo,
722 verbose: false,
723 prune: {:maxlen, 1500},
724 queues: [
725 federator_incoming: 50,
726 federator_outgoing: 50
727 ],
728 crontab: [
729 {"0 0 * * 0", Pleroma.Workers.Cron.DigestEmailsWorker},
730 {"0 0 * * *", Pleroma.Workers.Cron.NewUsersDigestWorker}
731 ]
732 ```
733
734 This config contains two queues: `federator_incoming` and `federator_outgoing`. Both have the number of max concurrent jobs set to `50`.
735
736 #### Migrating `pleroma_job_queue` settings
737
738 `config :pleroma_job_queue, :queues` is replaced by `config :pleroma, Oban, :queues` and uses the same format (keys are queues' names, values are max concurrent jobs numbers).
739
740 ### :workers
741
742 Includes custom worker options not interpretable directly by `Oban`.
743
744 * `retries` — keyword lists where keys are `Oban` queues (see above) and values are numbers of max attempts for failed jobs.
745
746 Example:
747
748 ```elixir
749 config :pleroma, :workers,
750 retries: [
751 federator_incoming: 5,
752 federator_outgoing: 5
753 ]
754 ```
755
756 #### Migrating `Pleroma.Web.Federator.RetryQueue` settings
757
758 * `max_retries` is replaced with `config :pleroma, :workers, retries: [federator_outgoing: 5]`
759 * `enabled: false` corresponds to `config :pleroma, :workers, retries: [federator_outgoing: 1]`
760 * deprecated options: `max_jobs`, `initial_timeout`
761
762 ## :web_push_encryption, :vapid_details
763
764 Web Push Notifications configuration. You can use the mix task `mix web_push.gen.keypair` to generate it.
765
766 * ``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.
767 * ``public_key``: VAPID public key
768 * ``private_key``: VAPID private key
769
770 ## :logger
771 * `backends`: `:console` is used to send logs to stdout, `{ExSyslogger, :ex_syslogger}` to log to syslog, and `Quack.Logger` to log to Slack
772
773 An example to enable ONLY ExSyslogger (f/ex in ``prod.secret.exs``) with info and debug suppressed:
774 ```elixir
775 config :logger,
776 backends: [{ExSyslogger, :ex_syslogger}]
777
778 config :logger, :ex_syslogger,
779 level: :warn
780 ```
781
782 Another example, keeping console output and adding the pid to syslog output:
783 ```elixir
784 config :logger,
785 backends: [:console, {ExSyslogger, :ex_syslogger}]
786
787 config :logger, :ex_syslogger,
788 level: :warn,
789 option: [:pid, :ndelay]
790 ```
791
792 See: [logger’s documentation](https://hexdocs.pm/logger/Logger.html) and [ex_syslogger’s documentation](https://hexdocs.pm/ex_syslogger/)
793
794 An example of logging info to local syslog, but warn to a Slack channel:
795 ```elixir
796 config :logger,
797 backends: [ {ExSyslogger, :ex_syslogger}, Quack.Logger ],
798 level: :info
799
800 config :logger, :ex_syslogger,
801 level: :info,
802 ident: "pleroma",
803 format: "$metadata[$level] $message"
804
805 config :quack,
806 level: :warn,
807 meta: [:all],
808 webhook_url: "https://hooks.slack.com/services/YOUR-API-KEY-HERE"
809 ```
810
811 See the [Quack Github](https://github.com/azohra/quack) for more details
812
813
814
815 ## Database options
816
817 ### RUM indexing for full text search
818
819 !!! warning
820 It is recommended to use PostgreSQL v11 or newer. We have seen some minor issues with lower PostgreSQL versions.
821
822 * `rum_enabled`: If RUM indexes should be used. Defaults to `false`.
823
824 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.
825
826 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.
827
828 To enable them, both the `rum_enabled` flag has to be set and the following special migration has to be run:
829
830 `mix ecto.migrate --migrations-path priv/repo/optional_migrations/rum_indexing/`
831
832 This will probably take a long time.
833
834 ## Alternative client protocols
835
836 ### BBS / SSH access
837
838 To enable simple command line interface accessible over ssh, add a setting like this to your configuration file:
839
840 ```exs
841 app_dir = File.cwd!
842 priv_dir = Path.join([app_dir, "priv/ssh_keys"])
843
844 config :esshd,
845 enabled: true,
846 priv_dir: priv_dir,
847 handler: "Pleroma.BBS.Handler",
848 port: 10_022,
849 password_authenticator: "Pleroma.BBS.Authenticator"
850 ```
851
852 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`
853
854 ### :gopher
855 * `enabled`: Enables the gopher interface
856 * `ip`: IP address to bind to
857 * `port`: Port to bind to
858 * `dstport`: Port advertised in urls (optional, defaults to `port`)
859
860
861 ## Authentication
862
863 ### :admin_token
864
865 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 or `x-admin-token` HTTP header. Example:
866
867 ```elixir
868 config :pleroma, :admin_token, "somerandomtoken"
869 ```
870
871 You can then do
872
873 ```shell
874 curl "http://localhost:4000/api/v1/pleroma/admin/users/invites?admin_token=somerandomtoken"
875 ```
876
877 or
878
879 ```shell
880 curl -H "X-Admin-Token: somerandomtoken" "http://localhost:4000/api/v1/pleroma/admin/users/invites"
881 ```
882
883 Warning: it's discouraged to use this feature because of the associated security risk: static / rarely changed instance-wide token is much weaker compared to email-password pair of a real admin user; consider using HTTP Basic Auth or OAuth-based authentication instead.
884
885 ### :auth
886
887 Authentication / authorization settings.
888
889 * `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`.
890 * `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`.
891 * `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>`).
892
893 ### Pleroma.Web.Auth.Authenticator
894
895 * `Pleroma.Web.Auth.PleromaAuthenticator`: default database authenticator.
896 * `Pleroma.Web.Auth.LDAPAuthenticator`: LDAP authentication.
897
898 ### :ldap
899
900 Use LDAP for user authentication. When a user logs in to the Pleroma
901 instance, the name and password will be verified by trying to authenticate
902 (bind) to an LDAP server. If a user exists in the LDAP directory but there
903 is no account with the same name yet on the Pleroma instance then a new
904 Pleroma account will be created with the same name as the LDAP user name.
905
906 * `enabled`: enables LDAP authentication
907 * `host`: LDAP server hostname
908 * `port`: LDAP port, e.g. 389 or 636
909 * `ssl`: true to use SSL, usually implies the port 636
910 * `sslopts`: additional SSL options
911 * `tls`: true to start TLS, usually implies the port 389
912 * `tlsopts`: additional TLS options
913 * `base`: LDAP base, e.g. "dc=example,dc=com"
914 * `uid`: LDAP attribute name to authenticate the user, e.g. when "cn", the filter will be "cn=username,base"
915
916 Note, if your LDAP server is an Active Directory server the correct value is commonly `uid: "cn"`, but if you use an
917 OpenLDAP server the value may be `uid: "uid"`.
918
919 ### :oauth2 (Pleroma as OAuth 2.0 provider settings)
920
921 OAuth 2.0 provider settings:
922
923 * `token_expires_in` - The lifetime in seconds of the access token.
924 * `issue_new_refresh_token` - Keeps old refresh token or generate new refresh token when to obtain an access token.
925 * `clean_expired_tokens` - Enable a background job to clean expired oauth tokens. Defaults to `false`.
926
927 OAuth 2.0 provider and related endpoints:
928
929 * `POST /api/v1/apps` creates client app basing on provided params.
930 * `GET/POST /oauth/authorize` renders/submits authorization form.
931 * `POST /oauth/token` creates/renews OAuth token.
932 * `POST /oauth/revoke` revokes provided OAuth token.
933 * `GET /api/v1/accounts/verify_credentials` (with proper `Authorization` header or `access_token` URI param) returns user info on requester (with `acct` field containing local nickname and `fqn` field containing fully-qualified nickname which could generally be used as email stub for OAuth software that demands email field in identity endpoint response, like Peertube).
934
935 ### OAuth consumer mode
936
937 OAuth consumer mode allows sign in / sign up via external OAuth providers (e.g. Twitter, Facebook, Google, Microsoft, etc.).
938 Implementation is based on Ueberauth; see the list of [available strategies](https://github.com/ueberauth/ueberauth/wiki/List-of-Strategies).
939
940 !!! note
941 Each strategy is shipped as a separate dependency; in order to get the strategies, run `OAUTH_CONSUMER_STRATEGIES="..." mix deps.get`, e.g. `OAUTH_CONSUMER_STRATEGIES="twitter facebook google microsoft" mix deps.get`. The server should also be started with `OAUTH_CONSUMER_STRATEGIES="..." mix phx.server` in case you enable any strategies.
942
943 !!! note
944 Each strategy requires separate setup (on external provider side and Pleroma side). Below are the guidelines on setting up most popular strategies.
945
946 !!! note
947 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"`
948
949 * For Twitter, [register an app](https://developer.twitter.com/en/apps), configure callback URL to https://<your_host>/oauth/twitter/callback
950
951 * 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/
952
953 * For Google, [register an app](https://console.developers.google.com), configure callback URL to https://<your_host>/oauth/google/callback
954
955 * For Microsoft, [register an app](https://portal.azure.com), configure callback URL to https://<your_host>/oauth/microsoft/callback
956
957 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`,
958 per strategy's documentation (e.g. [ueberauth_twitter](https://github.com/ueberauth/ueberauth_twitter)). Example config basing on environment variables:
959
960 ```elixir
961 # Twitter
962 config :ueberauth, Ueberauth.Strategy.Twitter.OAuth,
963 consumer_key: System.get_env("TWITTER_CONSUMER_KEY"),
964 consumer_secret: System.get_env("TWITTER_CONSUMER_SECRET")
965
966 # Facebook
967 config :ueberauth, Ueberauth.Strategy.Facebook.OAuth,
968 client_id: System.get_env("FACEBOOK_APP_ID"),
969 client_secret: System.get_env("FACEBOOK_APP_SECRET"),
970 redirect_uri: System.get_env("FACEBOOK_REDIRECT_URI")
971
972 # Google
973 config :ueberauth, Ueberauth.Strategy.Google.OAuth,
974 client_id: System.get_env("GOOGLE_CLIENT_ID"),
975 client_secret: System.get_env("GOOGLE_CLIENT_SECRET"),
976 redirect_uri: System.get_env("GOOGLE_REDIRECT_URI")
977
978 # Microsoft
979 config :ueberauth, Ueberauth.Strategy.Microsoft.OAuth,
980 client_id: System.get_env("MICROSOFT_CLIENT_ID"),
981 client_secret: System.get_env("MICROSOFT_CLIENT_SECRET")
982
983 config :ueberauth, Ueberauth,
984 providers: [
985 microsoft: {Ueberauth.Strategy.Microsoft, [callback_params: []]}
986 ]
987
988 # Keycloak
989 # Note: make sure to add `keycloak:ueberauth_keycloak_strategy` entry to `OAUTH_CONSUMER_STRATEGIES` environment variable
990 keycloak_url = "https://publicly-reachable-keycloak-instance.org:8080"
991
992 config :ueberauth, Ueberauth.Strategy.Keycloak.OAuth,
993 client_id: System.get_env("KEYCLOAK_CLIENT_ID"),
994 client_secret: System.get_env("KEYCLOAK_CLIENT_SECRET"),
995 site: keycloak_url,
996 authorize_url: "#{keycloak_url}/auth/realms/master/protocol/openid-connect/auth",
997 token_url: "#{keycloak_url}/auth/realms/master/protocol/openid-connect/token",
998 userinfo_url: "#{keycloak_url}/auth/realms/master/protocol/openid-connect/userinfo",
999 token_method: :post
1000
1001 config :ueberauth, Ueberauth,
1002 providers: [
1003 keycloak: {Ueberauth.Strategy.Keycloak, [uid_field: :email]}
1004 ]
1005 ```
1006
1007 ## Link parsing
1008
1009 ### :uri_schemes
1010 * `valid_schemes`: List of the scheme part that is considered valid to be an URL.
1011
1012 ### Pleroma.Formatter
1013
1014 Configuration for Pleroma's link formatter which parses mentions, hashtags, and URLs.
1015
1016 * `class` - specify the class to be added to the generated link (default: `false`)
1017 * `rel` - specify the rel attribute (default: `ugc`)
1018 * `new_window` - adds `target="_blank"` attribute (default: `false`)
1019 * `truncate` - Set to a number to truncate URLs longer then the number. Truncated URLs will end in `...` (default: `false`)
1020 * `strip_prefix` - Strip the scheme prefix (default: `false`)
1021 * `extra` - link URLs with rarely used schemes (magnet, ipfs, irc, etc.) (default: `true`)
1022 * `validate_tld` - Set to false to disable TLD validation for URLs/emails. Can be set to :no_scheme to validate TLDs only for urls without a scheme (e.g `example.com` will be validated, but `http://example.loki` won't) (default: `:no_scheme`)
1023
1024 Example:
1025
1026 ```elixir
1027 config :pleroma, Pleroma.Formatter,
1028 class: false,
1029 rel: "ugc",
1030 new_window: false,
1031 truncate: false,
1032 strip_prefix: false,
1033 extra: true,
1034 validate_tld: :no_scheme
1035 ```
1036
1037 ## Custom Runtime Modules (`:modules`)
1038
1039 * `runtime_dir`: A path to custom Elixir modules (such as MRF policies).
1040
1041 ## :configurable_from_database
1042
1043 Boolean, enables/disables in-database configuration. Read [Transfering the config to/from the database](../administration/CLI_tasks/config.md) for more information.
1044
1045 ## :database_config_whitelist
1046
1047 List of valid configuration sections which are allowed to be configured from the
1048 database. Settings stored in the database before the whitelist is configured are
1049 still applied, so it is suggested to only use the whitelist on instances that
1050 have not migrated the config to the database.
1051
1052 Example:
1053 ```elixir
1054 config :pleroma, :database_config_whitelist, [
1055 {:pleroma, :instance},
1056 {:pleroma, Pleroma.Web.Metadata},
1057 {:auto_linker}
1058 ]
1059 ```
1060
1061 ### Multi-factor authentication - :two_factor_authentication
1062 * `totp` - a list containing TOTP configuration
1063 - `digits` - Determines the length of a one-time pass-code in characters. Defaults to 6 characters.
1064 - `period` - a period for which the TOTP code will be valid in seconds. Defaults to 30 seconds.
1065 * `backup_codes` - a list containing backup codes configuration
1066 - `number` - number of backup codes to generate.
1067 - `length` - backup code length. Defaults to 16 characters.
1068
1069 ## Restrict entities access for unauthenticated users
1070
1071 ### :restrict_unauthenticated
1072
1073 Restrict access for unauthenticated users to timelines (public and federated), user profiles and statuses.
1074
1075 * `timelines`: public and federated timelines
1076 * `local`: public timeline
1077 * `federated`: federated timeline (includes public timeline)
1078 * `profiles`: user profiles
1079 * `local`
1080 * `remote`
1081 * `activities`: statuses
1082 * `local`
1083 * `remote`
1084
1085 Note: when `:instance, :public` is set to `false`, all `:restrict_unauthenticated` items be effectively set to `true` by default. If you'd like to allow unauthenticated access to specific API endpoints on a private instance, please explicitly set `:restrict_unauthenticated` to non-default value in `config/prod.secret.exs`.
1086
1087 Note: setting `restrict_unauthenticated/timelines/local` to `true` has no practical sense if `restrict_unauthenticated/timelines/federated` is set to `false` (since local public activities will still be delivered to unauthenticated users as part of federated timeline).
1088
1089 ## Pleroma.Web.ApiSpec.CastAndValidate
1090
1091 * `:strict` a boolean, enables strict input validation (useful in development, not recommended in production). Defaults to `false`.
1092
1093 ## :instances_favicons
1094
1095 Control favicons for instances.
1096
1097 * `enabled`: Allow/disallow displaying and getting instances favicons
1098
1099 ## Pleroma.User.Backup
1100
1101 !!! note
1102 Requires enabled email
1103
1104 * `:purge_after_days` an integer, remove backup achives after N days.
1105 * `:limit_days` an integer, limit user to export not more often than once per N days.
1106 * `:dir` a string with a path to backup temporary directory or `nil` to let Pleroma choose temporary directory in the following order:
1107 1. the directory named by the TMPDIR environment variable
1108 2. the directory named by the TEMP environment variable
1109 3. the directory named by the TMP environment variable
1110 4. C:\TMP on Windows or /tmp on Unix-like operating systems
1111 5. as a last resort, the current working directory
1112
1113 ## Frontend management
1114
1115 Frontends in Pleroma are swappable - you can specify which one to use here.
1116
1117 You can set a frontends for the key `primary` and `admin` and the options of `name` and `ref`. This will then make Pleroma serve the frontend from a folder constructed by concatenating the instance static path, `frontends` and the name and ref.
1118
1119 The key `primary` refers to the frontend that will be served by default for general requests. The key `admin` refers to the frontend that will be served at the `/pleroma/admin` path.
1120
1121 If you don't set anything here, the bundled frontends will be used.
1122
1123 Example:
1124
1125 ```
1126 config :pleroma, :frontends,
1127 primary: %{
1128 "name" => "pleroma",
1129 "ref" => "stable"
1130 },
1131 admin: %{
1132 "name" => "admin",
1133 "ref" => "develop"
1134 }
1135 ```
1136
1137 This would serve the frontend from the the folder at `$instance_static/frontends/pleroma/stable`. You have to copy the frontend into this folder yourself. You can choose the name and ref any way you like, but they will be used by mix tasks to automate installation in the future, the name referring to the project and the ref referring to a commit.
1138
1139 ## Ephemeral activities (Pleroma.Workers.PurgeExpiredActivity)
1140
1141 Settings to enable and configure expiration for ephemeral activities
1142
1143 * `:enabled` - enables ephemeral activities creation
1144 * `:min_lifetime` - minimum lifetime for ephemeral activities (in seconds). Default: 10 minutes.
1145
1146 ## ConcurrentLimiter
1147
1148 Settings to restrict concurrently running jobs. Jobs which can be configured:
1149
1150 * `Pleroma.Web.RichMedia.Helpers` - generating link previews of URLs in activities
1151 * `Pleroma.Web.ActivityPub.MRF.MediaProxyWarmingPolicy` - warming remote media cache via MediaProxyWarmingPolicy
1152
1153 Each job has these settings:
1154
1155 * `:max_running` - max concurrently runnings jobs
1156 * `:max_waiting` - max waiting jobs