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.
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`: Allows unauthenticated access to public resources on your instance. This is essentially used as the default value for `:restrict_unauthenticated`.
37 See `restrict_unauthenticated` for more details.
38 * `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.
39 * `allowed_post_formats`: MIME-type list of formats allowed to be posted (transformed into HTML).
40 * `extended_nickname_format`: Set to `true` to use extended local nicknames format (allows underscores/dashes). This will break federation with
41 older software for theses nicknames.
42 * `max_pinned_statuses`: The maximum number of pinned statuses. `0` will disable the feature.
43 * `autofollowed_nicknames`: Set to nicknames of (local) users that every new user should automatically follow.
44 * `autofollowing_nicknames`: Set to nicknames of (local) users that automatically follows every newly registered user.
45 * `attachment_links`: Set to true to enable automatically adding attachment link text to statuses.
46 * `max_report_comment_size`: The maximum size of the report comment (Default: `1000`).
47 * `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`.
48 * `healthcheck`: If set to true, system data will be shown on ``/api/v1/pleroma/healthcheck``.
49 * `remote_post_retention_days`: The default amount of days to retain remote posts when pruning the database.
50 * `user_bio_length`: A user bio maximum length (default: `5000`).
51 * `user_name_length`: A user name maximum length (default: `100`).
52 * `skip_thread_containment`: Skip filter out broken threads. The default is `false`.
53 * `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`.
54 * `max_account_fields`: The maximum number of custom fields in the user profile (default: `10`).
55 * `max_remote_account_fields`: The maximum number of custom fields in the remote user profile (default: `20`).
56 * `account_field_name_length`: An account field name maximum length (default: `512`).
57 * `account_field_value_length`: An account field value maximum length (default: `2048`).
58 * `registration_reason_length`: Maximum registration reason length (default: `500`).
59 * `external_user_synchronization`: Enabling following/followers counters synchronization for external users.
60 * `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.
61 * `show_reactions`: Let favourites and emoji reactions be viewed through the API (default: `true`).
62 * `password_reset_token_validity`: The time after which reset tokens aren't accepted anymore, in seconds (default: one day).
63 * `local_bubble`: Array of domains representing instances closely related to yours. Used to populate the `bubble` timeline. e.g `["example.com"]`, (default: `[]`)
64 * `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"]`)
65 * `export_prometheus_metrics`: Enable prometheus metrics, served at `/api/v1/akkoma/metrics`, requiring the `admin:metrics` oauth scope.
68 * `improved_hashtag_timeline`: Setting to force toggle / force disable improved hashtags timeline. `:enabled` forces hashtags to be fetched from `hashtags` table for hashtags timeline. `:disabled` forces object-embedded hashtags to be used (slower). Keep it `:auto` for automatic behaviour (it is auto-set to `:enabled` [unless overridden] when HashtagsTableMigrator completes).
70 ## Background migrations
71 * `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).
72 * `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).
75 * `direct_message`: - welcome message sent as a direct message.
76 * `enabled`: Enables the send a direct message to a newly registered user. Defaults to `false`.
77 * `sender_nickname`: The nickname of the local user that sends the welcome message.
78 * `message`: A message that will be send to a newly registered users as a direct message.
79 * `email`: - welcome message sent as a email.
80 * `enabled`: Enables the send a welcome email to a newly registered user. Defaults to `false`.
81 * `sender`: The email address or tuple with `{nickname, email}` that will use as sender to the welcome email.
82 * `subject`: A subject of welcome email.
83 * `html`: A html that will be send to a newly registered users as a email.
84 * `text`: A text that will be send to a newly registered users as a email.
89 config :pleroma, :welcome,
92 sender_nickname: "lain",
93 message: "Hi! Welcome on board!"
97 sender: {"Akkoma App", "welcome@akkoma.app"},
98 subject: "Welcome to <%= instance_name %>",
99 html: "Welcome to <%= instance_name %>",
100 text: "Welcome to <%= instance_name %>"
104 ## Message rewrite facility
107 * `policies`: Message Rewrite Policy, either one or a list. Here are the ones available by default:
108 * `Pleroma.Web.ActivityPub.MRF.NoOpPolicy`: Doesn’t modify activities (default).
109 * `Pleroma.Web.ActivityPub.MRF.DropPolicy`: Drops all activities. It generally doesn’t makes sense to use in production.
110 * `Pleroma.Web.ActivityPub.MRF.SimplePolicy`: Restrict the visibility of activities from certains instances (See [`:mrf_simple`](#mrf_simple)).
111 * `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).
112 * `Pleroma.Web.ActivityPub.MRF.SubchainPolicy`: Selectively runs other MRF policies when messages match (See [`:mrf_subchain`](#mrf_subchain)).
113 * `Pleroma.Web.ActivityPub.MRF.RejectNonPublic`: Drops posts with non-public visibility settings (See [`:mrf_rejectnonpublic`](#mrf_rejectnonpublic)).
114 * `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:.
115 * `Pleroma.Web.ActivityPub.MRF.AntiLinkSpamPolicy`: Rejects posts from likely spambots by rejecting posts from new users that contain links.
116 * `Pleroma.Web.ActivityPub.MRF.MediaProxyWarmingPolicy`: Crawls attachments using their MediaProxy URLs so that the MediaProxy cache is primed.
117 * `Pleroma.Web.ActivityPub.MRF.MentionPolicy`: Drops posts mentioning configurable users. (See [`:mrf_mention`](#mrf_mention)).
118 * `Pleroma.Web.ActivityPub.MRF.VocabularyPolicy`: Restricts activities to a configured set of vocabulary. (See [`:mrf_vocabulary`](#mrf_vocabulary)).
119 * `Pleroma.Web.ActivityPub.MRF.ObjectAgePolicy`: Rejects or delists posts based on their age when received. (See [`:mrf_object_age`](#mrf_object_age)).
120 * `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.
121 * `Pleroma.Web.ActivityPub.MRF.ForceBotUnlistedPolicy`: Makes all bot posts to disappear from public timelines.
122 * `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.
123 * `Pleroma.Web.ActivityPub.MRF.AntiFollowbotPolicy`: Drops follow requests from followbots. Users can still allow bots to follow them by first following the bot.
124 * `Pleroma.Web.ActivityPub.MRF.KeywordPolicy`: Rejects or removes from the federated timeline or replaces keywords. (See [`:mrf_keyword`](#mrf_keyword)).
125 * `Pleroma.Web.ActivityPub.MRF.NormalizeMarkup`: Pass inbound HTML through a scrubber to make sure it doesn't have anything unusual in it. On by default, cannot be turned off.
126 * `Pleroma.Web.ActivityPub.MRF.InlineQuotePolicy`: Append a link to a post that quotes another post with the link to the quoted post, to ensure that software that does not understand quotes can have full context. On by default, cannot be turned off.
127 * `transparency`: Make the content of your Message Rewrite Facility settings public (via nodeinfo).
128 * `transparency_exclusions`: Exclude specific instance names from MRF transparency. The use of the exclusions feature will be disclosed in nodeinfo as a boolean value.
129 * `transparency_obfuscate_domains`: Show domains with `*` in the middle, to censor them if needed. For example, `ridingho.me` will show as `rid*****.me`
135 Configuring MRF policies is not enough for them to take effect. You have to enable them by specifying their module in `policies` under [:mrf](#mrf) section.
138 * `media_removal`: List of instances to strip media attachments from and the reason for doing so.
139 * `media_nsfw`: List of instances to tag all media as NSFW (sensitive) from and the reason for doing so.
140 * `federated_timeline_removal`: List of instances to remove from the Federated Timeline (aka The Whole Known Network) and the reason for doing so.
141 * `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.
142 * `accept`: List of instances to only accept activities (except deletes) from and the reason for doing so.
143 * `followers_only`: Force posts from the given instances to be visible by followers only and the reason for doing so.
144 * `report_removal`: List of instances to reject reports from and the reason for doing so.
145 * `avatar_removal`: List of instances to strip avatars from and the reason for doing so.
146 * `banner_removal`: List of instances to strip banners from and the reason for doing so.
147 * `reject_deletes`: List of instances to reject deletions from and the reason for doing so.
150 This policy processes messages through an alternate pipeline when a given message matches certain criteria.
151 All criteria are configured as a map of regular expressions to lists of policy modules.
153 * `match_actor`: Matches a series of regular expressions against the actor field.
158 config :pleroma, :mrf_subchain,
160 ~r/https:\/\/example.com/s => [Pleroma.Web.ActivityPub.MRF.DropPolicy]
164 #### :mrf_rejectnonpublic
165 * `allow_followersonly`: whether to allow followers-only posts.
166 * `allow_direct`: whether to allow direct messages.
169 * `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.
170 * `reject_threshold`: Number of mentioned users after which the messaged gets rejected. Set to 0 to disable.
173 * `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).
174 * `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).
175 * `replace`: A list of tuples containing `{pattern, replacement}`, `pattern` can be a string or a [regular expression](https://hexdocs.pm/elixir/Regex.html).
178 * `actors`: A list of actors, for which to drop any posts mentioning.
181 * `accept`: A list of ActivityStreams terms to accept. If empty, all supported messages are accepted.
182 * `reject`: A list of ActivityStreams terms to reject. If empty, no messages are rejected.
184 #### :mrf_user_allowlist
186 The keys in this section are the domain names that the policy should apply to.
187 Each key should be assigned a list of users that should be allowed through by
188 their ActivityPub ID.
193 config :pleroma, :mrf_user_allowlist, %{
194 "example.org" => ["https://example.org/users/admin"]
199 * `threshold`: Required time offset (in seconds) compared to your server clock of an incoming post before actions are taken.
200 e.g., A value of 900 results in any post with a timestamp older than 15 minutes will be acted upon.
201 * `actions`: A list of actions to apply to the post:
202 * `:delist` removes the post from public timelines
203 * `:strip_followers` removes followers from the ActivityPub recipient list, ensuring they won't be delivered to home timelines
204 * `:reject` rejects the message entirely
206 #### :mrf_steal_emoji
207 * `hosts`: List of hosts to steal emojis from
208 * `rejected_shortcodes`: Regex-list of shortcodes to reject
209 * `size_limit`: File size limit (in bytes), checked before an emoji is saved to the disk
211 #### :mrf_activity_expiration
213 * `days`: Default global expiration time for all local Create activities (in days)
217 * `sensitive`: List of hashtags to mark activities as sensitive (default: `nsfw`)
218 * `federated_timeline_removal`: List of hashtags to remove activities from the federated timeline (aka TWNK)
219 * `reject`: List of hashtags to reject activities from
222 - The hashtags in the configuration do not have a leading `#`.
223 - This MRF Policy is always enabled, if you want to disable it you have to set empty lists
226 * `unfollow_blocked`: Whether blocks result in people getting unfollowed
227 * `outgoing_blocks`: Whether to federate blocks to other instances
228 * `blockers_visible`: Whether a user can see the posts of users who blocked them
229 * `deny_follow_blocked`: Whether to disallow following an account that has blocked the user in question
230 * `sign_object_fetches`: Sign object fetches with HTTP signatures
231 * `authorized_fetch_mode`: Require HTTP signatures for AP fetches
232 * `max_collection_objects`: The maximum number of objects to fetch from a remote AP collection.
236 * `restricted_nicknames`: List of nicknames users may not register with.
237 * `email_blacklist`: List of email domains users may not register with.
239 ## Pleroma.ScheduledActivity
241 * `daily_user_limit`: the number of scheduled activities a user is allowed to create in a single day (Default: `25`)
242 * `total_user_limit`: the number of scheduled activities a user is allowed to create in total (Default: `300`)
243 * `enabled`: whether scheduled activities are sent to the job queue to be executed
245 ## Frontend Management
247 ### :frontend_configurations
249 This can be used to configure a keyword list that keeps the configuration data for any kind of frontend. By default, settings for `pleroma_fe` and `masto_fe` are configured. You can find the documentation for `pleroma_fe` configuration into [Pleroma-FE configuration and customization for instance administrators](https://docs-fe.akkoma.dev/stable/CONFIGURATION/#options).
251 Frontends can access these settings at `/api/v1/pleroma/frontend_configurations`
253 To add your own configuration for Pleroma-FE, use it like this:
256 config :pleroma, :frontend_configurations,
258 theme: "pleroma-dark",
259 # ... see /priv/static/static/config.json for the available keys.
262 showInstanceSpecificPanel: true
266 These settings **need to be complete**, they will override the defaults.
270 These settings tell akkoma which frontend files to serve the user.
272 See: [Frontend Management](../frontend_management)
275 config :pleroma, :frontends,
277 "name" => "pleroma-fe",
281 "name" => "admin-fe",
285 "name" => "swagger-ui",
290 "name" => "mastodon-fe",
295 * `:primary` - The frontend that will be served at `/`
296 * `:admin` - The frontend that will be served at `/pleroma/admin`
297 * `:swagger` - Config for developers to act as an API reference to be served at `/akkoma/swaggerui/` (trailing slash _needed_). Disabled by default.
298 * `:mastodon` - The mastodon-fe configuration. This shouldn't need to be changed. This is served at `/web` when installed.
302 Render profiles and posts using server-generated HTML that is viewable without using JavaScript.
306 * `enabled` - Enables the rendering of static HTML. Defaults to `false`.
310 This section configures assets to be used with various frontends. Currently the only option
311 relates to mascots on the mastodon frontend
313 * `mascots`: KeywordList of mascots, each element __MUST__ contain both a `url` and a
315 * `default_mascot`: An element from `mascots` - This will be used as the default mascot
316 on MastoFE (default: `:pleroma_fox_tan`).
320 This section describe PWA manifest instance-specific values. Currently this option relate only for MastoFE.
322 * `icons`: Describe the icons of the app, this a list of maps describing icons in the same way as the
323 [spec](https://www.w3.org/TR/appmanifest/#imageresource-and-its-members) describes it.
328 config :pleroma, :manifest,
331 src: "/static/logo.png"
334 src: "/static/icon.png",
338 src: "/static/icon.ico",
339 sizes: "72x72 96x96 128x128 256x256"
344 * `theme_color`: Describe the theme color of the app. (Example: `"#282c37"`, `"rebeccapurple"`).
345 * `background_color`: Describe the background color of the app. (Example: `"#191b22"`, `"aliceblue"`).
349 * `shortcode_globs`: Location of custom emoji files. `*` can be used as a wildcard. Example `["/emoji/custom/**/*.png"]`
350 * `pack_extensions`: A list of file extensions for emojis, when no emoji.txt for a pack is present. Example `[".png", ".gif"]`
351 * `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"]]`
352 * `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).
353 * `shared_pack_cache_seconds_per_file`: When an emoji pack is shared, the archive is created and cached in
354 memory for this amount of seconds multiplied by the number of files.
358 * `enabled`: Enables proxying of remote media to the instance’s proxy
359 * `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.
360 * `proxy_opts`: All options defined in `Pleroma.ReverseProxy` documentation, defaults to `[max_body_length: (25*1_048_576)]`.
361 * `whitelist`: List of hosts with scheme to bypass the mediaproxy (e.g. `https://example.com`)
362 * `invalidation`: options for remove media from cache after delete object:
363 * `enabled`: Enables purge cache
364 * `provider`: Which one of the [purge cache strategy](#purge-cache-strategy) to use.
366 ## :media_preview_proxy
368 * `enabled`: Enables proxying of remote media preview to the instance’s proxy. Requires enabled media proxy (`media_proxy/enabled`).
369 * `thumbnail_max_width`: Max width of preview thumbnail for images (video preview always has original dimensions).
370 * `thumbnail_max_height`: Max height of preview thumbnail for images (video preview always has original dimensions).
371 * `image_quality`: Quality of the output. Ranges from 0 (min quality) to 100 (max quality).
372 * `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 ### Purge cache strategy
376 #### Pleroma.Web.MediaProxy.Invalidation.Script
378 This strategy allow perform external shell script to purge cache.
379 Urls of attachments are passed to the script as arguments.
381 * `script_path`: Path to the external script.
382 * `url_format`: Set to `:htcacheclean` if using Apache's htcacheclean utility.
387 config :pleroma, Pleroma.Web.MediaProxy.Invalidation.Script,
388 script_path: "./installation/nginx-cache-purge.example"
391 #### Pleroma.Web.MediaProxy.Invalidation.Http
393 This strategy allow perform custom http request to purge cache.
395 * `method`: http method. default is `purge`
396 * `headers`: http headers.
397 * `options`: request options.
401 config :pleroma, Pleroma.Web.MediaProxy.Invalidation.Http,
409 ### Pleroma.Web.Metadata (provider)
410 * `providers`: a list of metadata providers to enable. Providers available:
411 * `Pleroma.Web.Metadata.Providers.OpenGraph`
412 * `Pleroma.Web.Metadata.Providers.TwitterCard`
413 * `unfurl_nsfw`: If set to `true` nsfw attachments will be shown in previews.
415 ### :rich_media (consumer)
416 * `enabled`: if enabled the instance will parse metadata from attached links to generate link previews.
417 * `ignore_hosts`: list of hosts which will be ignored by the metadata parser. For example `["accounts.google.com", "xss.website"]`, defaults to `[]`.
418 * `ignore_tld`: list TLDs (top-level domains) which will ignore for parse metadata. default is ["local", "localdomain", "lan"].
419 * `parsers`: list of Rich Media parsers.
420 * `failure_backoff`: Amount of milliseconds after request failure, during which the request will not be retried.
424 ### Pleroma.Web.Endpoint
427 `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 * `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).
430 - `ip` - a tuple consisting of 4 integers
432 * `url` - a list containing the configuration for generating urls, accepts
433 - `host` - the host without the scheme and a post (e.g `example.com`, not `https://example.com:2020`)
434 - `scheme` - e.g `http`, `https`
437 * `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.
441 config :pleroma, Pleroma.Web.Endpoint,
442 url: [host: "example.com", port: 2020, scheme: "https"],
449 This will make Akkoma listen on `127.0.0.1` port `8080` and generate urls starting with `https://example.com:2020`
452 * ``enabled``: Whether the managed content security policy is enabled.
453 * ``sts``: Whether to additionally send a `Strict-Transport-Security` header.
454 * ``sts_max_age``: The maximum age for the `Strict-Transport-Security` header if sent.
455 * ``referrer_policy``: The referrer policy to use, either `"same-origin"` or `"no-referrer"`.
456 * ``report_uri``: Adds the specified url to `report-uri` and `report-to` group in CSP header.
458 ### Pleroma.Web.Plugs.RemoteIp
461 If your instance is not behind at least one reverse proxy, you should not enable this plug.
463 `Pleroma.Web.Plugs.RemoteIp` is a shim to call [`RemoteIp`](https://git.pleroma.social/pleroma/remote_ip) but with runtime configuration.
467 * `enabled` - Enable/disable the plug. Defaults to `false`.
468 * `headers` - A list of strings naming the HTTP headers to use when deriving the true client IP address. Defaults to `["x-forwarded-for"]`.
469 * `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.
470 * `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"]`.
476 If your instance is behind a reverse proxy ensure [`Pleroma.Web.Plugs.RemoteIp`](#pleroma-plugs-remoteip) is enabled (it is enabled by default).
478 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 * The first element: `scale` (Integer). The time scale in milliseconds.
481 * The second element: `limit` (Integer). How many requests to limit in the time scale provided.
483 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.
488 config :pleroma, :rate_limit,
489 authentication: {60_000, 15},
490 search: [{1000, 10}, {1000, 30}]
495 1. In 60 seconds, 15 authentication attempts can be performed from the same IP address.
496 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 Supported rate limiters:
500 * `:search` - Account/Status search.
501 * `:timeline` - Timeline requests (each timeline has it's own limiter).
502 * `:app_account_creation` - Account registration from the API.
503 * `:relations_actions` - Following/Unfollowing in general.
504 * `:relation_id_action` - Following/Unfollowing for a specific user.
505 * `:statuses_actions` - Status actions such as: (un)repeating, (un)favouriting, creating, deleting.
506 * `:status_id_action` - (un)Repeating/(un)Favouriting a particular status.
507 * `:authentication` - Authentication actions, i.e getting an OAuth token.
508 * `:password_reset` - Requesting password reset emails.
509 * `:account_confirmation_resend` - Requesting resending account confirmation emails.
510 * `:ap_routes` - Requesting statuses via ActivityPub.
514 The expiration time for the web responses cache. Values should be in milliseconds or `nil` to disable expiration.
518 * `:activity_pub` - activity pub routes (except question activities). Defaults to `nil` (no expiration).
519 * `:activity_pub_question` - activity pub routes (question activities). Defaults to `30_000` (30 seconds).
525 * `receive_timeout`: the amount of time, in ms, to wait for a remote server to respond to a request. (default: `15000`)
526 * `pool_timeout`: the amount of time, in ms, to wait to check out an HTTP connection from the pool. This likely does not need changing unless your instance is _very_ busy with outbound requests. (default `5000`)
527 * `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).
528 * `send_user_agent`: should we include a user agent with HTTP requests? (default: `true`)
529 * `user_agent`: what user agent should we use? (default: `:default`), must be string or `:default`
530 * `adapter`: array of adapter options
536 * `enabled`: Whether the captcha should be shown on registration.
537 * `method`: The method/service to use for captcha.
538 * `seconds_valid`: The time in seconds for which the captcha is valid.
540 ### Captcha providers
542 #### Pleroma.Captcha.Native
544 A built-in captcha provider. Enabled by default.
546 #### Pleroma.Captcha.Kocaptcha
548 Kocaptcha is a very simple captcha service with a single API endpoint,
549 the source code is here: [kocaptcha](https://github.com/koto-bank/kocaptcha). The default endpoint
550 `https://captcha.kotobank.ch` is hosted by the developer.
552 * `endpoint`: the Kocaptcha endpoint to use.
558 * `uploader`: Which one of the [uploaders](#uploaders) to use.
559 * `filters`: List of [upload filters](#upload-filters) to use.
560 * `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`
561 * `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.
562 * `proxy_remote`: If you're using a remote uploader, Akkoma will proxy media requests instead of redirecting to it.
563 * `proxy_opts`: Proxy options, see `Pleroma.ReverseProxy` documentation.
564 * `filename_display_max_length`: Set max length of a filename to display. 0 = no limit. Default: 30.
565 * `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
568 `strip_exif` has been replaced by `Pleroma.Upload.Filter.Mogrify`.
572 #### Pleroma.Uploaders.Local
574 * `uploads`: Which directory to store the user-uploads in, relative to pleroma’s working directory.
576 #### Pleroma.Uploaders.S3
578 Don't forget to configure [Ex AWS S3](#ex-aws-s3-settings)
580 * `bucket`: S3 bucket name.
581 * `bucket_namespace`: S3 bucket namespace.
582 * `truncated_namespace`: If you use S3 compatible service such as Digital Ocean Spaces or CDN, set folder name or "" etc.
583 * `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.
585 #### Ex AWS S3 settings
587 * `access_key_id`: Access key ID
588 * `secret_access_key`: Secret access key
595 access_key_id: "xxxxxxxxxx",
596 secret_access_key: "yyyyyyyyyy",
597 host: "s3.eu-central-1.amazonaws.com"
602 #### Pleroma.Upload.Filter.AnonymizeFilename
604 This filter replaces the filename (not the path) of an upload. For complete obfuscation, add
605 `Pleroma.Upload.Filter.Dedupe` before AnonymizeFilename.
607 * `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}`.
609 #### Pleroma.Upload.Filter.Dedupe
611 No specific configuration.
613 #### Pleroma.Upload.Filter.Exiftool
615 This filter only strips the GPS and location metadata with Exiftool leaving color profiles and attributes intact.
617 No specific configuration.
619 #### Pleroma.Upload.Filter.Mogrify
621 * `args`: List of actions for the `mogrify` command like `"strip"` or `["strip", "auto-orient", {"implode", "1"}]`.
625 ### Pleroma.Emails.Mailer
626 * `adapter`: one of the mail adapters listed in [Swoosh readme](https://github.com/swoosh/swoosh#adapters), or `Swoosh.Adapters.Local` for in-memory mailbox.
627 * `api_key` / `password` and / or other adapter-specific settings, per the above documentation.
628 * `enabled`: Allows enable/disable send emails. Default: `false`.
630 An example for Sendgrid adapter:
633 config :pleroma, Pleroma.Emails.Mailer,
635 adapter: Swoosh.Adapters.Sendgrid,
636 api_key: "YOUR_API_KEY"
639 An example for SMTP adapter:
642 config :pleroma, Pleroma.Emails.Mailer,
644 adapter: Swoosh.Adapters.SMTP,
645 relay: "smtp.gmail.com",
646 username: "YOUR_USERNAME@gmail.com",
647 password: "YOUR_SMTP_PASSWORD",
653 ### :email_notifications
655 Email notifications settings.
657 - digest - emails of "what you've missed" for users who have been
658 inactive for a while.
659 - active: globally enable or disable digest emails
660 - schedule: When to send digest email, in [crontab format](https://en.wikipedia.org/wiki/Cron).
661 "0 0 * * 0" is the default, meaning "once a week at midnight on Sunday morning"
662 - interval: Minimum interval between digest emails to one user
663 - inactivity_threshold: Minimum user inactivity threshold
665 ### Pleroma.Emails.UserEmail
667 - `:logo` - a path to a custom logo. Set it to `nil` to use the default Akkoma logo.
668 - `:styling` - a map with color settings for email templates.
670 ### Pleroma.Emails.NewUsersDigestEmail
672 - `:enabled` - a boolean, enables new users admin digest email when `true`. Defaults to `false`.
678 [Oban](https://github.com/sorentwo/oban) asynchronous job processor configuration.
680 Configuration options described in [Oban readme](https://github.com/sorentwo/oban#usage):
682 * `repo` - app's Ecto repo (`Pleroma.Repo`)
683 * `log` - logs verbosity
684 * `queues` - job queues (see below)
685 * `crontab` - periodic jobs, see [`Oban.Cron`](#obancron)
687 Akkoma has the following queues:
689 * `activity_expiration` - Activity expiration
690 * `federator_outgoing` - Outgoing federation
691 * `federator_incoming` - Incoming federation
692 * `mailer` - Email sender, see [`Pleroma.Emails.Mailer`](#pleromaemailsmailer)
693 * `transmogrifier` - Transmogrifier
694 * `web_push` - Web push notifications
695 * `scheduled_activities` - Scheduled activities, see [`Pleroma.ScheduledActivity`](#pleromascheduledactivity)
699 Akkoma has these periodic job workers:
701 * `Pleroma.Workers.Cron.DigestEmailsWorker` - digest emails for users with new mentions and follows
702 * `Pleroma.Workers.Cron.NewUsersDigestWorker` - digest emails for admins with new registrations
705 config :pleroma, Oban,
708 prune: {:maxlen, 1500},
710 federator_incoming: 50,
711 federator_outgoing: 50
714 {"0 0 * * 0", Pleroma.Workers.Cron.DigestEmailsWorker},
715 {"0 0 * * *", Pleroma.Workers.Cron.NewUsersDigestWorker}
719 This config contains two queues: `federator_incoming` and `federator_outgoing`. Both have the number of max concurrent jobs set to `50`.
721 #### Migrating `pleroma_job_queue` settings
723 `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).
727 Includes custom worker options not interpretable directly by `Oban`.
729 * `retries` — keyword lists where keys are `Oban` queues (see above) and values are numbers of max attempts for failed jobs.
734 config :pleroma, :workers,
736 federator_incoming: 5,
737 federator_outgoing: 5
741 #### Migrating `Pleroma.Web.Federator.RetryQueue` settings
743 * `max_retries` is replaced with `config :pleroma, :workers, retries: [federator_outgoing: 5]`
744 * `enabled: false` corresponds to `config :pleroma, :workers, retries: [federator_outgoing: 1]`
745 * deprecated options: `max_jobs`, `initial_timeout`
747 ## :web_push_encryption, :vapid_details
749 Web Push Notifications configuration. You can use the mix task `mix web_push.gen.keypair` to generate it.
751 * ``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.
752 * ``public_key``: VAPID public key
753 * ``private_key``: VAPID private key
756 * `backends`: `:console` is used to send logs to stdout, `{ExSyslogger, :ex_syslogger}` to log to syslog, and `Quack.Logger` to log to Slack
758 An example to enable ONLY ExSyslogger (f/ex in ``prod.secret.exs``) with info and debug suppressed:
761 backends: [{ExSyslogger, :ex_syslogger}]
763 config :logger, :ex_syslogger,
767 Another example, keeping console output and adding the pid to syslog output:
770 backends: [:console, {ExSyslogger, :ex_syslogger}]
772 config :logger, :ex_syslogger,
774 option: [:pid, :ndelay]
777 See: [logger’s documentation](https://hexdocs.pm/logger/Logger.html) and [ex_syslogger’s documentation](https://hexdocs.pm/ex_syslogger/)
779 An example of logging info to local syslog, but warn to a Slack channel:
782 backends: [ {ExSyslogger, :ex_syslogger}, Quack.Logger ],
785 config :logger, :ex_syslogger,
788 format: "$metadata[$level] $message"
793 ### RUM indexing for full text search
796 It is recommended to use PostgreSQL v11 or newer. We have seen some minor issues with lower PostgreSQL versions.
798 * `rum_enabled`: If RUM indexes should be used. Defaults to `false`.
800 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.
802 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.
804 To enable them, both the `rum_enabled` flag has to be set and the following special migration has to be run:
806 `mix ecto.migrate --migrations-path priv/repo/optional_migrations/rum_indexing/`
808 This will probably take a long time.
814 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:
817 config :pleroma, :admin_token, "somerandomtoken"
823 curl "http://localhost:4000/api/v1/pleroma/admin/users/invites?admin_token=somerandomtoken"
829 curl -H "X-Admin-Token: somerandomtoken" "http://localhost:4000/api/v1/pleroma/admin/users/invites"
832 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.
836 Authentication / authorization settings.
838 * `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`.
839 * `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`.
840 * `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>`).
842 ### Pleroma.Web.Auth.Authenticator
844 * `Pleroma.Web.Auth.PleromaAuthenticator`: default database authenticator.
845 * `Pleroma.Web.Auth.LDAPAuthenticator`: LDAP authentication.
849 Use LDAP for user authentication. When a user logs in to the Akkoma
850 instance, the name and password will be verified by trying to authenticate
851 (bind) to an LDAP server. If a user exists in the LDAP directory but there
852 is no account with the same name yet on the Akkoma instance then a new
853 Akkoma account will be created with the same name as the LDAP user name.
855 * `enabled`: enables LDAP authentication
856 * `host`: LDAP server hostname
857 * `port`: LDAP port, e.g. 389 or 636
858 * `ssl`: true to use SSL, usually implies the port 636
859 * `sslopts`: additional SSL options
860 * `tls`: true to start TLS, usually implies the port 389
861 * `tlsopts`: additional TLS options
862 * `base`: LDAP base, e.g. "dc=example,dc=com"
863 * `uid`: LDAP attribute name to authenticate the user, e.g. when "cn", the filter will be "cn=username,base"
865 Note, if your LDAP server is an Active Directory server the correct value is commonly `uid: "cn"`, but if you use an
866 OpenLDAP server the value may be `uid: "uid"`.
868 ### :oauth2 (Akkoma as OAuth 2.0 provider settings)
870 OAuth 2.0 provider settings:
872 * `token_expires_in` - The lifetime in seconds of the access token.
873 * `issue_new_refresh_token` - Keeps old refresh token or generate new refresh token when to obtain an access token.
874 * `clean_expired_tokens` - Enable a background job to clean expired oauth tokens. Defaults to `false`.
876 OAuth 2.0 provider and related endpoints:
878 * `POST /api/v1/apps` creates client app basing on provided params.
879 * `GET/POST /oauth/authorize` renders/submits authorization form.
880 * `POST /oauth/token` creates/renews OAuth token.
881 * `POST /oauth/revoke` revokes provided OAuth token.
882 * `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).
884 ### OAuth consumer mode
886 OAuth consumer mode allows sign in / sign up via external OAuth providers (e.g. Twitter, Facebook, Google, Microsoft, etc.).
887 Implementation is based on Ueberauth; see the list of [available strategies](https://github.com/ueberauth/ueberauth/wiki/List-of-Strategies).
890 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.
893 Each strategy requires separate setup (on external provider side and Akkoma side). Below are the guidelines on setting up most popular strategies.
896 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"`
898 * For Twitter, [register an app](https://developer.twitter.com/en/apps), configure callback URL to https://<your_host>/oauth/twitter/callback
900 * 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/
902 * For Google, [register an app](https://console.developers.google.com), configure callback URL to https://<your_host>/oauth/google/callback
904 * For Microsoft, [register an app](https://portal.azure.com), configure callback URL to https://<your_host>/oauth/microsoft/callback
906 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`,
907 per strategy's documentation (e.g. [ueberauth_twitter](https://github.com/ueberauth/ueberauth_twitter)). Example config basing on environment variables:
911 config :ueberauth, Ueberauth.Strategy.Twitter.OAuth,
912 consumer_key: System.get_env("TWITTER_CONSUMER_KEY"),
913 consumer_secret: System.get_env("TWITTER_CONSUMER_SECRET")
916 config :ueberauth, Ueberauth.Strategy.Facebook.OAuth,
917 client_id: System.get_env("FACEBOOK_APP_ID"),
918 client_secret: System.get_env("FACEBOOK_APP_SECRET"),
919 redirect_uri: System.get_env("FACEBOOK_REDIRECT_URI")
922 config :ueberauth, Ueberauth.Strategy.Google.OAuth,
923 client_id: System.get_env("GOOGLE_CLIENT_ID"),
924 client_secret: System.get_env("GOOGLE_CLIENT_SECRET"),
925 redirect_uri: System.get_env("GOOGLE_REDIRECT_URI")
928 config :ueberauth, Ueberauth.Strategy.Microsoft.OAuth,
929 client_id: System.get_env("MICROSOFT_CLIENT_ID"),
930 client_secret: System.get_env("MICROSOFT_CLIENT_SECRET")
932 config :ueberauth, Ueberauth,
934 microsoft: {Ueberauth.Strategy.Microsoft, [callback_params: []]}
938 # Note: make sure to add `keycloak:ueberauth_keycloak_strategy` entry to `OAUTH_CONSUMER_STRATEGIES` environment variable
939 keycloak_url = "https://publicly-reachable-keycloak-instance.org:8080"
941 config :ueberauth, Ueberauth.Strategy.Keycloak.OAuth,
942 client_id: System.get_env("KEYCLOAK_CLIENT_ID"),
943 client_secret: System.get_env("KEYCLOAK_CLIENT_SECRET"),
945 authorize_url: "#{keycloak_url}/auth/realms/master/protocol/openid-connect/auth",
946 token_url: "#{keycloak_url}/auth/realms/master/protocol/openid-connect/token",
947 userinfo_url: "#{keycloak_url}/auth/realms/master/protocol/openid-connect/userinfo",
950 config :ueberauth, Ueberauth,
952 keycloak: {Ueberauth.Strategy.Keycloak, [uid_field: :email]}
959 * `valid_schemes`: List of the scheme part that is considered valid to be an URL.
961 ### Pleroma.Formatter
963 Configuration for Akkoma's link formatter which parses mentions, hashtags, and URLs.
965 * `class` - specify the class to be added to the generated link (default: `false`)
966 * `rel` - specify the rel attribute (default: `ugc`)
967 * `new_window` - adds `target="_blank"` attribute (default: `false`)
968 * `truncate` - Set to a number to truncate URLs longer then the number. Truncated URLs will end in `...` (default: `false`)
969 * `strip_prefix` - Strip the scheme prefix (default: `false`)
970 * `extra` - link URLs with rarely used schemes (magnet, ipfs, irc, etc.) (default: `true`)
971 * `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`)
976 config :pleroma, Pleroma.Formatter,
983 validate_tld: :no_scheme
986 ## Custom Runtime Modules (`:modules`)
988 * `runtime_dir`: A path to custom Elixir modules, such as MRF policies or
989 custom authenticators. These modules will be loaded on boot, and can be
990 contained in subdirectories. It is advised to use version-controlled
991 subdirectories to make management of them a bit easier. Note that only
992 files with the extension `.ex` will be loaded.
995 config :pleroma, :modules, runtime_dir: "instance/modules"
1001 cd instance/modules/
1002 git clone <MY MODULE>
1005 ## :configurable_from_database
1007 Boolean, enables/disables in-database configuration. Read [Transfering the config to/from the database](../administration/CLI_tasks/config.md) for more information.
1009 ## :database_config_whitelist
1011 List of valid configuration sections which are allowed to be configured from the
1012 database. Settings stored in the database before the whitelist is configured are
1013 still applied, so it is suggested to only use the whitelist on instances that
1014 have not migrated the config to the database.
1018 config :pleroma, :database_config_whitelist, [
1019 {:pleroma, :instance},
1020 {:pleroma, Pleroma.Web.Metadata},
1025 ### Multi-factor authentication - :two_factor_authentication
1026 * `totp` - a list containing TOTP configuration
1027 - `digits` - Determines the length of a one-time pass-code in characters. Defaults to 6 characters.
1028 - `period` - a period for which the TOTP code will be valid in seconds. Defaults to 30 seconds.
1029 * `backup_codes` - a list containing backup codes configuration
1030 - `number` - number of backup codes to generate.
1031 - `length` - backup code length. Defaults to 16 characters.
1033 ## Restrict entities access for unauthenticated users
1035 ### :restrict_unauthenticated
1037 Restrict access for unauthenticated users to timelines (public and federated), user profiles and posts.
1039 * `timelines`: public and federated timelines
1040 * `local`: public timeline
1041 * `federated`: federated timeline (includes public timeline)
1042 * `profiles`: user profiles
1045 * `activities`: posts
1049 #### When :instance, :public is `true`
1051 When your instance is in "public" mode, all public resources (users, posts, timelines) are accessible to unauthenticated users.
1053 Turning any of the `:restrict_unauthenticated` options to `true` will restrict access to the corresponding resources.
1055 #### When :instance, :public is `false`
1057 When `:instance, :public` is set to `false`, all of the `:restrict_unauthenticated` options will effectively be set to `true` by default,
1058 meaning that only authenticated users will be able to access the corresponding resources.
1060 If you'd like to allow unauthenticated access to specific resources, you can turn these settings to `false`.
1062 **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).
1064 ## Pleroma.Web.ApiSpec.CastAndValidate
1066 * `:strict` a boolean, enables strict input validation (useful in development, not recommended in production). Defaults to `false`.
1068 ## :instances_favicons
1070 Control favicons for instances.
1072 * `enabled`: Allow/disallow displaying and getting instances favicons
1074 ## Pleroma.User.Backup
1077 Requires enabled email
1079 * `:purge_after_days` an integer, remove backup achives after N days.
1080 * `:limit_days` an integer, limit user to export not more often than once per N days.
1081 * `:dir` a string with a path to backup temporary directory or `nil` to let Akkoma choose temporary directory in the following order:
1082 1. the directory named by the TMPDIR environment variable
1083 2. the directory named by the TEMP environment variable
1084 3. the directory named by the TMP environment variable
1085 4. C:\TMP on Windows or /tmp on Unix-like operating systems
1086 5. as a last resort, the current working directory
1090 Settings to change theme as exposed to the outside world, for software
1091 that scans `index.html` (mainly misskey)
1094 config :pleroma, Pleroma.Web.Metadata.Providers.Theme, theme_color: "#593196"
1097 This sets the `theme-color` meta tag on `index.html`, and is basically
1098 a hack to make misskey find the right thing.
1100 ## Ephemeral activities (Pleroma.Workers.PurgeExpiredActivity)
1102 Settings to enable and configure expiration for ephemeral activities
1104 * `:enabled` - enables ephemeral activities creation
1105 * `:min_lifetime` - minimum lifetime for ephemeral activities (in seconds). Default: 10 minutes.
1107 ## ConcurrentLimiter
1109 Settings to restrict concurrently running jobs. Jobs which can be configured:
1111 * `Pleroma.Web.RichMedia.Helpers` - generating link previews of URLs in activities
1112 * `Pleroma.Web.ActivityPub.MRF.MediaProxyWarmingPolicy` - warming remote media cache via MediaProxyWarmingPolicy
1114 Each job has these settings:
1116 * `:max_running` - max concurrently runnings jobs
1117 * `:max_waiting` - max waiting jobs
1119 ### Translation Settings
1121 Settings to automatically translate statuses for end users. Currently supported
1122 translation services are DeepL and LibreTranslate. The supported command line tool is [Argos Translate](https://github.com/argosopentech/argos-translate).
1124 Translations are available at `/api/v1/statuses/:id/translations/:language`, where
1125 `language` is the target language code (e.g `en`)
1129 - `:enabled` - enables translation
1130 - `:module` - Sets module to be used
1131 - Either `Pleroma.Akkoma.Translators.DeepL`, `Pleroma.Akkoma.Translators.LibreTranslate`, or `Pleroma.Akkoma.Translators.ArgosTranslate`
1135 - `:api_key` - API key for DeepL
1136 - `:tier` - API tier
1137 - either `:free` or `:pro`
1139 ### `:libre_translate`
1141 - `:url` - URL of LibreTranslate instance
1142 - `:api_key` - API key for LibreTranslate
1144 ### `:argos_translate`
1146 - `:command_argos_translate` - command for `argos-translate`. Can be the command if it's in your PATH, or the full path to the file (default: `argos-translate`).
1147 - `:command_argospm` - command for `argospm`. Can be the command if it's in your PATH, or the full path to the file (default: `argospm`).
1148 - `:strip_html` - Strip html from the post before translating it (default: `true`).