logo

pleroma

My custom branche(s) on git.pleroma.social/pleroma/pleroma git clone https://anongit.hacktivis.me/git/pleroma.git/

cheatsheet.md (61552B)

    

  1. # Configuration Cheat Sheet
  3. This is a cheat sheet for Pleroma configuration file, any setting possible to configure should be listed here.
  5. For OTP installations the configuration is typically stored in `/etc/pleroma/config.exs`.
  7. For from source installations Pleroma configuration works by first importing the base config `config/config.exs`, then overriding it by the environment config `config/$MIX_ENV.exs` and then overriding it by user config `config/$MIX_ENV.secret.exs`. In from source installations you should always make the changes to the user config and NEVER to the base config to avoid breakages and merge conflicts. So for production you change/add configuration to `config/prod.secret.exs`.
  9. To add configuration to your config file, you can copy it from the base config. The latest version of it can be viewed [here](https://git.pleroma.social/pleroma/pleroma/blob/develop/config/config.exs). You can also use this file if you don't know how an option is supposed to be formatted.
  11. ## :shout
  13. * `enabled` - Enables the backend Shoutbox chat feature. Defaults to `true`.
  14. * `limit` - Shout character limit. Defaults to `5_000`
  16. ## :instance
  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. * `short_description`: Shorter version of instance description, can be seen on ``/api/v1/instance``.
  22. * `limit`: Posts character limit (CW/Subject included in the counter).
  23. * `description_limit`: The character limit for image descriptions.
  24. * `remote_limit`: Hard character limit beyond which remote posts will be dropped.
  25. * `upload_limit`: File size limit of uploads (except for avatar, background, banner).
  26. * `avatar_upload_limit`: File size limit of user’s profile avatars.
  27. * `background_upload_limit`: File size limit of user’s profile backgrounds.
  28. * `banner_upload_limit`: File size limit of user’s profile banners.
  29. * `poll_limits`: A map with poll limits for **local** polls.
  30.     * `max_options`: Maximum number of options.
  31.     * `max_option_chars`: Maximum number of characters per option.
  32.     * `min_expiration`: Minimum expiration time (in seconds).
  33.     * `max_expiration`: Maximum expiration time (in seconds).
  34. * `registrations_open`: Enable registrations for anyone, invitations can be enabled when false.
  35. * `invites_enabled`: Enable user invitations for admins (depends on `registrations_open: false`).
  36. * `account_activation_required`: Require users to confirm their emails before signing in.
  37. * `account_approval_required`: Require users to be manually approved by an admin before signing in.
  38. * `federating`: Enable federation with other instances.
  39. * `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.
  40. * `federation_reachability_timeout_days`: Timeout (in days) of each external federation target being unreachable prior to pausing federating to it.
  41. * `allow_relay`: Permits remote instances to subscribe to all public posts of your instance. This may increase the visibility of your instance.
  42. * `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.
  43. * `quarantined_instances`: ActivityPub instances where private (DMs, followers-only) activities will not be send.
  44. * `rejected_instances`: ActivityPub instances to reject requests from if authorized_fetch_mode is enabled.
  45. * `allowed_post_formats`: MIME-type list of formats allowed to be posted (transformed into HTML).
  46. * `extended_nickname_format`: Set to `true` to use extended local nicknames format (allows underscores/dashes). This will break federation with
  47.     older software for theses nicknames.
  48. * `max_pinned_statuses`: The maximum number of pinned statuses. `0` will disable the feature.
  49. * `autofollowed_nicknames`: Set to nicknames of (local) users that every new user should automatically follow.
  50. * `autofollowing_nicknames`: Set to nicknames of (local) users that automatically follows every newly registered user.
  51. * `attachment_links`: Set to true to enable automatically adding attachment link text to statuses.
  52. * `max_report_comment_size`: The maximum size of the report comment (Default: `1000`).
  53. * `report_strip_status`: Strip associated statuses in reports to ids when closed/resolved, otherwise keep a copy.
  54. * `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`.
  55. * `healthcheck`: If set to true, system data will be shown on ``/api/v1/pleroma/healthcheck``.
  56. * `remote_post_retention_days`: The default amount of days to retain remote posts when pruning the database.
  57. * `user_bio_length`: A user bio maximum length (default: `5000`).
  58. * `user_name_length`: A user name maximum length (default: `100`).
  59. * `skip_thread_containment`: Skip filter out broken threads. The default is `false`.
  60. * `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`.
  61. * `max_account_fields`: The maximum number of custom fields in the user profile (default: `10`).
  62. * `max_remote_account_fields`: The maximum number of custom fields in the remote user profile (default: `20`).
  63. * `account_field_name_length`: An account field name maximum length (default: `512`).
  64. * `account_field_value_length`: An account field value maximum length (default: `2048`).
  65. * `registration_reason_length`: Maximum registration reason length (default: `500`).
  66. * `external_user_synchronization`: Enabling following/followers counters synchronization for external users.
  67. * `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.
  68. * `show_reactions`: Let favourites and emoji reactions be viewed through the API (default: `true`).
  69. * `password_reset_token_validity`: The time after which reset tokens aren't accepted anymore, in seconds (default: one day).
  70. * `admin_privileges`: A list of privileges an admin has (e.g. delete messages, manage reports...)
  71.     * Possible values are:
  72.       * `:users_read`
  73.         * Allows admins to fetch users through the admin API.
  74.       * `:users_manage_invites`
  75.         * Allows admins to manage invites. This includes sending, resending, revoking and approving invites.
  76.       * `:users_manage_activation_state`
  77.         * Allows admins to activate and deactivate accounts. This also allows them to see deactivated users through the Mastodon API.
  78.       * `:users_manage_tags`
  79.         * Allows admins to set and remove tags for users. This can be useful in combination with MRF policies, such as `Pleroma.Web.ActivityPub.MRF.TagPolicy`.
  80.       * `:users_manage_credentials`
  81.         * Allows admins to trigger a password reset and set new credentials for an user.
  82.       * `:users_delete`
  83.         * Allows admins to delete accounts. Note that deleting an account is actually deactivating it and removing all data like posts, profile information, etc.
  84.       * `:messages_read`
  85.         * Allows admins to read messages through the admin API, including non-public posts and chats.
  86.       * `:messages_delete`
  87.         * Allows admins to delete messages from other users.
  88.       * `:instances_delete,`
  89.         * Allows admins to remove a whole remote instance from your instance. This will delete all users and messages from that remote instance.
  90.       * `:reports_manage_reports`
  91.         * Allows admins to see and manage reports.
  92.       * `:moderation_log_read,`
  93.         * Allows admins to read the entries in the moderation log.
  94.       * `:emoji_manage_emoji`
  95.         * Allows admins to manage custom emoji on the instance.
  96.       * `:statistics_read,`
  97.         * Allows admins to see some simple statistics about the instance.
  98. * `moderator_privileges`: A list of privileges a moderator has (e.g. delete messages, manage reports...)
  99.     * Possible values are the same as for `admin_privileges`
  101. ## :database
  102. * `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).
  104. ## Background migrations
  105. * `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).
  106. * `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).
  108. ## Welcome
  109. * `direct_message`: - welcome message sent as a direct message.
  110.   * `enabled`: Enables the send a direct message to a newly registered user. Defaults to `false`.
  111.   * `sender_nickname`: The nickname of the local user that sends the welcome message.
  112.   * `message`: A message that will be send to a newly registered users as a direct message.
  113. * `chat_message`: - welcome message sent as a chat message.
  114.   * `enabled`: Enables the send a chat message to a newly registered user. Defaults to `false`.
  115.   * `sender_nickname`: The nickname of the local user that sends the welcome message.
  116.   * `message`: A message that will be send to a newly registered users as a chat message.
  117. * `email`: - welcome message sent as a email.
  118.   * `enabled`: Enables the send a welcome email to a newly registered user. Defaults to `false`.
  119.   * `sender`: The email address or tuple with `{nickname, email}` that will use as sender to the welcome email.
  120.   * `subject`: A subject of welcome email.
  121.   * `html`: A html that will be send to a newly registered users as a email.
  122.   * `text`: A text that will be send to a newly registered users as a email.
  124.     Example:
  126.   ```elixir
  127.   config :pleroma, :welcome,
  128.       direct_message: [
  129.         enabled: true,
  130.         sender_nickname: "lain",
  131.         message: "Hi! Welcome on board!"
  132.         ],
  133.       email: [
  134.         enabled: true,
  135.         sender: {"Pleroma App", "welcome@pleroma.app"},
  136.         subject: "Welcome to <%= instance_name %>",
  137.         html: "Welcome to <%= instance_name %>",
  138.         text: "Welcome to <%= instance_name %>"
  139.     ]
  140.   ```
  142. ## Message rewrite facility
  144. ### :mrf
  145. * `policies`: Message Rewrite Policy, either one or a list. Here are the ones available by default:
  146.     * `Pleroma.Web.ActivityPub.MRF.NoOpPolicy`: Doesn’t modify activities (default).
  147.     * `Pleroma.Web.ActivityPub.MRF.DropPolicy`: Drops all activities. It generally doesn’t makes sense to use in production.
  148.     * `Pleroma.Web.ActivityPub.MRF.SimplePolicy`: Restrict the visibility of activities from certains instances (See [`:mrf_simple`](#mrf_simple)).
  149.     * `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).
  150.     * `Pleroma.Web.ActivityPub.MRF.SubchainPolicy`: Selectively runs other MRF policies when messages match (See [`:mrf_subchain`](#mrf_subchain)).
  151.     * `Pleroma.Web.ActivityPub.MRF.RejectNonPublic`: Drops posts with non-public visibility settings (See [`:mrf_rejectnonpublic`](#mrf_rejectnonpublic)).
  152.     * `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:.
  153.     * `Pleroma.Web.ActivityPub.MRF.AntiLinkSpamPolicy`: Rejects posts from likely spambots by rejecting posts from new users that contain links.
  154.     * `Pleroma.Web.ActivityPub.MRF.MediaProxyWarmingPolicy`: Crawls attachments using their MediaProxy URLs so that the MediaProxy cache is primed.
  155.     * `Pleroma.Web.ActivityPub.MRF.MentionPolicy`: Drops posts mentioning configurable users. (See [`:mrf_mention`](#mrf_mention)).
  156.     * `Pleroma.Web.ActivityPub.MRF.VocabularyPolicy`: Restricts activities to a configured set of vocabulary. (See [`:mrf_vocabulary`](#mrf_vocabulary)).
  157.     * `Pleroma.Web.ActivityPub.MRF.ObjectAgePolicy`: Rejects or delists posts based on their age when received. (See [`:mrf_object_age`](#mrf_object_age)).
  158.     * `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 deletions.
  159.     * `Pleroma.Web.ActivityPub.MRF.ForceBotUnlistedPolicy`: Makes all bot posts to disappear from public timelines.
  160.     * `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.
  161.     * `Pleroma.Web.ActivityPub.MRF.AntiFollowbotPolicy`: Drops follow requests from followbots. Users can still allow bots to follow them by first following the bot.
  162.     * `Pleroma.Web.ActivityPub.MRF.KeywordPolicy`: Rejects or removes from the federated timeline or replaces keywords. (See [`:mrf_keyword`](#mrf_keyword)).
  163.     * `Pleroma.Web.ActivityPub.MRF.ForceMentionsInContent`: Forces every mentioned user to be reflected in the post content.
  164.     * `Pleroma.Web.ActivityPub.MRF.InlineQuotePolicy`: Forces quote post URLs to be reflected in the message content inline.
  165.     * `Pleroma.Web.ActivityPub.MRF.QuoteToLinkTagPolicy`: Force a Link tag for posts quoting another post. (may break outgoing federation of quote posts with older Pleroma versions).
  166.     * `Pleroma.Web.ActivityPub.MRF.ForceMention`: Forces posts to include a mention of the author of parent post or the author of quoted post.
  167. * `transparency`: Make the content of your Message Rewrite Facility settings public (via nodeinfo).
  168. * `transparency_exclusions`: Exclude specific instance names from MRF transparency.  The use of the exclusions feature will be disclosed in nodeinfo as a boolean value.
  170. ## Federation
  171. ### MRF policies
  173. !!! note
  174.     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.
  176. #### :mrf_simple
  177. * `media_removal`: List of instances to strip media attachments from and the reason for doing so.
  178. * `media_nsfw`: List of instances to tag all media as NSFW (sensitive) from and the reason for doing so.
  179. * `federated_timeline_removal`: List of instances to remove from the Federated Timeline (aka The Whole Known Network) and the reason for doing so.
  180. * `reject`: List of instances to reject activities (except deletes) from and the reason for doing so.
  181. * `accept`: List of instances to only accept activities (except deletes) from and the reason for doing so.
  182. * `followers_only`: Force posts from the given instances to be visible by followers only and the reason for doing so.
  183. * `report_removal`: List of instances to reject reports from and the reason for doing so.
  184. * `avatar_removal`: List of instances to strip avatars from and the reason for doing so.
  185. * `banner_removal`: List of instances to strip banners from and the reason for doing so.
  186. * `reject_deletes`: List of instances to reject deletions from and the reason for doing so.
  188. #### :mrf_subchain
  189. This policy processes messages through an alternate pipeline when a given message matches certain criteria.
  190. All criteria are configured as a map of regular expressions to lists of policy modules.
  192. * `match_actor`: Matches a series of regular expressions against the actor field.
  194. Example:
  196. ```elixir
  197. config :pleroma, :mrf_subchain,
  198.   match_actor: %{
  199.     ~r/https:\/\/example.com/s => [Pleroma.Web.ActivityPub.MRF.DropPolicy]
  200.   }
  201. ```
  203. #### :mrf_rejectnonpublic
  204. * `allow_followersonly`: whether to allow followers-only posts.
  205. * `allow_direct`: whether to allow direct messages.
  207. #### :mrf_hellthread
  208. * `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.
  209. * `reject_threshold`: Number of mentioned users after which the messaged gets rejected. Set to 0 to disable.
  211. #### :mrf_keyword
  212. * `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).
  213. * `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).
  214. * `replace`: A list of tuples containing `{pattern, replacement}`, `pattern` can be a string or a [regular expression](https://hexdocs.pm/elixir/Regex.html).
  216. #### :mrf_mention
  217. * `actors`: A list of actors, for which to drop any posts mentioning.
  219. #### :mrf_vocabulary
  220. * `accept`: A list of ActivityStreams terms to accept.  If empty, all supported messages are accepted.
  221. * `reject`: A list of ActivityStreams terms to reject.  If empty, no messages are rejected.
  223. #### :mrf_user_allowlist
  225. The keys in this section are the domain names that the policy should apply to.
  226. Each key should be assigned a list of users that should be allowed through by
  227. their ActivityPub ID.
  229. An example:
  231. ```elixir
  232. config :pleroma, :mrf_user_allowlist, %{
  233.   "example.org" => ["https://example.org/users/admin"]
  234. }
  235. ```
  237. #### :mrf_object_age
  238. * `threshold`: Required time offset (in seconds) compared to your server clock of an incoming post before actions are taken.
  239.   e.g., A value of 900 results in any post with a timestamp older than 15 minutes will be acted upon.
  240. * `actions`: A list of actions to apply to the post:
  241.   * `:delist` removes the post from public timelines
  242.   * `:strip_followers` removes followers from the ActivityPub recipient list, ensuring they won't be delivered to home timelines, additionally for followers-only it degrades to a direct message
  243.   * `:reject` rejects the message entirely
  245. #### :mrf_steal_emoji
  246. * `hosts`: List of hosts to steal emojis from
  247. * `rejected_shortcodes`: Regex-list of shortcodes to reject
  248. * `size_limit`: File size limit (in bytes), checked before an emoji is saved to the disk
  250. #### :mrf_activity_expiration
  252. * `days`: Default global expiration time for all local Create activities (in days)
  254. #### :mrf_hashtag
  256. * `sensitive`: List of hashtags to mark activities as sensitive (default: `nsfw`)
  257. * `federated_timeline_removal`: List of hashtags to remove activities from the federated timeline (aka TWNK)
  258. * `reject`: List of hashtags to reject activities from
  260. Notes:
  261. - The hashtags in the configuration do not have a leading `#`.
  262. - This MRF Policy is always enabled, if you want to disable it you have to set empty lists
  264. #### :mrf_follow_bot
  266. * `follower_nickname`: The name of the bot account to use for following newly discovered users. Using `followbot` or similar is strongly suggested.
  268. #### :mrf_emoji
  269. * `remove_url`: A list of patterns which result in emoji whose URL matches being removed from the message. This will apply to statuses, emoji reactions, and user profiles. Each pattern can be a string or a [regular expression](https://hexdocs.pm/elixir/Regex.html).
  270. * `remove_shortcode`: A list of patterns which result in emoji whose shortcode matches being removed from the message. This will apply to statuses, emoji reactions, and user profiles. Each pattern can be a string or a [regular expression](https://hexdocs.pm/elixir/Regex.html).
  271. * `federated_timeline_removal_url`: A list of patterns which result in message with emojis whose URLs match being removed from federated timelines (a.k.a unlisted). This will apply only to statuses. Each pattern can be a string or a [regular expression](https://hexdocs.pm/elixir/Regex.html).
  272. * `federated_timeline_removal_shortcode`: A list of patterns which result in message with emojis whose shortcodes match being removed from federated timelines (a.k.a unlisted). This will apply only to statuses. Each pattern can be a string or a [regular expression](https://hexdocs.pm/elixir/Regex.html).
  274. #### :mrf_inline_quote
  275. * `template`: The template to append to the post. `{url}` will be replaced with the actual link to the quoted post. Default: `<bdi>RT:</bdi> {url}`
  277. #### :mrf_force_mention
  278. * `mention_parent`: Whether to append mention of parent post author
  279. * `mention_quoted`: Whether to append mention of parent quoted author
  281. ### :activitypub
  282. * `unfollow_blocked`: Whether blocks result in people getting unfollowed
  283. * `outgoing_blocks`: Whether to federate blocks to other instances
  284. * `blockers_visible`: Whether a user can see the posts of users who blocked them
  285. * `deny_follow_blocked`: Whether to disallow following an account that has blocked the user in question
  286. * `sign_object_fetches`: Sign object fetches with HTTP signatures
  287. * `authorized_fetch_mode`: Require HTTP signatures for AP fetches
  288. * `authorized_fetch_mode_exceptions`: List of IPs (CIDR format accepted) to exempt from HTTP Signatures requirement (for example to allow debugging, you shouldn't otherwise need this)
  290. ## Pleroma.User
  292. * `restricted_nicknames`: List of nicknames users may not register with.
  293. * `email_blacklist`: List of email domains users may not register with.
  295. ## Pleroma.ScheduledActivity
  297. * `daily_user_limit`: the number of scheduled activities a user is allowed to create in a single day (Default: `25`)
  298. * `total_user_limit`: the number of scheduled activities a user is allowed to create in total (Default: `300`)
  299. * `enabled`: whether scheduled activities are sent to the job queue to be executed
  301. ### :frontend_configurations
  303. 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` are configured. You can find the documentation for `pleroma_fe` configuration into [Pleroma-FE configuration and customization for instance administrators](/frontend/CONFIGURATION/#options).
  305. Frontends can access these settings at `/api/v1/pleroma/frontend_configurations`
  307. To add your own configuration for PleromaFE, use it like this:
  309. ```elixir
  310. config :pleroma, :frontend_configurations,
  311.   pleroma_fe: %{
  312.     theme: "pleroma-dark",
  313.     # ... see /priv/static/static/config.json for the available keys.
  314. }
  315. ```
  317. These settings **need to be complete**, they will override the defaults.
  319. ### :static_fe
  321. Render profiles and posts using server-generated HTML that is viewable without using JavaScript.
  323. Available options:
  325. * `enabled` - Enables the rendering of static HTML. Defaults to `false`.
  327. ### :assets
  329. This section configures assets to be used with various frontends. Currently the only option
  330. relates to mascots on the mastodon frontend
  332. * `mascots`: KeywordList of mascots, each element __MUST__ contain both a `url` and a
  333.   `mime_type` key.
  334. * `default_mascot`: An element from `mascots` - This will be used as the default mascot
  335.   on MastoFE (default: `:pleroma_fox_tan`).
  337. ### :manifest
  339. This section describe PWA manifest instance-specific values. Currently this option relate only for MastoFE.
  341. * `icons`: Describe the icons of the app, this a list of maps describing icons in the same way as the
  342.   [spec](https://www.w3.org/TR/appmanifest/#imageresource-and-its-members) describes it.
  344.   Example:
  346.   ```elixir
  347.   config :pleroma, :manifest,
  348.     icons: [
  349.       %{
  350.         src: "/static/logo.png"
  351.       },
  352.       %{
  353.         src: "/static/icon.png",
  354.         type: "image/png"
  355.       },
  356.       %{
  357.         src: "/static/icon.ico",
  358.         sizes: "72x72 96x96 128x128 256x256"
  359.       }
  360.     ]
  361.   ```
  363. * `theme_color`: Describe the theme color of the app. (Example: `"#282c37"`, `"rebeccapurple"`).
  364. * `background_color`: Describe the background color of the app. (Example: `"#191b22"`, `"aliceblue"`).
  366. ## :emoji
  368. * `shortcode_globs`: Location of custom emoji files. `*` can be used as a wildcard. Example `["/emoji/custom/**/*.png"]`
  369. * `pack_extensions`: A list of file extensions for emojis, when no emoji.txt for a pack is present. Example `[".png", ".gif"]`
  370. * `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"]]`
  371. * `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).
  372. * `shared_pack_cache_seconds_per_file`: When an emoji pack is shared, the archive is created and cached in
  373.   memory for this amount of seconds multiplied by the number of files.
  375. ## :media_proxy
  377. * `enabled`: Enables proxying of remote media to the instance’s proxy
  378. * `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.
  379. * `proxy_opts`: All options defined in `Pleroma.ReverseProxy` documentation, defaults to `[max_body_length: (25*1_048_576)]`.
  380. * `whitelist`: List of hosts with scheme to bypass the mediaproxy (e.g. `https://example.com`)
  381. * `invalidation`: options for remove media from cache after delete object:
  382.   * `enabled`: Enables purge cache
  383.   * `provider`: Which one of  the [purge cache strategy](#purge-cache-strategy) to use.
  385. ## :media_preview_proxy
  387. * `enabled`: Enables proxying of remote media preview to the instance’s proxy. Requires enabled media proxy (`media_proxy/enabled`).
  388. * `thumbnail_max_width`: Max width of preview thumbnail for images (video preview always has original dimensions).
  389. * `thumbnail_max_height`: Max height of preview thumbnail for images (video preview always has original dimensions).
  390. * `image_quality`: Quality of the output. Ranges from 0 (min quality) to 100 (max quality).
  391. * `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.
  393. ### Purge cache strategy
  395. #### Pleroma.Web.MediaProxy.Invalidation.Script
  397. This strategy allow perform external shell script to purge cache.
  398. Urls of attachments are passed to the script as arguments.
  400. * `script_path`: Path to the external script.
  401. * `url_format`: Set to `:htcacheclean` if using Apache's htcacheclean utility.
  403. Example:
  405. ```elixir
  406. config :pleroma, Pleroma.Web.MediaProxy.Invalidation.Script,
  407.   script_path: "./installation/nginx-cache-purge.example"
  408. ```
  410. #### Pleroma.Web.MediaProxy.Invalidation.Http
  412. This strategy allow perform custom http request to purge cache.
  414. * `method`: http method. default is `purge`
  415. * `headers`: http headers.
  416. * `options`: request options.
  418. Example:
  419. ```elixir
  420. config :pleroma, Pleroma.Web.MediaProxy.Invalidation.Http,
  421.   method: :purge,
  422.   headers: [],
  423.   options: []
  424. ```
  426. ## Link previews
  428. ### Pleroma.Web.Metadata (provider)
  429. * `providers`: a list of metadata providers to enable. Providers available:
  430.     * `Pleroma.Web.Metadata.Providers.OpenGraph`
  431.     * `Pleroma.Web.Metadata.Providers.TwitterCard`
  432. * `unfurl_nsfw`: If set to `true` nsfw attachments will be shown in previews.
  434. ### :rich_media (consumer)
  435. * `enabled`: if enabled the instance will parse metadata from attached links to generate link previews.
  436. * `ignore_hosts`: list of hosts which will be ignored by the metadata parser. For example `["accounts.google.com", "xss.website"]`, defaults to `[]`.
  437. * `ignore_tld`: list TLDs (top-level domains) which will ignore for parse metadata. default is ["local", "localdomain", "lan"].
  438. * `parsers`: list of Rich Media parsers.
  439. * `timeout`: Amount of milliseconds after which the HTTP request is forcibly terminated.
  441. ## HTTP server
  443. ### Pleroma.Web.Endpoint
  445. !!! note
  446.     `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.
  448. * `http` - a list containing http protocol configuration, all configuration options can be viewed [here](https://hexdocs.pm/plug_cowboy/Plug.Cowboy.html#module-options), only common options are listed here. For deployment using docker, you need to set this to `[ip: {0,0,0,0}, port: 4000]` to make pleroma accessible from other containers (such as your nginx server).
  449.   - `ip` - a tuple consisting of 4 integers
  450.   - `port`
  451. * `url` - a list containing the configuration for generating urls, accepts
  452.   - `host` - the host without the scheme and a post (e.g `example.com`, not `https://example.com:2020`)
  453.   - `scheme` - e.g `http`, `https`
  454.   - `port`
  455.   - `path`
  456. * `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.
  458. Example:
  459. ```elixir
  460. config :pleroma, Pleroma.Web.Endpoint,
  461.   url: [host: "example.com", port: 2020, scheme: "https"],
  462.   http: [
  463.     port: 8080,
  464.     ip: {127, 0, 0, 1}
  465.   ]
  466. ```
  468. This will make Pleroma listen on `127.0.0.1` port `8080` and generate urls starting with `https://example.com:2020`
  470. ### :http_security
  471. * ``enabled``: Whether the managed content security policy is enabled.
  472. * ``sts``: Whether to additionally send a `Strict-Transport-Security` header.
  473. * ``sts_max_age``: The maximum age for the `Strict-Transport-Security` header if sent.
  474. * ``ct_max_age``: The maximum age for the `Expect-CT` header if sent.
  475. * ``referrer_policy``: The referrer policy to use, either `"same-origin"` or `"no-referrer"`.
  476. * ``report_uri``: Adds the specified url to `report-uri` and `report-to` group in CSP header.
  477. * `allow_unsafe_eval`: Adds `wasm-unsafe-eval` to the CSP header. Needed for some non-essential frontend features like Flash emulation.
  479. ### Pleroma.Web.Plugs.RemoteIp
  481. !!! warning
  482.     If your instance is not behind at least one reverse proxy, you should not enable this plug.
  484. `Pleroma.Web.Plugs.RemoteIp` is a shim to call [`RemoteIp`](https://git.pleroma.social/pleroma/remote_ip) but with runtime configuration.
  486. Available options:
  488. * `enabled` - Enable/disable the plug. Defaults to `false`.
  489. * `headers` - A list of strings naming the HTTP headers to use when deriving the true client IP address. Defaults to `["x-forwarded-for"]`.
  490. * `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.
  491. * `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"]`.
  494. ### :rate_limit
  496. !!! note
  497.    If your instance is behind a reverse proxy ensure [`Pleroma.Web.Plugs.RemoteIp`](#pleroma-plugs-remoteip) is enabled (it is enabled by default).
  499. 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:
  501. * The first element: `scale` (Integer). The time scale in milliseconds.
  502. * The second element: `limit` (Integer). How many requests to limit in the time scale provided.
  504. 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.
  506. For example:
  508. ```elixir
  509. config :pleroma, :rate_limit,
  510.   authentication: {60_000, 15},
  511.   search: [{1000, 10}, {1000, 30}]
  512. ```
  514. Means that:
  516. 1. In 60 seconds, 15 authentication attempts can be performed from the same IP address.
  517. 2. In 1 second, 10 search requests can be performed from the same IP address by unauthenticated users, while authenticated users can perform 30 search requests per second.
  519. Supported rate limiters:
  521. * `:search` - Account/Status search.
  522. * `:timeline` - Timeline requests (each timeline has it's own limiter).
  523. * `:app_account_creation` - Account registration from the API.
  524. * `:relations_actions` - Following/Unfollowing in general.
  525. * `:relation_id_action` - Following/Unfollowing for a specific user.
  526. * `:statuses_actions` - Status actions such as: (un)repeating, (un)favouriting, creating, deleting.
  527. * `:status_id_action` - (un)Repeating/(un)Favouriting a particular status.
  528. * `:authentication` - Authentication actions, i.e getting an OAuth token.
  529. * `:password_reset` - Requesting password reset emails.
  530. * `:account_confirmation_resend` - Requesting resending account confirmation emails.
  531. * `:ap_routes` - Requesting statuses via ActivityPub.
  533. ### :web_cache_ttl
  535. The expiration time for the web responses cache. Values should be in milliseconds or `nil` to disable expiration.
  537. Available caches:
  539. * `:activity_pub` - activity pub routes (except question activities). Defaults to `nil` (no expiration).
  540. * `:activity_pub_question` - activity pub routes (question activities). Defaults to `30_000` (30 seconds).
  542. ## HTTP client
  544. ### :http
  546. * `proxy_url`: an upstream proxy to fetch posts and/or media with, (default: `nil`)
  547. * `send_user_agent`: should we include a user agent with HTTP requests? (default: `true`)
  548. * `user_agent`: what user agent should we use? (default: `:default`), must be string or `:default`
  549. * `adapter`: array of adapter options
  551. ### :hackney_pools
  553. Advanced. Tweaks Hackney (http client) connections pools.
  555. There's three pools used:
  557. * `:federation` for the federation jobs.
  558.   You may want this pool max_connections to be at least equal to the number of federator jobs + retry queue jobs.
  559. * `:media` for rich media, media proxy
  560. * `:upload` for uploaded media (if using a remote uploader and `proxy_remote: true`)
  562. For each pool, the options are:
  564. * `max_connections` - how much connections a pool can hold
  565. * `timeout` - retention duration for connections
  568. ### :connections_pool
  570. *For `gun` adapter*
  572. Settings for HTTP connection pool.
  574. * `:connection_acquisition_wait` - Timeout to acquire a connection from pool.The total max time is this value multiplied by the number of retries.
  575. * `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.
  576. * `:max_connections` - Maximum number of connections in the pool.
  577. * `:connect_timeout` - Timeout to connect to the host.
  578. * `: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.
  580. ### :pools
  582. *For `gun` adapter*
  584. Settings for request pools. These pools are limited on top of `:connections_pool`.
  586. There are four pools used:
  588. * `: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.
  589. * `:media` - for rich media, media proxy.
  590. * `:upload` - for proxying media when a remote uploader is used and `proxy_remote: true`.
  591. * `:default` - for other requests.
  593. For each pool, the options are:
  595. * `:size` - limit to how much requests can be concurrently executed.
  596. * `:recv_timeout` - timeout while `gun` will wait for response
  597. * `:max_waiting` - limit to how much requests can be waiting for others to finish, after this is reached, subsequent requests will be dropped.
  599. ## Captcha
  601. ### Pleroma.Captcha
  603. * `enabled`: Whether the captcha should be shown on registration.
  604. * `method`: The method/service to use for captcha.
  605. * `seconds_valid`: The time in seconds for which the captcha is valid.
  607. ### Captcha providers
  609. #### Pleroma.Captcha.Native
  611. A built-in captcha provider. Enabled by default.
  613. #### Pleroma.Captcha.Kocaptcha
  615. Kocaptcha is a very simple captcha service with a single API endpoint,
  616. the source code is here: [kocaptcha](https://github.com/koto-bank/kocaptcha). The default endpoint
  617. `https://captcha.kotobank.ch` is hosted by the developer.
  619. * `endpoint`: the Kocaptcha endpoint to use.
  621. ## Uploads
  623. ### Pleroma.Upload
  625. * `uploader`: Which one of the [uploaders](#uploaders) to use.
  626. * `filters`: List of [upload filters](#upload-filters) to use.
  627. * `link_name`: When enabled Pleroma will add a `name` parameter to the url of the upload, for example `https://instance.tld/media/corndog.png?name=corndog.png`. This is needed to provide the correct filename in Content-Disposition headers when using filters like `Pleroma.Upload.Filter.Dedupe`
  628. * `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.
  629. * `proxy_remote`: If you're using a remote uploader, Pleroma will proxy media requests instead of redirecting to it.
  630. * `proxy_opts`: Proxy options, see `Pleroma.ReverseProxy` documentation.
  631. * `filename_display_max_length`: Set max length of a filename to display. 0 = no limit. Default: 30.
  632. * `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
  634. !!! warning
  635.     `strip_exif` has been replaced by `Pleroma.Upload.Filter.Mogrify`.
  637. ### Uploaders
  639. #### Pleroma.Uploaders.Local
  641. * `uploads`: Which directory to store the user-uploads in, relative to pleroma’s working directory.
  643. #### Pleroma.Uploaders.S3
  645. Don't forget to configure [Ex AWS S3](#ex-aws-s3-settings)
  647. * `bucket`: S3 bucket name.
  648. * `bucket_namespace`: S3 bucket namespace.
  649. * `truncated_namespace`: If you use S3 compatible service such as Digital Ocean Spaces or CDN, set folder name or "" etc.
  650. * `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.
  652. #### Ex AWS S3 settings
  654. * `access_key_id`: Access key ID
  655. * `secret_access_key`: Secret access key
  656. * `host`: S3 host
  658. Example:
  660. ```elixir
  661. config :ex_aws, :s3,
  662.   access_key_id: "xxxxxxxxxx",
  663.   secret_access_key: "yyyyyyyyyy",
  664.   host: "s3.eu-central-1.amazonaws.com"
  665. ```
  667. #### Pleroma.Uploaders.IPFS
  669. * `post_gateway_url`: URL with port of POST Gateway (unauthenticated)
  670. * `get_gateway_url`: URL of public GET Gateway
  672. Example:
  674. ```elixir
  675. config :pleroma, Pleroma.Uploaders.IPFS,
  676.   post_gateway_url: "http://localhost:5001",
  677.   get_gateway_url: "http://{CID}.ipfs.mydomain.com"
  678. ```
  680. ### Upload filters
  682. #### Pleroma.Upload.Filter.AnonymizeFilename
  684. This filter replaces the filename (not the path) of an upload. For complete obfuscation, add
  685. `Pleroma.Upload.Filter.Dedupe` before AnonymizeFilename.
  687. * `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}`.
  689. #### Pleroma.Upload.Filter.Dedupe
  691. No specific configuration.
  693. #### Pleroma.Upload.Filter.Exiftool.StripLocation
  695. This filter only strips the GPS and location metadata with Exiftool leaving color profiles and attributes intact.
  697. No specific configuration.
  699. #### Pleroma.Upload.Filter.Exiftool.ReadDescription
  701. This filter reads the ImageDescription and iptc:Caption-Abstract fields with Exiftool so clients can prefill the media description field.
  703. No specific configuration.
  705. #### Pleroma.Upload.Filter.OnlyMedia
  707. This filter rejects uploads that are not identified with Content-Type matching audio/\*, image/\*, or video/\*
  709. No specific configuration.
  711. #### Pleroma.Upload.Filter.Mogrify
  713. * `args`: List of actions for the `mogrify` command like `"strip"` or `["strip", "auto-orient", {"implode", "1"}]`.
  715. ## Email
  717. ### Pleroma.Emails.Mailer
  718. * `adapter`: one of the mail adapters listed in [Swoosh readme](https://github.com/swoosh/swoosh#adapters), or `Swoosh.Adapters.Local` for in-memory mailbox.
  719. * `api_key` / `password` and / or other adapter-specific settings, per the above documentation.
  720. * `enabled`: Allows enable/disable send  emails. Default: `false`.
  722. An example for Sendgrid adapter:
  724. ```elixir
  725. config :pleroma, Pleroma.Emails.Mailer,
  726.   enabled: true,
  727.   adapter: Swoosh.Adapters.Sendgrid,
  728.   api_key: "YOUR_API_KEY"
  729. ```
  731. An example for SMTP adapter:
  733. ```elixir
  734. config :pleroma, Pleroma.Emails.Mailer,
  735.   enabled: true,
  736.   adapter: Swoosh.Adapters.SMTP,
  737.   relay: "smtp.gmail.com",
  738.   username: "YOUR_USERNAME@gmail.com",
  739.   password: "YOUR_SMTP_PASSWORD",
  740.   port: 465,
  741.   ssl: true,
  742.   auth: :always
  743. ```
  745. An example for Mua adapter:
  747. ```elixir
  748. config :pleroma, Pleroma.Emails.Mailer,
  749.   enabled: true,
  750.   adapter: Swoosh.Adapters.Mua,
  751.   relay: "mail.example.com",
  752.   port: 465,
  753.   auth: [
  754.     username: "YOUR_USERNAME@domain.tld",
  755.     password: "YOUR_SMTP_PASSWORD"
  756.   ],
  757.   protocol: :ssl
  758. ```
  760. ### :email_notifications
  762. Email notifications settings.
  764.   - digest - emails of "what you've missed" for users who have been
  765.     inactive for a while.
  766.     - active: globally enable or disable digest emails
  767.     - schedule: When to send digest email, in [crontab format](https://en.wikipedia.org/wiki/Cron).
  768.       "0 0 * * 0" is the default, meaning "once a week at midnight on Sunday morning"
  769.     - interval: Minimum interval between digest emails to one user
  770.     - inactivity_threshold: Minimum user inactivity threshold
  772. ### Pleroma.Emails.UserEmail
  774. - `:logo` - a path to a custom logo. Set it to `nil` to use the default Pleroma logo.
  775. - `:styling` - a map with color settings for email templates.
  777. ### Pleroma.Emails.NewUsersDigestEmail
  779. - `:enabled` - a boolean, enables new users admin digest email when `true`. Defaults to `false`.
  781. ## Background jobs
  783. ### Oban
  785. [Oban](https://github.com/sorentwo/oban) asynchronous job processor configuration.
  787. Configuration options described in [Oban readme](https://github.com/sorentwo/oban#usage):
  789. * `repo` - app's Ecto repo (`Pleroma.Repo`)
  790. * `log` - logs verbosity
  791. * `queues` - job queues (see below)
  792. * `crontab` - periodic jobs, see [`Oban.Cron`](#obancron)
  794. Pleroma has the following queues:
  796. * `activity_expiration` - Activity expiration
  797. * `federator_outgoing` - Outgoing federation
  798. * `federator_incoming` - Incoming federation
  799. * `mailer` - Email sender, see [`Pleroma.Emails.Mailer`](#pleromaemailsmailer)
  800. * `transmogrifier` - Transmogrifier
  801. * `web_push` - Web push notifications
  802. * `scheduled_activities` - Scheduled activities, see [`Pleroma.ScheduledActivity`](#pleromascheduledactivity)
  804. #### Oban.Cron
  806. Pleroma has these periodic job workers:
  808. * `Pleroma.Workers.Cron.DigestEmailsWorker` - digest emails for users with new mentions and follows
  809. * `Pleroma.Workers.Cron.NewUsersDigestWorker` - digest emails for admins with new registrations
  811. ```elixir
  812. config :pleroma, Oban,
  813.   repo: Pleroma.Repo,
  814.   verbose: false,
  815.   prune: {:maxlen, 1500},
  816.   queues: [
  817.     federator_incoming: 50,
  818.     federator_outgoing: 50
  819.   ],
  820.   crontab: [
  821.     {"0 0 * * 0", Pleroma.Workers.Cron.DigestEmailsWorker},
  822.     {"0 0 * * *", Pleroma.Workers.Cron.NewUsersDigestWorker}
  823.   ]
  824. ```
  826. This config contains two queues: `federator_incoming` and `federator_outgoing`. Both have the number of max concurrent jobs set to `50`.
  828. #### Migrating `pleroma_job_queue` settings
  830. `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).
  832. ### :workers
  834. Includes custom worker options not interpretable directly by `Oban`.
  836. * `retries` — keyword lists where keys are `Oban` queues (see above) and values are numbers of max attempts for failed jobs.
  838. Example:
  840. ```elixir
  841. config :pleroma, :workers,
  842.   retries: [
  843.     federator_incoming: 5,
  844.     federator_outgoing: 5
  845.   ]
  846. ```
  848. #### Migrating `Pleroma.Web.Federator.RetryQueue` settings
  850. * `max_retries` is replaced with `config :pleroma, :workers, retries: [federator_outgoing: 5]`
  851. * `enabled: false` corresponds to `config :pleroma, :workers, retries: [federator_outgoing: 1]`
  852. * deprecated options: `max_jobs`, `initial_timeout`
  854. ## :web_push_encryption, :vapid_details
  856. Web Push Notifications configuration. You can use the mix task `mix web_push.gen.keypair` to generate it.
  858. * ``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.
  859. * ``public_key``: VAPID public key
  860. * ``private_key``: VAPID private key
  862. ## :logger
  863. * `backends`: `:console` is used to send logs to stdout, `{ExSyslogger, :ex_syslogger}` to log to syslog
  865. An example to enable ONLY ExSyslogger (f/ex in ``prod.secret.exs``) with info and debug suppressed:
  866. ```elixir
  867. config :logger,
  868.   backends: [{ExSyslogger, :ex_syslogger}]
  870. config :logger, :ex_syslogger,
  871.   level: :warning
  872. ```
  874. Another example, keeping console output and adding the pid to syslog output:
  875. ```elixir
  876. config :logger,
  877.   backends: [:console, {ExSyslogger, :ex_syslogger}]
  879. config :logger, :ex_syslogger,
  880.   level: :warning,
  881.   option: [:pid, :ndelay]
  882. ```
  884. See: [logger’s documentation](https://hexdocs.pm/logger/Logger.html) and [ex_syslogger’s documentation](https://hexdocs.pm/ex_syslogger/)
  886. An example of logging info to local syslog, but debug to console:
  887. ```elixir
  888. config :logger,
  889.   backends: [ {ExSyslogger, :ex_syslogger}, :console ],
  890.   level: :info
  892. config :logger, :ex_syslogger,
  893.   level: :info,
  894.   ident: "pleroma",
  895.   format: "$metadata[$level] $message"
  897. config :logger, :console,
  898.   level: :debug,
  899.   format: "\n$time $metadata[$level] $message\n",
  900.   metadata: [:request_id]
  901. ```
  905. ## Database options
  907. ### RUM indexing for full text search
  909. !!! warning
  910.     It is recommended to use PostgreSQL v11 or newer. We have seen some minor issues with lower PostgreSQL versions.
  912. * `rum_enabled`: If RUM indexes should be used. Defaults to `false`.
  914. 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.
  916. 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.
  918. To enable them, both the `rum_enabled` flag has to be set and the following special migration has to be run:
  920. `mix ecto.migrate --migrations-path priv/repo/optional_migrations/rum_indexing/`
  922. This will probably take a long time.
  924. ## Alternative client protocols
  926. ### BBS / SSH access
  928. This feature has been removed from Pleroma core.
  929. However, a client has been made and is available at https://git.pleroma.social/Duponin/sshocial.
  931. ### :gopher
  932. * `enabled`: Enables the gopher interface
  933. * `ip`: IP address to bind to
  934. * `port`: Port to bind to
  935. * `dstport`: Port advertised in urls (optional, defaults to `port`)
  938. ## Authentication
  940. ### :admin_token
  942. 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:
  944. ```elixir
  945. config :pleroma, :admin_token, "somerandomtoken"
  946. ```
  948. You can then do
  950. ```shell
  951. curl "http://localhost:4000/api/v1/pleroma/admin/users/invites?admin_token=somerandomtoken"
  952. ```
  954. or
  956. ```shell
  957. curl -H "X-Admin-Token: somerandomtoken" "http://localhost:4000/api/v1/pleroma/admin/users/invites"
  958. ```
  960. 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.
  962. ### :auth
  964. Authentication / authorization settings.
  966. * `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`.
  967. * `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`.
  968. * `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>`).
  970. ### Pleroma.Web.Auth.Authenticator
  972. * `Pleroma.Web.Auth.PleromaAuthenticator`: default database authenticator.
  973. * `Pleroma.Web.Auth.LDAPAuthenticator`: LDAP authentication.
  975. ### :ldap
  977. Use LDAP for user authentication.  When a user logs in to the Pleroma
  978. instance, the name and password will be verified by trying to authenticate
  979. (bind) to an LDAP server.  If a user exists in the LDAP directory but there
  980. is no account with the same name yet on the Pleroma instance then a new
  981. Pleroma account will be created with the same name as the LDAP user name.
  983. * `enabled`: enables LDAP authentication
  984. * `host`: LDAP server hostname
  985. * `port`: LDAP port, e.g. 389 or 636
  986. * `ssl`: true to use implicit SSL/TLS, usually port 636
  987. * `sslopts`: additional SSL options
  988. * `tls`: true to use explicit TLS (STARTTLS), usually port 389
  989. * `tlsopts`: additional TLS options
  990. * `base`: LDAP base, e.g. "dc=example,dc=com"
  991. * `uid`: LDAP attribute name to authenticate the user, e.g. when "cn", the filter will be "cn=username,base"
  992. * `cacertfile`: Path to alternate CA root certificates file
  994. Note, if your LDAP server is an Active Directory server the correct value is commonly `uid: "cn"`, but if you use an
  995. OpenLDAP server the value may be `uid: "uid"`.
  997. ### :oauth2 (Pleroma as OAuth 2.0 provider settings)
  999. OAuth 2.0 provider settings:
  1001. * `token_expires_in` - The lifetime in seconds of the access token.
  1002. * `issue_new_refresh_token` - Keeps old refresh token or generate new refresh token when to obtain an access token.
  1003. * `clean_expired_tokens` - Enable a background job to clean expired oauth tokens. Defaults to `false`.
  1005. OAuth 2.0 provider and related endpoints:
  1007. * `POST /api/v1/apps` creates client app basing on provided params.
  1008. * `GET/POST /oauth/authorize` renders/submits authorization form.
  1009. * `POST /oauth/token` creates/renews OAuth token.
  1010. * `POST /oauth/revoke` revokes provided OAuth token.
  1011. * `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).
  1013. ### OAuth consumer mode
  1015. OAuth consumer mode allows sign in / sign up via external OAuth providers (e.g. Twitter, Facebook, Google, Microsoft, etc.).
  1016. Implementation is based on Ueberauth; see the list of [available strategies](https://github.com/ueberauth/ueberauth/wiki/List-of-Strategies).
  1018. !!! note
  1019.     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.
  1021. !!! note
  1022.     Each strategy requires separate setup (on external provider side and Pleroma side). Below are the guidelines on setting up most popular strategies.
  1024. !!! note
  1025.     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"`
  1027. * For Twitter, [register an app](https://developer.twitter.com/en/apps), configure callback URL to https://<your_host>/oauth/twitter/callback
  1029. * 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/
  1031. * For Google, [register an app](https://console.developers.google.com), configure callback URL to https://<your_host>/oauth/google/callback
  1033. * For Microsoft, [register an app](https://portal.azure.com), configure callback URL to https://<your_host>/oauth/microsoft/callback
  1035. 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`,
  1036. per strategy's documentation (e.g. [ueberauth_twitter](https://github.com/ueberauth/ueberauth_twitter)). Example config basing on environment variables:
  1038. ```elixir
  1039. # Twitter
  1040. config :ueberauth, Ueberauth.Strategy.Twitter.OAuth,
  1041.   consumer_key: System.get_env("TWITTER_CONSUMER_KEY"),
  1042.   consumer_secret: System.get_env("TWITTER_CONSUMER_SECRET")
  1044. # Facebook
  1045. config :ueberauth, Ueberauth.Strategy.Facebook.OAuth,
  1046.   client_id: System.get_env("FACEBOOK_APP_ID"),
  1047.   client_secret: System.get_env("FACEBOOK_APP_SECRET"),
  1048.   redirect_uri: System.get_env("FACEBOOK_REDIRECT_URI")
  1050. # Google
  1051. config :ueberauth, Ueberauth.Strategy.Google.OAuth,
  1052.   client_id: System.get_env("GOOGLE_CLIENT_ID"),
  1053.   client_secret: System.get_env("GOOGLE_CLIENT_SECRET"),
  1054.   redirect_uri: System.get_env("GOOGLE_REDIRECT_URI")
  1056. # Microsoft
  1057. config :ueberauth, Ueberauth.Strategy.Microsoft.OAuth,
  1058.   client_id: System.get_env("MICROSOFT_CLIENT_ID"),
  1059.   client_secret: System.get_env("MICROSOFT_CLIENT_SECRET")
  1061. config :ueberauth, Ueberauth,
  1062.   providers: [
  1063.     microsoft: {Ueberauth.Strategy.Microsoft, [callback_params: []]}
  1064.   ]
  1066. # Keycloak
  1067. # Note: make sure to add `keycloak:ueberauth_keycloak_strategy` entry to `OAUTH_CONSUMER_STRATEGIES` environment variable
  1068. keycloak_url = "https://publicly-reachable-keycloak-instance.org:8080"
  1070. config :ueberauth, Ueberauth.Strategy.Keycloak.OAuth,
  1071.   client_id: System.get_env("KEYCLOAK_CLIENT_ID"),
  1072.   client_secret: System.get_env("KEYCLOAK_CLIENT_SECRET"),
  1073.   site: keycloak_url,
  1074.   authorize_url: "#{keycloak_url}/auth/realms/master/protocol/openid-connect/auth",
  1075.   token_url: "#{keycloak_url}/auth/realms/master/protocol/openid-connect/token",
  1076.   userinfo_url: "#{keycloak_url}/auth/realms/master/protocol/openid-connect/userinfo",
  1077.   token_method: :post
  1079. config :ueberauth, Ueberauth,
  1080.   providers: [
  1081.     keycloak: {Ueberauth.Strategy.Keycloak, [uid_field: :email]}
  1082.   ]
  1083. ```
  1085. ## Link parsing
  1087. ### :uri_schemes
  1088. * `valid_schemes`: List of the scheme part that is considered valid to be an URL.
  1090. ### Pleroma.Formatter
  1092. Configuration for Pleroma's link formatter which parses mentions, hashtags, and URLs.
  1094. * `class` - specify the class to be added to the generated link (default: `false`)
  1095. * `rel` - specify the rel attribute (default: `ugc`)
  1096. * `new_window` - adds `target="_blank"` attribute (default: `false`)
  1097. * `truncate` - Set to a number to truncate URLs longer then the number. Truncated URLs will end in `...` (default: `false`)
  1098. * `strip_prefix` - Strip the scheme prefix (default: `false`)
  1099. * `extra` - link URLs with rarely used schemes (magnet, ipfs, irc, etc.) (default: `true`)
  1100. * `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`)
  1102. Example:
  1104. ```elixir
  1105. config :pleroma, Pleroma.Formatter,
  1106.   class: false,
  1107.   rel: "ugc",
  1108.   new_window: false,
  1109.   truncate: false,
  1110.   strip_prefix: false,
  1111.   extra: true,
  1112.   validate_tld: :no_scheme
  1113. ```
  1115. ## Custom Runtime Modules (`:modules`)
  1117. * `runtime_dir`: A path to custom Elixir modules (such as MRF policies).
  1119. ## :configurable_from_database
  1121. Boolean, enables/disables in-database configuration. Read [Transferring the config to/from the database](../administration/CLI_tasks/config.md) for more information.
  1123. ## :database_config_whitelist
  1125. List of valid configuration sections which are allowed to be configured from the
  1126. database. Settings stored in the database before the whitelist is configured are
  1127. still applied, so it is suggested to only use the whitelist on instances that
  1128. have not migrated the config to the database.
  1130. Example:
  1131. ```elixir
  1132. config :pleroma, :database_config_whitelist, [
  1133.   {:pleroma, :instance},
  1134.   {:pleroma, Pleroma.Web.Metadata},
  1135.   {:auto_linker}
  1136. ]
  1137. ```
  1139. ### Multi-factor authentication -  :two_factor_authentication
  1140. * `totp` - a list containing TOTP configuration
  1141.   - `digits` - Determines the length of a one-time pass-code in characters. Defaults to 6 characters.
  1142.   - `period` - a period for which the TOTP code will be valid in seconds. Defaults to 30 seconds.
  1143. * `backup_codes` - a list containing backup codes configuration
  1144.   - `number` - number of backup codes to generate.
  1145.   - `length` - backup code length. Defaults to 16 characters.
  1147. ## Restrict entities access for unauthenticated users
  1149. ### :restrict_unauthenticated
  1151. Restrict access for unauthenticated users to timelines (public and federated), user profiles and statuses.
  1153. * `timelines`: public and federated timelines
  1154.   * `local`: public timeline
  1155.   * `federated`: federated timeline (includes public timeline)
  1156. * `profiles`: user profiles
  1157.   * `local`
  1158.   * `remote`
  1159. * `activities`: statuses
  1160.   * `local`
  1161.   * `remote`
  1163. 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`.
  1165. 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).
  1167. ## Pleroma.Web.ApiSpec.CastAndValidate
  1169. * `:strict` a boolean, enables strict input validation (useful in development, not recommended in production). Defaults to `false`.
  1171. ## :instances_favicons
  1173. Control favicons for instances.
  1175. * `enabled`: Allow/disallow displaying and getting instances favicons
  1177. ## Pleroma.User.Backup
  1179. !!! note
  1180.     Requires enabled email
  1182. * `:purge_after_days` an integer, remove backup achieves after N days.
  1183. * `:limit_days` an integer, limit user to export not more often than once per N days.
  1184. * `:dir` a string with a path to backup temporary directory or `nil` to let Pleroma choose temporary directory in the following order:
  1185.     1. the directory named by the TMPDIR environment variable
  1186.     2. the directory named by the TEMP environment variable
  1187.     3. the directory named by the TMP environment variable
  1188.     4. C:\TMP on Windows or /tmp on Unix-like operating systems
  1189.     5. as a last resort, the current working directory
  1190. * `:timeout` an integer representing seconds
  1192. ## Frontend management
  1194. Frontends in Pleroma are swappable - you can specify which one to use here.
  1196. You can set a frontends for the key `primary` and `admin` and the options of `name` and `ref`. This will then make Pleroma serve the frontend from a folder constructed by concatenating the instance static path, `frontends` and the name and ref.
  1198. The key `primary` refers to the frontend that will be served by default for general requests. The key `admin` refers to the frontend that will be served at the `/pleroma/admin` path.
  1200. If you don't set anything here, the bundled frontends will be used.
  1202. Example:
  1204. ```
  1205. config :pleroma, :frontends,
  1206.   primary: %{
  1207.     "name" => "pleroma",
  1208.     "ref" => "stable"
  1209.   },
  1210.   admin: %{
  1211.     "name" => "admin",
  1212.     "ref" => "develop"
  1213.   }
  1214. ```
  1216. This would serve the frontend from the the folder at `$instance_static/frontends/pleroma/stable`. You have to copy the frontend into this folder yourself. You can choose the name and ref any way you like, but they will be used by mix tasks to automate installation in the future, the name referring to the project and the ref referring to a commit.
  1218. ## Ephemeral activities (Pleroma.Workers.PurgeExpiredActivity)
  1220. Settings to enable and configure expiration for ephemeral activities
  1222. * `:enabled` - enables ephemeral activities creation
  1223. * `:min_lifetime` - minimum lifetime for ephemeral activities (in seconds). Default: 10 minutes.
  1225. ## ConcurrentLimiter
  1227. Settings to restrict concurrently running jobs. Jobs which can be configured:
  1229. * `Pleroma.Web.RichMedia.Helpers` - generating link previews of URLs in activities
  1230. * `Pleroma.Web.ActivityPub.MRF.MediaProxyWarmingPolicy` - warming remote media cache via MediaProxyWarmingPolicy
  1232. Each job has these settings:
  1234. * `:max_running` - max concurrently runnings jobs
  1235. * `:max_waiting` - max waiting jobs