config.md 14.5 KB
Newer Older
Haelwenn's avatar
Haelwenn committed
1 2
# Configuration

3 4 5
This file describe the configuration, it is recommended to edit the relevant *.secret.exs file instead of the others founds in the ``config`` directory.
If you run Pleroma with ``MIX_ENV=prod`` the file is ``prod.secret.exs``, otherwise it is ``dev.secret.exs``.

Haelwenn's avatar
Haelwenn committed
6 7
## Pleroma.Upload
* `uploader`: Select which `Pleroma.Uploaders` to use
href's avatar
href committed
8 9
* `filters`: List of `Pleroma.Upload.Filter` to use.
* `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.
href's avatar
href committed
11 12 13
* `proxy_opts`: Proxy options, see `Pleroma.ReverseProxy` documentation.

Note: `strip_exif` has been replaced by `Pleroma.Upload.Filter.Mogrify`.
Haelwenn's avatar
Haelwenn committed
14 15

## Pleroma.Uploaders.Local
Haelwenn's avatar
Haelwenn committed
16
* `uploads`: Which directory to store the user-uploads in, relative to pleroma’s working directory
href's avatar
href committed
17 18 19

## Pleroma.Upload.Filter.Mogrify

20
* `args`: List of actions for the `mogrify` command like `"strip"` or `["strip", "auto-orient", {"impode", "1"}]`.
Haelwenn's avatar
Haelwenn committed
21

22 23 24 25 26 27
## Pleroma.Upload.Filter.Dedupe

No specific configuration.

## Pleroma.Upload.Filter.AnonymizeFilename

href's avatar
href committed
28
This filter replaces the filename (not the path) of an upload. For complete obfuscation, add
29 30
`Pleroma.Upload.Filter.Dedupe` before AnonymizeFilename.

href's avatar
href committed
31
* `text`: Text to replace filenames in links. If empty, `{random}.extension` will be used.
32

33 34
## Pleroma.Mailer
* `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 38

An example for Sendgrid adapter:

minibikini's avatar
minibikini committed
39
```exs
40 41 42 43 44 45
config :pleroma, Pleroma.Mailer,
  adapter: Swoosh.Adapters.Sendgrid,
  api_key: "YOUR_API_KEY"
```

An example for SMTP adapter:
minibikini's avatar
minibikini committed
46 47

```exs
48 49 50 51 52 53 54 55 56 57 58
config :pleroma, Pleroma.Mailer,
  adapter: Swoosh.Adapters.SMTP,
  relay: "smtp.gmail.com",
  username: "YOUR_USERNAME@gmail.com",
  password: "YOUR_SMTP_PASSWORD",
  port: 465,
  ssl: true,
  tls: :always,
  auth: :always
```

Haelwenn's avatar
Haelwenn committed
59
## :uri_schemes
Haelwenn's avatar
Haelwenn committed
60 61
* `valid_schemes`: List of the scheme part that is considered valid to be an URL

Haelwenn's avatar
Haelwenn committed
62
## :instance
63
* `name`: The instance’s name
Haelwenn's avatar
Haelwenn committed
64
* `email`: Email used to reach an Administrator/Moderator of the instance
65 66
* `description`: The instance’s description, can be seen in nodeinfo and ``/api/v1/instance``
* `limit`: Posts character limit (CW/Subject included in the counter)
67
* `remote_limit`: Hard character limit beyond which remote posts will be dropped.
Haelwenn's avatar
Haelwenn committed
68 69 70
* `upload_limit`: File size limit of uploads (except for avatar, background, banner)
* `avatar_upload_limit`: File size limit of user’s profile avatars
* `background_upload_limit`: File size limit of user’s profile backgrounds
71
* `banner_upload_limit`: File size limit of user’s profile banners
72 73
* `registrations_open`: Enable registrations for anyone, invitations can be enabled when false.
* `invites_enabled`: Enable user invitations for admins (depends on `registrations_open: false`).
74
* `account_activation_required`: Require users to confirm their emails before signing in.
75
* `federating`: Enable federation with other instances
76
* `federation_reachability_timeout_days`: Timeout (in days) of each external federation target being unreachable prior to pausing federating to it.
77
* `allow_relay`: Enable Pleroma’s Relay, which makes it possible to follow a whole instance
78 79 80 81 82
* `rewrite_policy`: Message Rewrite Policy, either one or a list. Here are the ones available by default:
  * `Pleroma.Web.ActivityPub.MRF.NoOpPolicy`: Doesn’t modify activities (default)
  * `Pleroma.Web.ActivityPub.MRF.DropPolicy`: Drops all activities. It generally doesn’t makes sense to use in production
  * `Pleroma.Web.ActivityPub.MRF.SimplePolicy`: Restrict the visibility of activities from certains instances (See ``:mrf_simple`` section)
  * `Pleroma.Web.ActivityPub.MRF.RejectNonPublic`: Drops posts with non-public visibility settings (See ``:mrf_rejectnonpublic`` section)
83
  * `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:.
84
* `public`: Makes the client API in authentificated mode-only except for user-profiles. Useful for disabling the Local Timeline and The Whole Known Network.
Haelwenn's avatar
Haelwenn committed
85 86 87
* `quarantined_instances`: List of ActivityPub instances where private(DMs, followers-only) activities will not be send.
* `managed_config`: Whenether the config for pleroma-fe is configured in this config or in ``static/config.json``
* `allowed_post_formats`: MIME-type list of formats allowed to be posted (transformed into HTML)
88
* `finmoji_enabled`: Whenether to enable the finmojis in the custom emojis.
Haelwenn's avatar
Haelwenn committed
89
* `mrf_transparency`: Make the content of your Message Rewrite Facility settings public (via nodeinfo).
scarlett's avatar
scarlett committed
90 91 92 93 94 95
* `scope_copy`: Copy the scope (private/unlisted/public) in replies to posts by default.
* `subject_line_behavior`: Allows changing the default behaviour of subject lines in replies. Valid values:
  * "email": Copy and preprend re:, as in email.
  * "masto": Copy verbatim, as in Mastodon.
  * "noop": Don't copy the subject.
* `always_show_subject_input`: When set to false, auto-hide the subject field when it's empty.
href's avatar
href committed
96
* `extended_nickname_format`: Set to `true` to use extended local nicknames format (allows underscores/dashes). This will break federation with
href's avatar
href committed
97
    older software for theses nicknames.
98
* `max_pinned_statuses`: The maximum number of pinned statuses. `0` will disable the feature.
99
* `autofollowed_nicknames`: Set to nicknames of (local) users that every new user should automatically follow.
feld's avatar
feld committed
100
* `no_attachment_links`: Set to true to disable automatically adding attachment link text to statuses
lain's avatar
lain committed
101
* `welcome_message`: A message that will be send to a newly registered users as a direct message.
102
* `welcome_user_nickname`: The nickname of the local user that sends the welcome message.
minibikini's avatar
Reports  
minibikini committed
103
* `max_report_size`: The maximum size of the report comment (Default: `1000`)
Haelwenn's avatar
Haelwenn committed
104

105 106
## :logger
* `backends`: `:console` is used to send logs to stdout, `{ExSyslogger, :ex_syslogger}` to log to syslog
107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126

An example to enable ONLY ExSyslogger (f/ex in ``prod.secret.exs``) with info and debug suppressed:
```
config :logger, 
  backends: [{ExSyslogger, :ex_syslogger}]

config :logger, :ex_syslogger,
  level: :warn
```

Another example, keeping console output and adding the pid to syslog output:
```
config :logger,
  backends: [:console, {ExSyslogger, :ex_syslogger}]

config :logger, :ex_syslogger,
  level: :warn,
  option: [:pid, :ndelay]
```

127 128
See: [logger’s documentation](https://hexdocs.pm/logger/Logger.html) and [ex_syslogger’s documentation](https://hexdocs.pm/ex_syslogger/)

lain's avatar
lain committed
129 130 131 132 133 134 135 136 137

## :frontend_configurations

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.

Frontends can access these settings at `/api/pleroma/frontend_configurations`

To add your own configuration for PleromaFE, use it like this:

138
`config :pleroma, :frontend_configurations, pleroma_fe: %{redirectRootNoLogin: "/main/all", ...}`
lain's avatar
lain committed
139

140
These settings need to be complete, they will override the defaults. See `priv/static/static/config.json` for the available keys.
lain's avatar
lain committed
141

Haelwenn's avatar
Haelwenn committed
142
## :fe
lain's avatar
lain committed
143
__THIS IS DEPRECATED__
lain's avatar
lain committed
144

lain's avatar
lain committed
145
If you are using this method, please change it to the `frontend_configurations` method. Please set this option to false in your config like this: `config :pleroma, :fe, false`.
lain's avatar
lain committed
146

147 148 149 150
This section is used to configure Pleroma-FE, unless ``:managed_config`` in ``:instance`` is set to false.

* `theme`: Which theme to use, they are defined in ``styles.json``
* `logo`: URL of the logo, defaults to Pleroma’s logo
151
* `logo_mask`: Whether to use only the logo's shape as a mask (true) or as a regular image (false)
152 153 154 155 156
* `logo_margin`: What margin to use around the logo
* `background`: URL of the background, unless viewing a user profile with a background that is set
* `redirect_root_no_login`: relative URL which indicates where to redirect when a user isn’t logged in.
* `redirect_root_login`: relative URL which indicates where to redirect when a user is logged in.
* `show_instance_panel`: Whenether to show the instance’s specific panel.
157
* `scope_options_enabled`: Enable setting an notice visibility and subject/CW when posting
Haelwenn's avatar
Haelwenn committed
158 159 160 161 162 163 164 165 166 167 168 169
* `formatting_options_enabled`: Enable setting a formatting different than plain-text (ie. HTML, Markdown) when posting, relates to ``:instance, allowed_post_formats``
* `collapse_message_with_subjects`: When a message has a subject(aka Content Warning), collapse it by default
* `hide_post_stats`: Hide notices statistics(repeats, favorites, …)
* `hide_user_stats`: Hide profile statistics(posts, posts per day, followers, followings, …)

## :mrf_simple
* `media_removal`: List of instances to remove medias from
* `media_nsfw`: List of instances to put medias as NSFW(sensitive) from
* `federated_timeline_removal`: List of instances to remove from Federated (aka The Whole Known Network) Timeline
* `reject`: List of instances to reject any activities from
* `accept`: List of instances to accept any activities from

170 171 172 173
## :mrf_rejectnonpublic
* `allow_followersonly`: whether to allow followers-only posts
* `allow_direct`: whether to allow direct messages

Karen Konou's avatar
Karen Konou committed
174
## :mrf_hellthread
Karen Konou's avatar
Karen Konou committed
175
* `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.
Karen Konou's avatar
Karen Konou committed
176
* `reject_threshold`: Number of mentioned users after which the messaged gets rejected. Set to 0 to disable.
Karen Konou's avatar
Karen Konou committed
177

rinpatch's avatar
rinpatch committed
178 179
## :mrf_keyword
* `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)
rinpatch's avatar
rinpatch committed
180
* `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)
rinpatch's avatar
rinpatch committed
181
* `replace`: A list of tuples containing `{pattern, replacement}`, `pattern` can be a string or a [regular expression](https://hexdocs.pm/elixir/Regex.html)
rinpatch's avatar
rinpatch committed
182

Haelwenn's avatar
Haelwenn committed
183 184
## :media_proxy
* `enabled`: Enables proxying of remote media to the instance’s proxy
href's avatar
href committed
185 186
* `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.
* `proxy_opts`: All options defined in `Pleroma.ReverseProxy` documentation, defaults to `[max_body_length: (25*1_048_576)]`.
Haelwenn's avatar
Haelwenn committed
187 188 189 190 191

## :gopher
* `enabled`: Enables the gopher interface
* `ip`: IP address to bind to
* `port`: Port to bind to
192 193 194 195 196 197

## :activitypub
* ``accept_blocks``: Whether to accept incoming block activities from other instances
* ``unfollow_blocked``: Whether blocks result in people getting unfollowed
* ``outgoing_blocks``: Whether to federate blocks to other instances
* ``deny_follow_blocked``: Whether to disallow following an account that has blocked the user in question
198

kaniini's avatar
kaniini committed
199
## :http_security
200 201 202
* ``enabled``: Whether the managed content security policy is enabled
* ``sts``: Whether to additionally send a `Strict-Transport-Security` header
* ``sts_max_age``: The maximum age for the `Strict-Transport-Security` header if sent
kaniini's avatar
kaniini committed
203
* ``ct_max_age``: The maximum age for the `Expect-CT` header if sent
204
* ``referrer_policy``: The referrer policy to use, either `"same-origin"` or `"no-referrer"`.
kaniini's avatar
kaniini committed
205 206 207 208 209 210 211 212 213

## :mrf_user_allowlist

The keys in this section are the domain names that the policy should apply to.
Each key should be assigned a list of users that should be allowed through by
their ActivityPub ID.

An example:

minibikini's avatar
minibikini committed
214
```exs
kaniini's avatar
kaniini committed
215 216 217
config :pleroma, :mrf_user_allowlist,
  "example.org": ["https://example.org/users/admin"]
```
218

Haelwenn's avatar
Haelwenn committed
219
## :web_push_encryption, :vapid_details
220

lain's avatar
lain committed
221
Web Push Notifications configuration. You can use the mix task `mix web_push.gen.keypair` to generate it.
222 223 224 225

* ``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.
* ``public_key``: VAPID public key
* ``private_key``: VAPID private key
226 227 228 229

## Pleroma.Captcha
* `enabled`: Whether the captcha should be shown on registration
* `method`: The method/service to use for captcha
vaartis's avatar
vaartis committed
230
* `seconds_valid`: The time in seconds for which the captcha is valid
231 232 233

### Pleroma.Captcha.Kocaptcha
Kocaptcha is a very simple captcha service with a single API endpoint,
234 235
the source code is here: https://github.com/koto-bank/kocaptcha. The default endpoint
`https://captcha.kotobank.ch` is hosted by the developer.
236

237 238 239 240 241 242
* `endpoint`: the kocaptcha endpoint to use

## :admin_token

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:

minibikini's avatar
minibikini committed
243
```exs
244 245 246 247
config :pleroma, :admin_token, "somerandomtoken"
```

You can then do
minibikini's avatar
minibikini committed
248 249

```sh
250 251
curl "http://localhost:4000/api/pleroma/admin/invite_token?admin_token=somerandomtoken"
```
lain's avatar
lain committed
252

minibikini's avatar
minibikini committed
253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269
## Pleroma.Jobs

A list of job queues and their settings.

Job queue settings:

* `max_jobs`: The maximum amount of parallel jobs running at the same time.

Example:

```exs
config :pleroma, Pleroma.Jobs,
  federator_incoming: [max_jobs: 50],
  federator_outgoing: [max_jobs: 50]
```

This config contains two queues: `federator_incoming` and `federator_outgoing`. Both have the `max_jobs` set to `50`.
lain's avatar
lain committed
270 271 272 273 274


## Pleroma.Web.Federator.RetryQueue

* `enabled`: If set to `true`, failed federation jobs will be retried
scarlett's avatar
scarlett committed
275
* `max_jobs`: The maximum amount of parallel federation jobs running at the same time.
lain's avatar
lain committed
276 277
* `initial_timeout`: The initial timeout in seconds
* `max_retries`: The maximum number of times a federation job is retried
rinpatch's avatar
rinpatch committed
278 279

## Pleroma.Web.Metadata
280
* `providers`: a list of metadata providers to enable. Providers availible:
rinpatch's avatar
rinpatch committed
281 282
  * Pleroma.Web.Metadata.Providers.OpenGraph
  * Pleroma.Web.Metadata.Providers.TwitterCard
283
* `unfurl_nsfw`: If set to `true` nsfw attachments will be shown in previews
href's avatar
href committed
284

rinpatch's avatar
rinpatch committed
285 286 287
## :rich_media
* `enabled`: if enabled the instance will parse metadata from attached links to generate link previews

href's avatar
href committed
288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303
## :hackney_pools

Advanced. Tweaks Hackney (http client) connections pools.

There's three pools used:

* `:federation` for the federation jobs.
  You may want this pool max_connections to be at least equal to the number of federator jobs + retry queue jobs.
* `:media` for rich media, media proxy
* `:upload` for uploaded media (if using a remote uploader and `proxy_remote: true`)

For each pool, the options are:

* `max_connections` - how much connections a pool can hold
* `timeout` - retention duration for connections