1 # Configuration Cheat Sheet
3 This is a cheat sheet for Akkoma configuration file, any setting possible to configure should be listed here.
5 For OTP installations the configuration is typically stored in `/etc/akkoma/config.exs`.
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`.
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.
13 * `enabled` - Enables the backend Shoutbox chat feature. Defaults to `true`.
14 * `limit` - Shout character limit. Defaults to `5_000`
17 * `name`: The instance’s name.
18 * `email`: Email used to reach an Administrator/Moderator of the instance.
19 * `notify_email`: Email used for notifications.
20 * `description`: The instance’s description, can be seen in nodeinfo and ``/api/v1/instance``.
21 * `limit`: Posts character limit (CW/Subject included in the counter).
22 * `description_limit`: The character limit for image descriptions.
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`: Permits remote instances to subscribe to all public posts of your instance. This may increase the visibility of your 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`: 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).
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).
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).
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.
94 config :pleroma, :welcome,
97 sender_nickname: "lain",
98 message: "Hi! Welcome on board!"
102 sender: {"Akkoma App", "welcome@akkoma.app"},
103 subject: "Welcome to <%= instance_name %>",
104 html: "Welcome to <%= instance_name %>",
105 text: "Welcome to <%= instance_name %>"
109 ## Message rewrite facility
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 * `Pleroma.Web.ActivityPub.MRF.AntiFollowbotPolicy`: Drops follow requests from followbots. Users can still allow bots to follow them by first following the bot.
129 * `Pleroma.Web.ActivityPub.MRF.KeywordPolicy`: Rejects or removes from the federated timeline or replaces keywords. (See [`:mrf_keyword`](#mrf_keyword)).
130 * `transparency`: Make the content of your Message Rewrite Facility settings public (via nodeinfo).
131 * `transparency_exclusions`: Exclude specific instance names from MRF transparency. The use of the exclusions feature will be disclosed in nodeinfo as a boolean value.
137 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.
140 * `media_removal`: List of instances to strip media attachments from and the reason for doing so.
141 * `media_nsfw`: List of instances to tag all media as NSFW (sensitive) from and the reason for doing so.
142 * `federated_timeline_removal`: List of instances to remove from the Federated Timeline (aka The Whole Known Network) and the reason for doing so.
143 * `reject`: List of instances to reject activities (except deletes) from and the reason for doing so.
144 * `accept`: List of instances to only accept activities (except deletes) from and the reason for doing so.
145 * `followers_only`: Force posts from the given instances to be visible by followers only and the reason for doing so.
146 * `report_removal`: List of instances to reject reports from and the reason for doing so.
147 * `avatar_removal`: List of instances to strip avatars from and the reason for doing so.
148 * `banner_removal`: List of instances to strip banners from and the reason for doing so.
149 * `reject_deletes`: List of instances to reject deletions from and the reason for doing so.
152 This policy processes messages through an alternate pipeline when a given message matches certain criteria.
153 All criteria are configured as a map of regular expressions to lists of policy modules.
155 * `match_actor`: Matches a series of regular expressions against the actor field.
160 config :pleroma, :mrf_subchain,
162 ~r/https:\/\/example.com/s => [Pleroma.Web.ActivityPub.MRF.DropPolicy]
166 #### :mrf_rejectnonpublic
167 * `allow_followersonly`: whether to allow followers-only posts.
168 * `allow_direct`: whether to allow direct messages.
171 * `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.
172 * `reject_threshold`: Number of mentioned users after which the messaged gets rejected. Set to 0 to disable.
175 * `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).
176 * `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).
177 * `replace`: A list of tuples containing `{pattern, replacement}`, `pattern` can be a string or a [regular expression](https://hexdocs.pm/elixir/Regex.html).
180 * `actors`: A list of actors, for which to drop any posts mentioning.
183 * `accept`: A list of ActivityStreams terms to accept. If empty, all supported messages are accepted.
184 * `reject`: A list of ActivityStreams terms to reject. If empty, no messages are rejected.
186 #### :mrf_user_allowlist
188 The keys in this section are the domain names that the policy should apply to.
189 Each key should be assigned a list of users that should be allowed through by
190 their ActivityPub ID.
195 config :pleroma, :mrf_user_allowlist, %{
196 "example.org" => ["https://example.org/users/admin"]
201 * `threshold`: Required time offset (in seconds) compared to your server clock of an incoming post before actions are taken.
202 e.g., A value of 900 results in any post with a timestamp older than 15 minutes will be acted upon.
203 * `actions`: A list of actions to apply to the post:
204 * `:delist` removes the post from public timelines
205 * `:strip_followers` removes followers from the ActivityPub recipient list, ensuring they won't be delivered to home timelines
206 * `:reject` rejects the message entirely
208 #### :mrf_steal_emoji
209 * `hosts`: List of hosts to steal emojis from
210 * `rejected_shortcodes`: Regex-list of shortcodes to reject
211 * `size_limit`: File size limit (in bytes), checked before an emoji is saved to the disk
213 #### :mrf_activity_expiration
215 * `days`: Default global expiration time for all local Create activities (in days)
219 * `sensitive`: List of hashtags to mark activities as sensitive (default: `nsfw`)
220 * `federated_timeline_removal`: List of hashtags to remove activities from the federated timeline (aka TWNK)
221 * `reject`: List of hashtags to reject activities from
224 - The hashtags in the configuration do not have a leading `#`.
225 - This MRF Policy is always enabled, if you want to disable it you have to set empty lists
229 * `follower_nickname`: The name of the bot account to use for following newly discovered users. Using `followbot` or similar is strongly suggested.
233 * `unfollow_blocked`: Whether blocks result in people getting unfollowed
234 * `outgoing_blocks`: Whether to federate blocks to other instances
235 * `blockers_visible`: Whether a user can see the posts of users who blocked them
236 * `deny_follow_blocked`: Whether to disallow following an account that has blocked the user in question
237 * `sign_object_fetches`: Sign object fetches with HTTP signatures
238 * `authorized_fetch_mode`: Require HTTP signatures for AP fetches
239 * `max_collection_objects`: The maximum number of objects to fetch from a remote AP collection.
243 * `restricted_nicknames`: List of nicknames users may not register with.
244 * `email_blacklist`: List of email domains users may not register with.
246 ## Pleroma.ScheduledActivity
248 * `daily_user_limit`: the number of scheduled activities a user is allowed to create in a single day (Default: `25`)
249 * `total_user_limit`: the number of scheduled activities a user is allowed to create in total (Default: `300`)
250 * `enabled`: whether scheduled activities are sent to the job queue to be executed
252 ## Frontend Management
254 ### :frontend_configurations
256 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).
258 Frontends can access these settings at `/api/v1/pleroma/frontend_configurations`
260 To add your own configuration for Pleroma-FE, use it like this:
263 config :pleroma, :frontend_configurations,
265 theme: "pleroma-dark",
266 # ... see /priv/static/static/config.json for the available keys.
269 showInstanceSpecificPanel: true
273 These settings **need to be complete**, they will override the defaults.
277 These settings tell akkoma which frontend files to serve the user.
279 See: [Frontend Management](../frontend_management)
282 config :pleroma, :frontends,
284 "name" => "pleroma-fe",
288 "name" => "admin-fe",
292 "name" => "swagger-ui",
298 * `:primary` - The frontend that will be served at `/`
299 * `:admin` - The frontend that will be served at `/pleroma/admin`
300 * `:swagger` - Config for developers to act as an API reference to be served at `/akkoma/swaggerui/` (trailing slash _needed_). Disabled by default.
304 Render profiles and posts using server-generated HTML that is viewable without using JavaScript.
308 * `enabled` - Enables the rendering of static HTML. Defaults to `false`.
312 This section configures assets to be used with various frontends. Currently the only option
313 relates to mascots on the mastodon frontend
315 * `mascots`: KeywordList of mascots, each element __MUST__ contain both a `url` and a
317 * `default_mascot`: An element from `mascots` - This will be used as the default mascot
318 on MastoFE (default: `:pleroma_fox_tan`).
322 This section describe PWA manifest instance-specific values. Currently this option relate only for MastoFE.
324 * `icons`: Describe the icons of the app, this a list of maps describing icons in the same way as the
325 [spec](https://www.w3.org/TR/appmanifest/#imageresource-and-its-members) describes it.
330 config :pleroma, :manifest,
333 src: "/static/logo.png"
336 src: "/static/icon.png",
340 src: "/static/icon.ico",
341 sizes: "72x72 96x96 128x128 256x256"
346 * `theme_color`: Describe the theme color of the app. (Example: `"#282c37"`, `"rebeccapurple"`).
347 * `background_color`: Describe the background color of the app. (Example: `"#191b22"`, `"aliceblue"`).
351 * `shortcode_globs`: Location of custom emoji files. `*` can be used as a wildcard. Example `["/emoji/custom/**/*.png"]`
352 * `pack_extensions`: A list of file extensions for emojis, when no emoji.txt for a pack is present. Example `[".png", ".gif"]`
353 * `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"]]`
354 * `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).
355 * `shared_pack_cache_seconds_per_file`: When an emoji pack is shared, the archive is created and cached in
356 memory for this amount of seconds multiplied by the number of files.
360 * `enabled`: Enables proxying of remote media to the instance’s proxy
361 * `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.
362 * `proxy_opts`: All options defined in `Pleroma.ReverseProxy` documentation, defaults to `[max_body_length: (25*1_048_576)]`.
363 * `whitelist`: List of hosts with scheme to bypass the mediaproxy (e.g. `https://example.com`)
364 * `invalidation`: options for remove media from cache after delete object:
365 * `enabled`: Enables purge cache
366 * `provider`: Which one of the [purge cache strategy](#purge-cache-strategy) to use.
368 ## :media_preview_proxy
370 * `enabled`: Enables proxying of remote media preview to the instance’s proxy. Requires enabled media proxy (`media_proxy/enabled`).
371 * `thumbnail_max_width`: Max width of preview thumbnail for images (video preview always has original dimensions).
372 * `thumbnail_max_height`: Max height of preview thumbnail for images (video preview always has original dimensions).
373 * `image_quality`: Quality of the output. Ranges from 0 (min quality) to 100 (max quality).
374 * `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.
376 ### Purge cache strategy
378 #### Pleroma.Web.MediaProxy.Invalidation.Script
380 This strategy allow perform external shell script to purge cache.
381 Urls of attachments are passed to the script as arguments.
383 * `script_path`: Path to the external script.
384 * `url_format`: Set to `:htcacheclean` if using Apache's htcacheclean utility.
389 config :pleroma, Pleroma.Web.MediaProxy.Invalidation.Script,
390 script_path: "./installation/nginx-cache-purge.example"
393 #### Pleroma.Web.MediaProxy.Invalidation.Http
395 This strategy allow perform custom http request to purge cache.
397 * `method`: http method. default is `purge`
398 * `headers`: http headers.
399 * `options`: request options.
403 config :pleroma, Pleroma.Web.MediaProxy.Invalidation.Http,
411 ### Pleroma.Web.Metadata (provider)
412 * `providers`: a list of metadata providers to enable. Providers available:
413 * `Pleroma.Web.Metadata.Providers.OpenGraph`
414 * `Pleroma.Web.Metadata.Providers.TwitterCard`
415 * `unfurl_nsfw`: If set to `true` nsfw attachments will be shown in previews.
417 ### :rich_media (consumer)
418 * `enabled`: if enabled the instance will parse metadata from attached links to generate link previews.
419 * `ignore_hosts`: list of hosts which will be ignored by the metadata parser. For example `["accounts.google.com", "xss.website"]`, defaults to `[]`.
420 * `ignore_tld`: list TLDs (top-level domains) which will ignore for parse metadata. default is ["local", "localdomain", "lan"].
421 * `parsers`: list of Rich Media parsers.
422 * `failure_backoff`: Amount of milliseconds after request failure, during which the request will not be retried.
426 ### Pleroma.Web.Endpoint
429 `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.
431 * `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).
432 - `ip` - a tuple consisting of 4 integers
434 * `url` - a list containing the configuration for generating urls, accepts
435 - `host` - the host without the scheme and a post (e.g `example.com`, not `https://example.com:2020`)
436 - `scheme` - e.g `http`, `https`
439 * `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.
443 config :pleroma, Pleroma.Web.Endpoint,
444 url: [host: "example.com", port: 2020, scheme: "https"],
451 This will make Akkoma listen on `127.0.0.1` port `8080` and generate urls starting with `https://example.com:2020`
454 * ``enabled``: Whether the managed content security policy is enabled.
455 * ``sts``: Whether to additionally send a `Strict-Transport-Security` header.
456 * ``sts_max_age``: The maximum age for the `Strict-Transport-Security` header if sent.
457 * ``ct_max_age``: The maximum age for the `Expect-CT` header if sent.
458 * ``referrer_policy``: The referrer policy to use, either `"same-origin"` or `"no-referrer"`.
459 * ``report_uri``: Adds the specified url to `report-uri` and `report-to` group in CSP header.
461 ### Pleroma.Web.Plugs.RemoteIp
464 If your instance is not behind at least one reverse proxy, you should not enable this plug.
466 `Pleroma.Web.Plugs.RemoteIp` is a shim to call [`RemoteIp`](https://git.pleroma.social/pleroma/remote_ip) but with runtime configuration.
470 * `enabled` - Enable/disable the plug. Defaults to `false`.
471 * `headers` - A list of strings naming the HTTP headers to use when deriving the true client IP address. Defaults to `["x-forwarded-for"]`.
472 * `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.
473 * `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"]`.
479 If your instance is behind a reverse proxy ensure [`Pleroma.Web.Plugs.RemoteIp`](#pleroma-plugs-remoteip) is enabled (it is enabled by default).
481 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:
483 * The first element: `scale` (Integer). The time scale in milliseconds.
484 * The second element: `limit` (Integer). How many requests to limit in the time scale provided.
486 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.
491 config :pleroma, :rate_limit,
492 authentication: {60_000, 15},
493 search: [{1000, 10}, {1000, 30}]
498 1. In 60 seconds, 15 authentication attempts can be performed from the same IP address.
499 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.
501 Supported rate limiters:
503 * `:search` - Account/Status search.
504 * `:timeline` - Timeline requests (each timeline has it's own limiter).
505 * `:app_account_creation` - Account registration from the API.
506 * `:relations_actions` - Following/Unfollowing in general.
507 * `:relation_id_action` - Following/Unfollowing for a specific user.
508 * `:statuses_actions` - Status actions such as: (un)repeating, (un)favouriting, creating, deleting.
509 * `:status_id_action` - (un)Repeating/(un)Favouriting a particular status.
510 * `:authentication` - Authentication actions, i.e getting an OAuth token.
511 * `:password_reset` - Requesting password reset emails.
512 * `:account_confirmation_resend` - Requesting resending account confirmation emails.
513 * `:ap_routes` - Requesting statuses via ActivityPub.
517 The expiration time for the web responses cache. Values should be in milliseconds or `nil` to disable expiration.
521 * `:activity_pub` - activity pub routes (except question activities). Defaults to `nil` (no expiration).
522 * `:activity_pub_question` - activity pub routes (question activities). Defaults to `30_000` (30 seconds).
528 * `proxy_url`: an upstream proxy to fetch posts and/or media with, (default: `nil`)
529 * `send_user_agent`: should we include a user agent with HTTP requests? (default: `true`)
530 * `user_agent`: what user agent should we use? (default: `:default`), must be string or `:default`
531 * `adapter`: array of adapter options
535 Advanced. Tweaks Hackney (http client) connections pools.
537 There's three pools used:
539 * `:federation` for the federation jobs.
540 You may want this pool max_connections to be at least equal to the number of federator jobs + retry queue jobs.
541 * `:media` for rich media, media proxy
542 * `:upload` for uploaded media (if using a remote uploader and `proxy_remote: true`)
544 For each pool, the options are:
546 * `max_connections` - how much connections a pool can hold
547 * `timeout` - retention duration for connections
550 ### :connections_pool
554 Settings for HTTP connection pool.
556 * `:connection_acquisition_wait` - Timeout to acquire a connection from pool.The total max time is this value multiplied by the number of retries.
557 * `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.
558 * `:max_connections` - Maximum number of connections in the pool.
559 * `:connect_timeout` - Timeout to connect to the host.
560 * `: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.
566 Settings for request pools. These pools are limited on top of `:connections_pool`.
568 There are four pools used:
570 * `: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.
571 * `:media` - for rich media, media proxy.
572 * `:upload` - for proxying media when a remote uploader is used and `proxy_remote: true`.
573 * `:default` - for other requests.
575 For each pool, the options are:
577 * `:size` - limit to how much requests can be concurrently executed.
578 * `:recv_timeout` - timeout while `gun` will wait for response
579 * `:max_waiting` - limit to how much requests can be waiting for others to finish, after this is reached, subsequent requests will be dropped.
585 * `enabled`: Whether the captcha should be shown on registration.
586 * `method`: The method/service to use for captcha.
587 * `seconds_valid`: The time in seconds for which the captcha is valid.
589 ### Captcha providers
591 #### Pleroma.Captcha.Native
593 A built-in captcha provider. Enabled by default.
595 #### Pleroma.Captcha.Kocaptcha
597 Kocaptcha is a very simple captcha service with a single API endpoint,
598 the source code is here: [kocaptcha](https://github.com/koto-bank/kocaptcha). The default endpoint
599 `https://captcha.kotobank.ch` is hosted by the developer.
601 * `endpoint`: the Kocaptcha endpoint to use.
607 * `uploader`: Which one of the [uploaders](#uploaders) to use.
608 * `filters`: List of [upload filters](#upload-filters) to use.
609 * `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`
610 * `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.
611 * `proxy_remote`: If you're using a remote uploader, Akkoma will proxy media requests instead of redirecting to it.
612 * `proxy_opts`: Proxy options, see `Pleroma.ReverseProxy` documentation.
613 * `filename_display_max_length`: Set max length of a filename to display. 0 = no limit. Default: 30.
614 * `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
617 `strip_exif` has been replaced by `Pleroma.Upload.Filter.Mogrify`.
621 #### Pleroma.Uploaders.Local
623 * `uploads`: Which directory to store the user-uploads in, relative to pleroma’s working directory.
625 #### Pleroma.Uploaders.S3
627 Don't forget to configure [Ex AWS S3](#ex-aws-s3-settings)
629 * `bucket`: S3 bucket name.
630 * `bucket_namespace`: S3 bucket namespace.
631 * `truncated_namespace`: If you use S3 compatible service such as Digital Ocean Spaces or CDN, set folder name or "" etc.
632 * `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.
634 #### Ex AWS S3 settings
636 * `access_key_id`: Access key ID
637 * `secret_access_key`: Secret access key
644 access_key_id: "xxxxxxxxxx",
645 secret_access_key: "yyyyyyyyyy",
646 host: "s3.eu-central-1.amazonaws.com"
651 #### Pleroma.Upload.Filter.AnonymizeFilename
653 This filter replaces the filename (not the path) of an upload. For complete obfuscation, add
654 `Pleroma.Upload.Filter.Dedupe` before AnonymizeFilename.
656 * `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}`.
658 #### Pleroma.Upload.Filter.Dedupe
660 No specific configuration.
662 #### Pleroma.Upload.Filter.Exiftool
664 This filter only strips the GPS and location metadata with Exiftool leaving color profiles and attributes intact.
666 No specific configuration.
668 #### Pleroma.Upload.Filter.Mogrify
670 * `args`: List of actions for the `mogrify` command like `"strip"` or `["strip", "auto-orient", {"implode", "1"}]`.
674 ### Pleroma.Emails.Mailer
675 * `adapter`: one of the mail adapters listed in [Swoosh readme](https://github.com/swoosh/swoosh#adapters), or `Swoosh.Adapters.Local` for in-memory mailbox.
676 * `api_key` / `password` and / or other adapter-specific settings, per the above documentation.
677 * `enabled`: Allows enable/disable send emails. Default: `false`.
679 An example for Sendgrid adapter:
682 config :pleroma, Pleroma.Emails.Mailer,
684 adapter: Swoosh.Adapters.Sendgrid,
685 api_key: "YOUR_API_KEY"
688 An example for SMTP adapter:
691 config :pleroma, Pleroma.Emails.Mailer,
693 adapter: Swoosh.Adapters.SMTP,
694 relay: "smtp.gmail.com",
695 username: "YOUR_USERNAME@gmail.com",
696 password: "YOUR_SMTP_PASSWORD",
702 ### :email_notifications
704 Email notifications settings.
706 - digest - emails of "what you've missed" for users who have been
707 inactive for a while.
708 - active: globally enable or disable digest emails
709 - schedule: When to send digest email, in [crontab format](https://en.wikipedia.org/wiki/Cron).
710 "0 0 * * 0" is the default, meaning "once a week at midnight on Sunday morning"
711 - interval: Minimum interval between digest emails to one user
712 - inactivity_threshold: Minimum user inactivity threshold
714 ### Pleroma.Emails.UserEmail
716 - `:logo` - a path to a custom logo. Set it to `nil` to use the default Akkoma logo.
717 - `:styling` - a map with color settings for email templates.
719 ### Pleroma.Emails.NewUsersDigestEmail
721 - `:enabled` - a boolean, enables new users admin digest email when `true`. Defaults to `false`.
727 [Oban](https://github.com/sorentwo/oban) asynchronous job processor configuration.
729 Configuration options described in [Oban readme](https://github.com/sorentwo/oban#usage):
731 * `repo` - app's Ecto repo (`Pleroma.Repo`)
732 * `log` - logs verbosity
733 * `queues` - job queues (see below)
734 * `crontab` - periodic jobs, see [`Oban.Cron`](#obancron)
736 Akkoma has the following queues:
738 * `activity_expiration` - Activity expiration
739 * `federator_outgoing` - Outgoing federation
740 * `federator_incoming` - Incoming federation
741 * `mailer` - Email sender, see [`Pleroma.Emails.Mailer`](#pleromaemailsmailer)
742 * `transmogrifier` - Transmogrifier
743 * `web_push` - Web push notifications
744 * `scheduled_activities` - Scheduled activities, see [`Pleroma.ScheduledActivity`](#pleromascheduledactivity)
748 Akkoma has these periodic job workers:
750 * `Pleroma.Workers.Cron.DigestEmailsWorker` - digest emails for users with new mentions and follows
751 * `Pleroma.Workers.Cron.NewUsersDigestWorker` - digest emails for admins with new registrations
754 config :pleroma, Oban,
757 prune: {:maxlen, 1500},
759 federator_incoming: 50,
760 federator_outgoing: 50
763 {"0 0 * * 0", Pleroma.Workers.Cron.DigestEmailsWorker},
764 {"0 0 * * *", Pleroma.Workers.Cron.NewUsersDigestWorker}
768 This config contains two queues: `federator_incoming` and `federator_outgoing`. Both have the number of max concurrent jobs set to `50`.
770 #### Migrating `pleroma_job_queue` settings
772 `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).
776 Includes custom worker options not interpretable directly by `Oban`.
778 * `retries` — keyword lists where keys are `Oban` queues (see above) and values are numbers of max attempts for failed jobs.
783 config :pleroma, :workers,
785 federator_incoming: 5,
786 federator_outgoing: 5
790 #### Migrating `Pleroma.Web.Federator.RetryQueue` settings
792 * `max_retries` is replaced with `config :pleroma, :workers, retries: [federator_outgoing: 5]`
793 * `enabled: false` corresponds to `config :pleroma, :workers, retries: [federator_outgoing: 1]`
794 * deprecated options: `max_jobs`, `initial_timeout`
796 ## :web_push_encryption, :vapid_details
798 Web Push Notifications configuration. You can use the mix task `mix web_push.gen.keypair` to generate it.
800 * ``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.
801 * ``public_key``: VAPID public key
802 * ``private_key``: VAPID private key
805 * `backends`: `:console` is used to send logs to stdout, `{ExSyslogger, :ex_syslogger}` to log to syslog, and `Quack.Logger` to log to Slack
807 An example to enable ONLY ExSyslogger (f/ex in ``prod.secret.exs``) with info and debug suppressed:
810 backends: [{ExSyslogger, :ex_syslogger}]
812 config :logger, :ex_syslogger,
816 Another example, keeping console output and adding the pid to syslog output:
819 backends: [:console, {ExSyslogger, :ex_syslogger}]
821 config :logger, :ex_syslogger,
823 option: [:pid, :ndelay]
826 See: [logger’s documentation](https://hexdocs.pm/logger/Logger.html) and [ex_syslogger’s documentation](https://hexdocs.pm/ex_syslogger/)
828 An example of logging info to local syslog, but warn to a Slack channel:
831 backends: [ {ExSyslogger, :ex_syslogger}, Quack.Logger ],
834 config :logger, :ex_syslogger,
837 format: "$metadata[$level] $message"
842 webhook_url: "https://hooks.slack.com/services/YOUR-API-KEY-HERE"
845 See the [Quack Github](https://github.com/azohra/quack) for more details
851 ### RUM indexing for full text search
854 It is recommended to use PostgreSQL v11 or newer. We have seen some minor issues with lower PostgreSQL versions.
856 * `rum_enabled`: If RUM indexes should be used. Defaults to `false`.
858 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.
860 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.
862 To enable them, both the `rum_enabled` flag has to be set and the following special migration has to be run:
864 `mix ecto.migrate --migrations-path priv/repo/optional_migrations/rum_indexing/`
866 This will probably take a long time.
872 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:
875 config :pleroma, :admin_token, "somerandomtoken"
881 curl "http://localhost:4000/api/v1/pleroma/admin/users/invites?admin_token=somerandomtoken"
887 curl -H "X-Admin-Token: somerandomtoken" "http://localhost:4000/api/v1/pleroma/admin/users/invites"
890 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.
894 Authentication / authorization settings.
896 * `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`.
897 * `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`.
898 * `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>`).
900 ### Pleroma.Web.Auth.Authenticator
902 * `Pleroma.Web.Auth.PleromaAuthenticator`: default database authenticator.
903 * `Pleroma.Web.Auth.LDAPAuthenticator`: LDAP authentication.
907 Use LDAP for user authentication. When a user logs in to the Akkoma
908 instance, the name and password will be verified by trying to authenticate
909 (bind) to an LDAP server. If a user exists in the LDAP directory but there
910 is no account with the same name yet on the Akkoma instance then a new
911 Akkoma account will be created with the same name as the LDAP user name.
913 * `enabled`: enables LDAP authentication
914 * `host`: LDAP server hostname
915 * `port`: LDAP port, e.g. 389 or 636
916 * `ssl`: true to use SSL, usually implies the port 636
917 * `sslopts`: additional SSL options
918 * `tls`: true to start TLS, usually implies the port 389
919 * `tlsopts`: additional TLS options
920 * `base`: LDAP base, e.g. "dc=example,dc=com"
921 * `uid`: LDAP attribute name to authenticate the user, e.g. when "cn", the filter will be "cn=username,base"
923 Note, if your LDAP server is an Active Directory server the correct value is commonly `uid: "cn"`, but if you use an
924 OpenLDAP server the value may be `uid: "uid"`.
926 ### :oauth2 (Akkoma as OAuth 2.0 provider settings)
928 OAuth 2.0 provider settings:
930 * `token_expires_in` - The lifetime in seconds of the access token.
931 * `issue_new_refresh_token` - Keeps old refresh token or generate new refresh token when to obtain an access token.
932 * `clean_expired_tokens` - Enable a background job to clean expired oauth tokens. Defaults to `false`.
934 OAuth 2.0 provider and related endpoints:
936 * `POST /api/v1/apps` creates client app basing on provided params.
937 * `GET/POST /oauth/authorize` renders/submits authorization form.
938 * `POST /oauth/token` creates/renews OAuth token.
939 * `POST /oauth/revoke` revokes provided OAuth token.
940 * `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).
942 ### OAuth consumer mode
944 OAuth consumer mode allows sign in / sign up via external OAuth providers (e.g. Twitter, Facebook, Google, Microsoft, etc.).
945 Implementation is based on Ueberauth; see the list of [available strategies](https://github.com/ueberauth/ueberauth/wiki/List-of-Strategies).
948 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.
951 Each strategy requires separate setup (on external provider side and Akkoma side). Below are the guidelines on setting up most popular strategies.
954 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"`
956 * For Twitter, [register an app](https://developer.twitter.com/en/apps), configure callback URL to https://<your_host>/oauth/twitter/callback
958 * 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/
960 * For Google, [register an app](https://console.developers.google.com), configure callback URL to https://<your_host>/oauth/google/callback
962 * For Microsoft, [register an app](https://portal.azure.com), configure callback URL to https://<your_host>/oauth/microsoft/callback
964 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`,
965 per strategy's documentation (e.g. [ueberauth_twitter](https://github.com/ueberauth/ueberauth_twitter)). Example config basing on environment variables:
969 config :ueberauth, Ueberauth.Strategy.Twitter.OAuth,
970 consumer_key: System.get_env("TWITTER_CONSUMER_KEY"),
971 consumer_secret: System.get_env("TWITTER_CONSUMER_SECRET")
974 config :ueberauth, Ueberauth.Strategy.Facebook.OAuth,
975 client_id: System.get_env("FACEBOOK_APP_ID"),
976 client_secret: System.get_env("FACEBOOK_APP_SECRET"),
977 redirect_uri: System.get_env("FACEBOOK_REDIRECT_URI")
980 config :ueberauth, Ueberauth.Strategy.Google.OAuth,
981 client_id: System.get_env("GOOGLE_CLIENT_ID"),
982 client_secret: System.get_env("GOOGLE_CLIENT_SECRET"),
983 redirect_uri: System.get_env("GOOGLE_REDIRECT_URI")
986 config :ueberauth, Ueberauth.Strategy.Microsoft.OAuth,
987 client_id: System.get_env("MICROSOFT_CLIENT_ID"),
988 client_secret: System.get_env("MICROSOFT_CLIENT_SECRET")
990 config :ueberauth, Ueberauth,
992 microsoft: {Ueberauth.Strategy.Microsoft, [callback_params: []]}
996 # Note: make sure to add `keycloak:ueberauth_keycloak_strategy` entry to `OAUTH_CONSUMER_STRATEGIES` environment variable
997 keycloak_url = "https://publicly-reachable-keycloak-instance.org:8080"
999 config :ueberauth, Ueberauth.Strategy.Keycloak.OAuth,
1000 client_id: System.get_env("KEYCLOAK_CLIENT_ID"),
1001 client_secret: System.get_env("KEYCLOAK_CLIENT_SECRET"),
1003 authorize_url: "#{keycloak_url}/auth/realms/master/protocol/openid-connect/auth",
1004 token_url: "#{keycloak_url}/auth/realms/master/protocol/openid-connect/token",
1005 userinfo_url: "#{keycloak_url}/auth/realms/master/protocol/openid-connect/userinfo",
1008 config :ueberauth, Ueberauth,
1010 keycloak: {Ueberauth.Strategy.Keycloak, [uid_field: :email]}
1017 * `valid_schemes`: List of the scheme part that is considered valid to be an URL.
1019 ### Pleroma.Formatter
1021 Configuration for Akkoma's link formatter which parses mentions, hashtags, and URLs.
1023 * `class` - specify the class to be added to the generated link (default: `false`)
1024 * `rel` - specify the rel attribute (default: `ugc`)
1025 * `new_window` - adds `target="_blank"` attribute (default: `false`)
1026 * `truncate` - Set to a number to truncate URLs longer then the number. Truncated URLs will end in `...` (default: `false`)
1027 * `strip_prefix` - Strip the scheme prefix (default: `false`)
1028 * `extra` - link URLs with rarely used schemes (magnet, ipfs, irc, etc.) (default: `true`)
1029 * `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`)
1034 config :pleroma, Pleroma.Formatter,
1039 strip_prefix: false,
1041 validate_tld: :no_scheme
1044 ## Custom Runtime Modules (`:modules`)
1046 * `runtime_dir`: A path to custom Elixir modules (such as MRF policies).
1048 ## :configurable_from_database
1050 Boolean, enables/disables in-database configuration. Read [Transfering the config to/from the database](../administration/CLI_tasks/config.md) for more information.
1052 ## :database_config_whitelist
1054 List of valid configuration sections which are allowed to be configured from the
1055 database. Settings stored in the database before the whitelist is configured are
1056 still applied, so it is suggested to only use the whitelist on instances that
1057 have not migrated the config to the database.
1061 config :pleroma, :database_config_whitelist, [
1062 {:pleroma, :instance},
1063 {:pleroma, Pleroma.Web.Metadata},
1068 ### Multi-factor authentication - :two_factor_authentication
1069 * `totp` - a list containing TOTP configuration
1070 - `digits` - Determines the length of a one-time pass-code in characters. Defaults to 6 characters.
1071 - `period` - a period for which the TOTP code will be valid in seconds. Defaults to 30 seconds.
1072 * `backup_codes` - a list containing backup codes configuration
1073 - `number` - number of backup codes to generate.
1074 - `length` - backup code length. Defaults to 16 characters.
1076 ## Restrict entities access for unauthenticated users
1078 ### :restrict_unauthenticated
1080 Restrict access for unauthenticated users to timelines (public and federated), user profiles and statuses.
1082 * `timelines`: public and federated timelines
1083 * `local`: public timeline
1084 * `federated`: federated timeline (includes public timeline)
1085 * `profiles`: user profiles
1088 * `activities`: statuses
1092 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`.
1094 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).
1096 ## Pleroma.Web.ApiSpec.CastAndValidate
1098 * `:strict` a boolean, enables strict input validation (useful in development, not recommended in production). Defaults to `false`.
1100 ## :instances_favicons
1102 Control favicons for instances.
1104 * `enabled`: Allow/disallow displaying and getting instances favicons
1106 ## Pleroma.User.Backup
1109 Requires enabled email
1111 * `:purge_after_days` an integer, remove backup achives after N days.
1112 * `:limit_days` an integer, limit user to export not more often than once per N days.
1113 * `:dir` a string with a path to backup temporary directory or `nil` to let Akkoma choose temporary directory in the following order:
1114 1. the directory named by the TMPDIR environment variable
1115 2. the directory named by the TEMP environment variable
1116 3. the directory named by the TMP environment variable
1117 4. C:\TMP on Windows or /tmp on Unix-like operating systems
1118 5. as a last resort, the current working directory
1122 Settings to change theme as exposed to the outside world, for software
1123 that scans `index.html` (mainly misskey)
1126 config :pleroma, Pleroma.Web.Metadata.Providers.Theme, theme_color: "#593196"
1129 This sets the `theme-color` meta tag on `index.html`, and is basically
1130 a hack to make misskey find the right thing.
1132 ## Ephemeral activities (Pleroma.Workers.PurgeExpiredActivity)
1134 Settings to enable and configure expiration for ephemeral activities
1136 * `:enabled` - enables ephemeral activities creation
1137 * `:min_lifetime` - minimum lifetime for ephemeral activities (in seconds). Default: 10 minutes.
1139 ## ConcurrentLimiter
1141 Settings to restrict concurrently running jobs. Jobs which can be configured:
1143 * `Pleroma.Web.RichMedia.Helpers` - generating link previews of URLs in activities
1144 * `Pleroma.Web.ActivityPub.MRF.MediaProxyWarmingPolicy` - warming remote media cache via MediaProxyWarmingPolicy
1146 Each job has these settings:
1148 * `:max_running` - max concurrently runnings jobs
1149 * `:max_waiting` - max waiting jobs