git.squeep.com Git - akkoma/blob - docs/config.md

   1 # Configuration
   2
   3 This file describe the configuration, it is recommended to edit the relevant *.secret.exs file instead of the others founds in the ``config`` directory.
   4 If you run Pleroma with ``MIX_ENV=prod`` the file is ``prod.secret.exs``, otherwise it is ``dev.secret.exs``.
   5
   6 ## Pleroma.Upload
   7 * `uploader`: Select which `Pleroma.Uploaders` to use
   8 * `filters`: List of `Pleroma.Upload.Filter` to use.
   9 * `base_url`: The base URL to access a user-uploaded file. Useful when you want to proxy the media files via another host.
  10 * `proxy_remote`: If you\'re using a remote uploader, Pleroma will proxy media requests instead of redirecting to it.
  11 * `proxy_opts`: Proxy options, see `Pleroma.ReverseProxy` documentation.
  12
  13 Note: `strip_exif` has been replaced by `Pleroma.Upload.Filter.Mogrify`.
  14
  15 ## Pleroma.Uploaders.Local
  16 * `uploads`: Which directory to store the user-uploads in, relative to pleroma’s working directory
  17
  18 ## Pleroma.Upload.Filter.Mogrify
  19
  20 * `args`: List of actions for the `mogrify` command like `"strip"` or `["strip", {"impode", "1"}]`.
  21
  22 ## Pleroma.Upload.Filter.Dedupe
  23
  24 No specific configuration.
  25
  26 ## Pleroma.Upload.Filter.AnonymizeFilename
  27
  28 This filter replaces the filename (not the path) of an upload. For complete obfuscation, add
  29 `Pleroma.Upload.Filter.Dedupe` before AnonymizeFilename.
  30
  31 * `text`: Text to replace filenames in links. If empty, `{random}.extension` will be used.
  32
  33 ## Pleroma.Mailer
  34 * `adapter`: one of the mail adapters listed in [Swoosh readme](https://github.com/swoosh/swoosh#adapters), or `Swoosh.Adapters.Local` for in-memory mailbox.
  35 * `api_key` / `password` and / or other adapter-specific settings, per the above documentation.
  36
  37 An example for Sendgrid adapter:
  38
  39 ```
  40 config :pleroma, Pleroma.Mailer,
  41   adapter: Swoosh.Adapters.Sendgrid,
  42   api_key: "YOUR_API_KEY"
  43 ```
  44
  45 An example for SMTP adapter:
  46 ```
  47 config :pleroma, Pleroma.Mailer,
  48   adapter: Swoosh.Adapters.SMTP,
  49   relay: "smtp.gmail.com",
  50   username: "YOUR_USERNAME@gmail.com",
  51   password: "YOUR_SMTP_PASSWORD",
  52   port: 465,
  53   ssl: true,
  54   tls: :always,
  55   auth: :always
  56 ```
  57
  58 ## :uri_schemes
  59 * `valid_schemes`: List of the scheme part that is considered valid to be an URL
  60
  61 ## :instance
  62 * `name`: The instance’s name
  63 * `email`: Email used to reach an Administrator/Moderator of the instance
  64 * `description`: The instance’s description, can be seen in nodeinfo and ``/api/v1/instance``
  65 * `limit`: Posts character limit (CW/Subject included in the counter)
  66 * `remote_limit`: Hard character limit beyond which remote posts will be dropped.
  67 * `upload_limit`: File size limit of uploads (except for avatar, background, banner)
  68 * `avatar_upload_limit`: File size limit of user’s profile avatars
  69 * `background_upload_limit`: File size limit of user’s profile backgrounds
  70 * `banner_upload_limit`: File size limit of user’s profile banners
  71 * `registrations_open`: Enable registrations for anyone, invitations can be enabled when false.
  72 * `invites_enabled`: Enable user invitations for admins (depends on `registrations_open: false`).
  73 * `account_activation_required`: Require users to confirm their emails before signing in.
  74 * `federating`: Enable federation with other instances
  75 * `allow_relay`: Enable Pleroma’s Relay, which makes it possible to follow a whole instance
  76 * `rewrite_policy`: Message Rewrite Policy, either one or a list. Here are the ones available by default:
  77   * `Pleroma.Web.ActivityPub.MRF.NoOpPolicy`: Doesn’t modify activities (default)
  78   * `Pleroma.Web.ActivityPub.MRF.DropPolicy`: Drops all activities. It generally doesn’t makes sense to use in production
  79   * `Pleroma.Web.ActivityPub.MRF.SimplePolicy`: Restrict the visibility of activities from certains instances (See ``:mrf_simple`` section)
  80   * `Pleroma.Web.ActivityPub.MRF.RejectNonPublic`: Drops posts with non-public visibility settings (See ``:mrf_rejectnonpublic`` section)
  81   * `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:.
  82 * `public`: Makes the client API in authentificated mode-only except for user-profiles. Useful for disabling the Local Timeline and The Whole Known Network.
  83 * `quarantined_instances`: List of ActivityPub instances where private(DMs, followers-only) activities will not be send.
  84 * `managed_config`: Whenether the config for pleroma-fe is configured in this config or in ``static/config.json``
  85 * `allowed_post_formats`: MIME-type list of formats allowed to be posted (transformed into HTML)
  86 * `finmoji_enabled`: Whenether to enable the finmojis in the custom emojis.
  87 * `mrf_transparency`: Make the content of your Message Rewrite Facility settings public (via nodeinfo).
  88 * `scope_copy`: Copy the scope (private/unlisted/public) in replies to posts by default.
  89 * `subject_line_behavior`: Allows changing the default behaviour of subject lines in replies. Valid values:
  90   * "email": Copy and preprend re:, as in email.
  91   * "masto": Copy verbatim, as in Mastodon.
  92   * "noop": Don't copy the subject.
  93 * `always_show_subject_input`: When set to false, auto-hide the subject field when it's empty.
  94 * `extended_nickname_format`: Set to `true` to use extended local nicknames format (allows underscores/dashes). This will break federation with
  95     older software for theses nicknames.
  96 * `max_pinned_statuses`: The maximum number of pinned statuses. `0` will disable the feature.
  97 * `autofollowed_nicknames`: Set to nicknames of (local) users that every new user should automatically follow.
  98
  99 ## :logger
 100 * `backends`: `:console` is used to send logs to stdout, `{ExSyslogger, :ex_syslogger}` to log to syslog
 101 See: [logger’s documentation](https://hexdocs.pm/logger/Logger.html) and [ex_syslogger’s documentation](https://hexdocs.pm/ex_syslogger/)
 102
 103 ## :fe
 104 This section is used to configure Pleroma-FE, unless ``:managed_config`` in ``:instance`` is set to false.
 105
 106 * `theme`: Which theme to use, they are defined in ``styles.json``
 107 * `logo`: URL of the logo, defaults to Pleroma’s logo
 108 * `logo_mask`: Whenether to mask the logo
 109 * `logo_margin`: What margin to use around the logo
 110 * `background`: URL of the background, unless viewing a user profile with a background that is set
 111 * `redirect_root_no_login`: relative URL which indicates where to redirect when a user isn’t logged in.
 112 * `redirect_root_login`: relative URL which indicates where to redirect when a user is logged in.
 113 * `show_instance_panel`: Whenether to show the instance’s specific panel.
 114 * `scope_options_enabled`: Enable setting an notice visibility and subject/CW when posting
 115 * `formatting_options_enabled`: Enable setting a formatting different than plain-text (ie. HTML, Markdown) when posting, relates to ``:instance, allowed_post_formats``
 116 * `collapse_message_with_subjects`: When a message has a subject(aka Content Warning), collapse it by default
 117 * `hide_post_stats`: Hide notices statistics(repeats, favorites, …)
 118 * `hide_user_stats`: Hide profile statistics(posts, posts per day, followers, followings, …)
 119
 120 ## :mrf_simple
 121 * `media_removal`: List of instances to remove medias from
 122 * `media_nsfw`: List of instances to put medias as NSFW(sensitive) from
 123 * `federated_timeline_removal`: List of instances to remove from Federated (aka The Whole Known Network) Timeline
 124 * `reject`: List of instances to reject any activities from
 125 * `accept`: List of instances to accept any activities from
 126
 127 ## :mrf_rejectnonpublic
 128 * `allow_followersonly`: whether to allow followers-only posts
 129 * `allow_direct`: whether to allow direct messages
 130
 131 ## :mrf_hellthread
 132 * `threshold`: Number of mentioned users after which the message gets discarded as spam
 133
 134 ## :media_proxy
 135 * `enabled`: Enables proxying of remote media to the instance’s proxy
 136 * `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.
 137 * `proxy_opts`: All options defined in `Pleroma.ReverseProxy` documentation, defaults to `[max_body_length: (25*1_048_576)]`.
 138
 139 ## :gopher
 140 * `enabled`: Enables the gopher interface
 141 * `ip`: IP address to bind to
 142 * `port`: Port to bind to
 143
 144 ## :activitypub
 145 * ``accept_blocks``: Whether to accept incoming block activities from other instances
 146 * ``unfollow_blocked``: Whether blocks result in people getting unfollowed
 147 * ``outgoing_blocks``: Whether to federate blocks to other instances
 148 * ``deny_follow_blocked``: Whether to disallow following an account that has blocked the user in question
 149
 150 ## :http_security
 151 * ``enabled``: Whether the managed content security policy is enabled
 152 * ``sts``: Whether to additionally send a `Strict-Transport-Security` header
 153 * ``sts_max_age``: The maximum age for the `Strict-Transport-Security` header if sent
 154 * ``ct_max_age``: The maximum age for the `Expect-CT` header if sent
 155 * ``referrer_policy``: The referrer policy to use, either `"same-origin"` or `"no-referrer"`.
 156
 157 ## :mrf_user_allowlist
 158
 159 The keys in this section are the domain names that the policy should apply to.
 160 Each key should be assigned a list of users that should be allowed through by
 161 their ActivityPub ID.
 162
 163 An example:
 164
 165 ```
 166 config :pleroma, :mrf_user_allowlist,
 167   "example.org": ["https://example.org/users/admin"]
 168 ```
 169
 170 ## :web_push_encryption, :vapid_details
 171
 172 Web Push Notifications configuration. You can use the mix task `mix web_push.gen.keypair` to generate it.
 173
 174 * ``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.
 175 * ``public_key``: VAPID public key
 176 * ``private_key``: VAPID private key
 177
 178 ## Pleroma.Captcha
 179 * `enabled`: Whether the captcha should be shown on registration
 180 * `method`: The method/service to use for captcha
 181 * `seconds_valid`: The time in seconds for which the captcha is valid
 182
 183 ### Pleroma.Captcha.Kocaptcha
 184 Kocaptcha is a very simple captcha service with a single API endpoint,
 185 the source code is here: https://github.com/koto-bank/kocaptcha. The default endpoint
 186 `https://captcha.kotobank.ch` is hosted by the developer.
 187
 188 * `endpoint`: the kocaptcha endpoint to use
 189
 190 ## :admin_token
 191
 192 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. Example:
 193
 194 ```
 195 config :pleroma, :admin_token, "somerandomtoken"
 196 ```
 197
 198 You can then do
 199 ```
 200 curl "http://localhost:4000/api/pleroma/admin/invite_token?admin_token=somerandomtoken"
 201 ```
 202
 203 ## Pleroma.Web.Federator
 204
 205 * `max_jobs`: The maximum amount of parallel federation jobs running at the same time.
 206
 207 ## Pleroma.Web.Federator.RetryQueue
 208
 209 * `enabled`: If set to `true`, failed federation jobs will be retried
 210 * `max_jobs`: The maximum amount of parallel federation jbos running at the same time.
 211 * `initial_timeout`: The initial timeout in seconds
 212 * `max_retries`: The maximum number of times a federation job is retried