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