c1246ee25760ef833ff2f4e5457ee41f69ab552c
[akkoma] / 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 * `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`
10 * `base_url`: The base URL to access a user-uploaded file. Useful when you want to proxy the media files via another host.
11 * `proxy_remote`: If you\'re using a remote uploader, Pleroma will proxy media requests instead of redirecting to it.
12 * `proxy_opts`: Proxy options, see `Pleroma.ReverseProxy` documentation.
13
14 Note: `strip_exif` has been replaced by `Pleroma.Upload.Filter.Mogrify`.
15
16 ## Pleroma.Uploaders.Local
17 * `uploads`: Which directory to store the user-uploads in, relative to pleroma’s working directory
18
19 ## Pleroma.Upload.Filter.Mogrify
20
21 * `args`: List of actions for the `mogrify` command like `"strip"` or `["strip", "auto-orient", {"impode", "1"}]`.
22
23 ## Pleroma.Upload.Filter.Dedupe
24
25 No specific configuration.
26
27 ## Pleroma.Upload.Filter.AnonymizeFilename
28
29 This filter replaces the filename (not the path) of an upload. For complete obfuscation, add
30 `Pleroma.Upload.Filter.Dedupe` before AnonymizeFilename.
31
32 * `text`: Text to replace filenames in links. If empty, `{random}.extension` will be used.
33
34 ## Pleroma.Mailer
35 * `adapter`: one of the mail adapters listed in [Swoosh readme](https://github.com/swoosh/swoosh#adapters), or `Swoosh.Adapters.Local` for in-memory mailbox.
36 * `api_key` / `password` and / or other adapter-specific settings, per the above documentation.
37
38 An example for Sendgrid adapter:
39
40 ```exs
41 config :pleroma, Pleroma.Mailer,
42 adapter: Swoosh.Adapters.Sendgrid,
43 api_key: "YOUR_API_KEY"
44 ```
45
46 An example for SMTP adapter:
47
48 ```exs
49 config :pleroma, Pleroma.Mailer,
50 adapter: Swoosh.Adapters.SMTP,
51 relay: "smtp.gmail.com",
52 username: "YOUR_USERNAME@gmail.com",
53 password: "YOUR_SMTP_PASSWORD",
54 port: 465,
55 ssl: true,
56 tls: :always,
57 auth: :always
58 ```
59
60 ## :uri_schemes
61 * `valid_schemes`: List of the scheme part that is considered valid to be an URL
62
63 ## :instance
64 * `name`: The instance’s name
65 * `email`: Email used to reach an Administrator/Moderator of the instance
66 * `description`: The instance’s description, can be seen in nodeinfo and ``/api/v1/instance``
67 * `limit`: Posts character limit (CW/Subject included in the counter)
68 * `remote_limit`: Hard character limit beyond which remote posts will be dropped.
69 * `upload_limit`: File size limit of uploads (except for avatar, background, banner)
70 * `avatar_upload_limit`: File size limit of user’s profile avatars
71 * `background_upload_limit`: File size limit of user’s profile backgrounds
72 * `banner_upload_limit`: File size limit of user’s profile banners
73 * `registrations_open`: Enable registrations for anyone, invitations can be enabled when false.
74 * `invites_enabled`: Enable user invitations for admins (depends on `registrations_open: false`).
75 * `account_activation_required`: Require users to confirm their emails before signing in.
76 * `federating`: Enable federation with other instances
77 * `federation_reachability_timeout_days`: Timeout (in days) of each external federation target being unreachable prior to pausing federating to it.
78 * `allow_relay`: Enable Pleroma’s Relay, which makes it possible to follow a whole instance
79 * `rewrite_policy`: Message Rewrite Policy, either one or a list. Here are the ones available by default:
80 * `Pleroma.Web.ActivityPub.MRF.NoOpPolicy`: Doesn’t modify activities (default)
81 * `Pleroma.Web.ActivityPub.MRF.DropPolicy`: Drops all activities. It generally doesn’t makes sense to use in production
82 * `Pleroma.Web.ActivityPub.MRF.SimplePolicy`: Restrict the visibility of activities from certains instances (See ``:mrf_simple`` section)
83 * `Pleroma.Web.ActivityPub.MRF.RejectNonPublic`: Drops posts with non-public visibility settings (See ``:mrf_rejectnonpublic`` section)
84 * `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:.
85 * `public`: Makes the client API in authentificated mode-only except for user-profiles. Useful for disabling the Local Timeline and The Whole Known Network.
86 * `quarantined_instances`: List of ActivityPub instances where private(DMs, followers-only) activities will not be send.
87 * `managed_config`: Whenether the config for pleroma-fe is configured in this config or in ``static/config.json``
88 * `allowed_post_formats`: MIME-type list of formats allowed to be posted (transformed into HTML)
89 * `finmoji_enabled`: Whenether to enable the finmojis in the custom emojis.
90 * `mrf_transparency`: Make the content of your Message Rewrite Facility settings public (via nodeinfo).
91 * `scope_copy`: Copy the scope (private/unlisted/public) in replies to posts by default.
92 * `subject_line_behavior`: Allows changing the default behaviour of subject lines in replies. Valid values:
93 * "email": Copy and preprend re:, as in email.
94 * "masto": Copy verbatim, as in Mastodon.
95 * "noop": Don't copy the subject.
96 * `always_show_subject_input`: When set to false, auto-hide the subject field when it's empty.
97 * `extended_nickname_format`: Set to `true` to use extended local nicknames format (allows underscores/dashes). This will break federation with
98 older software for theses nicknames.
99 * `max_pinned_statuses`: The maximum number of pinned statuses. `0` will disable the feature.
100 * `autofollowed_nicknames`: Set to nicknames of (local) users that every new user should automatically follow.
101 * `no_attachment_links`: Set to true to disable automatically adding attachment link text to statuses
102 * `welcome_message`: A message that will be send to a newly registered users as a direct message.
103 * `welcome_user_nickname`: The nickname of the local user that sends the welcome message.
104 * `max_report_comment_size`: The maximum size of the report comment (Default: `1000`)
105 * `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`)
106
107 ## :logger
108 * `backends`: `:console` is used to send logs to stdout, `{ExSyslogger, :ex_syslogger}` to log to syslog
109
110 An example to enable ONLY ExSyslogger (f/ex in ``prod.secret.exs``) with info and debug suppressed:
111 ```
112 config :logger,
113 backends: [{ExSyslogger, :ex_syslogger}]
114
115 config :logger, :ex_syslogger,
116 level: :warn
117 ```
118
119 Another example, keeping console output and adding the pid to syslog output:
120 ```
121 config :logger,
122 backends: [:console, {ExSyslogger, :ex_syslogger}]
123
124 config :logger, :ex_syslogger,
125 level: :warn,
126 option: [:pid, :ndelay]
127 ```
128
129 See: [logger’s documentation](https://hexdocs.pm/logger/Logger.html) and [ex_syslogger’s documentation](https://hexdocs.pm/ex_syslogger/)
130
131
132 ## :frontend_configurations
133
134 This can be used to configure a keyword list that keeps the configuration data for any kind of frontend. By default, settings for `pleroma_fe` and `masto_fe` are configured.
135
136 Frontends can access these settings at `/api/pleroma/frontend_configurations`
137
138 To add your own configuration for PleromaFE, use it like this:
139
140 `config :pleroma, :frontend_configurations, pleroma_fe: %{redirectRootNoLogin: "/main/all", ...}`
141
142 These settings need to be complete, they will override the defaults. See `priv/static/static/config.json` for the available keys.
143
144 ## :fe
145 __THIS IS DEPRECATED__
146
147 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`.
148
149 This section is used to configure Pleroma-FE, unless ``:managed_config`` in ``:instance`` is set to false.
150
151 * `theme`: Which theme to use, they are defined in ``styles.json``
152 * `logo`: URL of the logo, defaults to Pleroma’s logo
153 * `logo_mask`: Whether to use only the logo's shape as a mask (true) or as a regular image (false)
154 * `logo_margin`: What margin to use around the logo
155 * `background`: URL of the background, unless viewing a user profile with a background that is set
156 * `redirect_root_no_login`: relative URL which indicates where to redirect when a user isn’t logged in.
157 * `redirect_root_login`: relative URL which indicates where to redirect when a user is logged in.
158 * `show_instance_panel`: Whenether to show the instance’s specific panel.
159 * `scope_options_enabled`: Enable setting an notice visibility and subject/CW when posting
160 * `formatting_options_enabled`: Enable setting a formatting different than plain-text (ie. HTML, Markdown) when posting, relates to ``:instance, allowed_post_formats``
161 * `collapse_message_with_subjects`: When a message has a subject(aka Content Warning), collapse it by default
162 * `hide_post_stats`: Hide notices statistics(repeats, favorites, …)
163 * `hide_user_stats`: Hide profile statistics(posts, posts per day, followers, followings, …)
164
165 ## :mrf_simple
166 * `media_removal`: List of instances to remove medias from
167 * `media_nsfw`: List of instances to put medias as NSFW(sensitive) from
168 * `federated_timeline_removal`: List of instances to remove from Federated (aka The Whole Known Network) Timeline
169 * `reject`: List of instances to reject any activities from
170 * `accept`: List of instances to accept any activities from
171
172 ## :mrf_rejectnonpublic
173 * `allow_followersonly`: whether to allow followers-only posts
174 * `allow_direct`: whether to allow direct messages
175
176 ## :mrf_hellthread
177 * `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.
178 * `reject_threshold`: Number of mentioned users after which the messaged gets rejected. Set to 0 to disable.
179
180 ## :mrf_keyword
181 * `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)
182 * `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)
183 * `replace`: A list of tuples containing `{pattern, replacement}`, `pattern` can be a string or a [regular expression](https://hexdocs.pm/elixir/Regex.html)
184
185 ## :media_proxy
186 * `enabled`: Enables proxying of remote media to the instance’s proxy
187 * `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.
188 * `proxy_opts`: All options defined in `Pleroma.ReverseProxy` documentation, defaults to `[max_body_length: (25*1_048_576)]`.
189
190 ## :gopher
191 * `enabled`: Enables the gopher interface
192 * `ip`: IP address to bind to
193 * `port`: Port to bind to
194 * `dstport`: Port advertised in urls (optional, defaults to `port`)
195
196 ## :activitypub
197 * ``accept_blocks``: Whether to accept incoming block activities from other instances
198 * ``unfollow_blocked``: Whether blocks result in people getting unfollowed
199 * ``outgoing_blocks``: Whether to federate blocks to other instances
200 * ``deny_follow_blocked``: Whether to disallow following an account that has blocked the user in question
201
202 ## :http_security
203 * ``enabled``: Whether the managed content security policy is enabled
204 * ``sts``: Whether to additionally send a `Strict-Transport-Security` header
205 * ``sts_max_age``: The maximum age for the `Strict-Transport-Security` header if sent
206 * ``ct_max_age``: The maximum age for the `Expect-CT` header if sent
207 * ``referrer_policy``: The referrer policy to use, either `"same-origin"` or `"no-referrer"`.
208
209 ## :mrf_user_allowlist
210
211 The keys in this section are the domain names that the policy should apply to.
212 Each key should be assigned a list of users that should be allowed through by
213 their ActivityPub ID.
214
215 An example:
216
217 ```exs
218 config :pleroma, :mrf_user_allowlist,
219 "example.org": ["https://example.org/users/admin"]
220 ```
221
222 ## :web_push_encryption, :vapid_details
223
224 Web Push Notifications configuration. You can use the mix task `mix web_push.gen.keypair` to generate it.
225
226 * ``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.
227 * ``public_key``: VAPID public key
228 * ``private_key``: VAPID private key
229
230 ## Pleroma.Captcha
231 * `enabled`: Whether the captcha should be shown on registration
232 * `method`: The method/service to use for captcha
233 * `seconds_valid`: The time in seconds for which the captcha is valid
234
235 ### Pleroma.Captcha.Kocaptcha
236 Kocaptcha is a very simple captcha service with a single API endpoint,
237 the source code is here: https://github.com/koto-bank/kocaptcha. The default endpoint
238 `https://captcha.kotobank.ch` is hosted by the developer.
239
240 * `endpoint`: the kocaptcha endpoint to use
241
242 ## :admin_token
243
244 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:
245
246 ```exs
247 config :pleroma, :admin_token, "somerandomtoken"
248 ```
249
250 You can then do
251
252 ```sh
253 curl "http://localhost:4000/api/pleroma/admin/invite_token?admin_token=somerandomtoken"
254 ```
255
256 ## Pleroma.Jobs
257
258 A list of job queues and their settings.
259
260 Job queue settings:
261
262 * `max_jobs`: The maximum amount of parallel jobs running at the same time.
263
264 Example:
265
266 ```exs
267 config :pleroma, Pleroma.Jobs,
268 federator_incoming: [max_jobs: 50],
269 federator_outgoing: [max_jobs: 50]
270 ```
271
272 This config contains two queues: `federator_incoming` and `federator_outgoing`. Both have the `max_jobs` set to `50`.
273
274
275 ## Pleroma.Web.Federator.RetryQueue
276
277 * `enabled`: If set to `true`, failed federation jobs will be retried
278 * `max_jobs`: The maximum amount of parallel federation jobs running at the same time.
279 * `initial_timeout`: The initial timeout in seconds
280 * `max_retries`: The maximum number of times a federation job is retried
281
282 ## Pleroma.Web.Metadata
283 * `providers`: a list of metadata providers to enable. Providers availible:
284 * Pleroma.Web.Metadata.Providers.OpenGraph
285 * Pleroma.Web.Metadata.Providers.TwitterCard
286 * `unfurl_nsfw`: If set to `true` nsfw attachments will be shown in previews
287
288 ## :rich_media
289 * `enabled`: if enabled the instance will parse metadata from attached links to generate link previews
290
291 ## :fetch_initial_posts
292 * `enabled`: if enabled, when a new user is federated with, fetch some of their latest posts
293 * `pages`: the amount of pages to fetch
294
295 ## :hackney_pools
296
297 Advanced. Tweaks Hackney (http client) connections pools.
298
299 There's three pools used:
300
301 * `:federation` for the federation jobs.
302 You may want this pool max_connections to be at least equal to the number of federator jobs + retry queue jobs.
303 * `:media` for rich media, media proxy
304 * `:upload` for uploaded media (if using a remote uploader and `proxy_remote: true`)
305
306 For each pool, the options are:
307
308 * `max_connections` - how much connections a pool can hold
309 * `timeout` - retention duration for connections
310
311 ## :auto_linker
312
313 Configuration for the `auto_linker` library:
314
315 * `class: "auto-linker"` - specify the class to be added to the generated link. false to clear
316 * `rel: "noopener noreferrer"` - override the rel attribute. false to clear
317 * `new_window: true` - set to false to remove `target='_blank'` attribute
318 * `scheme: false` - Set to true to link urls with schema `http://google.com`
319 * `truncate: false` - Set to a number to truncate urls longer then the number. Truncated urls will end in `..`
320 * `strip_prefix: true` - Strip the scheme prefix
321 * `extra: false` - link urls with rarely used schemes (magnet, ipfs, irc, etc.)
322
323 Example:
324
325 ```exs
326 config :auto_linker,
327 opts: [
328 scheme: true,
329 extra: true,
330 class: false,
331 strip_prefix: false,
332 new_window: false,
333 rel: false
334 ]
335 ```
336
337 ## :ldap
338
339 Use LDAP for user authentication. When a user logs in to the Pleroma
340 instance, the name and password will be verified by trying to authenticate
341 (bind) to an LDAP server. If a user exists in the LDAP directory but there
342 is no account with the same name yet on the Pleroma instance then a new
343 Pleroma account will be created with the same name as the LDAP user name.
344
345 * `enabled`: enables LDAP authentication
346 * `host`: LDAP server hostname
347 * `port`: LDAP port, e.g. 389 or 636
348 * `ssl`: true to use SSL, usually implies the port 636
349 * `sslopts`: additional SSL options
350 * `tls`: true to start TLS, usually implies the port 389
351 * `tlsopts`: additional TLS options
352 * `base`: LDAP base, e.g. "dc=example,dc=com"
353 * `uid`: LDAP attribute name to authenticate the user, e.g. when "cn", the filter will be "cn=username,base"
354
355 ## Pleroma.Web.Auth.Authenticator
356
357 * `Pleroma.Web.Auth.PleromaAuthenticator`: default database authenticator
358 * `Pleroma.Web.Auth.LDAPAuthenticator`: LDAP authentication