36d7f1273ce05e435bee3854b432f9f22e681ed2
[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, and `Quack.Logger` to log to Slack
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 An example of logging info to local syslog, but warn to a Slack channel:
132 ```
133 config :logger,
134 backends: [ {ExSyslogger, :ex_syslogger}, Quack.Logger ],
135 level: :info
136
137 config :logger, :ex_syslogger,
138 level: :info,
139 ident: "pleroma",
140 format: "$metadata[$level] $message"
141
142 config :quack,
143 level: :warn,
144 meta: [:all],
145 webhook_url: "https://hooks.slack.com/services/YOUR-API-KEY-HERE"
146 ```
147
148 See the [Quack Github](https://github.com/azohra/quack) for more details
149
150 ## :frontend_configurations
151
152 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.
153
154 Frontends can access these settings at `/api/pleroma/frontend_configurations`
155
156 To add your own configuration for PleromaFE, use it like this:
157
158 `config :pleroma, :frontend_configurations, pleroma_fe: %{redirectRootNoLogin: "/main/all", ...}`
159
160 These settings need to be complete, they will override the defaults. See `priv/static/static/config.json` for the available keys.
161
162 ## :fe
163 __THIS IS DEPRECATED__
164
165 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`.
166
167 This section is used to configure Pleroma-FE, unless ``:managed_config`` in ``:instance`` is set to false.
168
169 * `theme`: Which theme to use, they are defined in ``styles.json``
170 * `logo`: URL of the logo, defaults to Pleroma’s logo
171 * `logo_mask`: Whether to use only the logo's shape as a mask (true) or as a regular image (false)
172 * `logo_margin`: What margin to use around the logo
173 * `background`: URL of the background, unless viewing a user profile with a background that is set
174 * `redirect_root_no_login`: relative URL which indicates where to redirect when a user isn’t logged in.
175 * `redirect_root_login`: relative URL which indicates where to redirect when a user is logged in.
176 * `show_instance_panel`: Whenether to show the instance’s specific panel.
177 * `scope_options_enabled`: Enable setting an notice visibility and subject/CW when posting
178 * `formatting_options_enabled`: Enable setting a formatting different than plain-text (ie. HTML, Markdown) when posting, relates to ``:instance, allowed_post_formats``
179 * `collapse_message_with_subjects`: When a message has a subject(aka Content Warning), collapse it by default
180 * `hide_post_stats`: Hide notices statistics(repeats, favorites, …)
181 * `hide_user_stats`: Hide profile statistics(posts, posts per day, followers, followings, …)
182
183 ## :mrf_simple
184 * `media_removal`: List of instances to remove medias from
185 * `media_nsfw`: List of instances to put medias as NSFW(sensitive) from
186 * `federated_timeline_removal`: List of instances to remove from Federated (aka The Whole Known Network) Timeline
187 * `reject`: List of instances to reject any activities from
188 * `accept`: List of instances to accept any activities from
189
190 ## :mrf_rejectnonpublic
191 * `allow_followersonly`: whether to allow followers-only posts
192 * `allow_direct`: whether to allow direct messages
193
194 ## :mrf_hellthread
195 * `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.
196 * `reject_threshold`: Number of mentioned users after which the messaged gets rejected. Set to 0 to disable.
197
198 ## :mrf_keyword
199 * `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)
200 * `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)
201 * `replace`: A list of tuples containing `{pattern, replacement}`, `pattern` can be a string or a [regular expression](https://hexdocs.pm/elixir/Regex.html)
202
203 ## :media_proxy
204 * `enabled`: Enables proxying of remote media to the instance’s proxy
205 * `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.
206 * `proxy_opts`: All options defined in `Pleroma.ReverseProxy` documentation, defaults to `[max_body_length: (25*1_048_576)]`.
207
208 ## :gopher
209 * `enabled`: Enables the gopher interface
210 * `ip`: IP address to bind to
211 * `port`: Port to bind to
212 * `dstport`: Port advertised in urls (optional, defaults to `port`)
213
214 ## Pleroma.Web.Endpoint
215 `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
216 * `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
217 - `ip` - a tuple consisting of 4 integers
218 - `port`
219 * `url` - a list containing the configuration for generating urls, accepts
220 - `host` - the host without the scheme and a post (e.g `example.com`, not `https://example.com:2020`)
221 - `scheme` - e.g `http`, `https`
222 - `port`
223 - `path`
224
225
226 **Important note**: if you modify anything inside these lists, default `config.exs` values will be overwritten, which may result in breakage, to make sure this does not happen please copy the default value for the list from `config.exs` and modify/add only what you need
227
228 Example:
229 ```elixir
230 config :pleroma, Pleroma.Web.Endpoint,
231 url: [host: "example.com", port: 2020, scheme: "https"],
232 http: [
233 # start copied from config.exs
234 dispatch: [
235 {:_,
236 [
237 {"/api/v1/streaming", Pleroma.Web.MastodonAPI.WebsocketHandler, []},
238 {"/websocket", Phoenix.Endpoint.CowboyWebSocket,
239 {Phoenix.Transports.WebSocket,
240 {Pleroma.Web.Endpoint, Pleroma.Web.UserSocket, websocket_config}}},
241 {:_, Phoenix.Endpoint.Cowboy2Handler, {Pleroma.Web.Endpoint, []}}
242 ]}
243 # end copied from config.exs
244 ],
245 port: 8080,
246 ip: {127, 0, 0, 1}
247 ]
248 ```
249
250 This will make Pleroma listen on `127.0.0.1` port `8080` and generate urls starting with `https://example.com:2020`
251
252 ## :activitypub
253 * ``accept_blocks``: Whether to accept incoming block activities from other instances
254 * ``unfollow_blocked``: Whether blocks result in people getting unfollowed
255 * ``outgoing_blocks``: Whether to federate blocks to other instances
256 * ``deny_follow_blocked``: Whether to disallow following an account that has blocked the user in question
257
258 ## :http_security
259 * ``enabled``: Whether the managed content security policy is enabled
260 * ``sts``: Whether to additionally send a `Strict-Transport-Security` header
261 * ``sts_max_age``: The maximum age for the `Strict-Transport-Security` header if sent
262 * ``ct_max_age``: The maximum age for the `Expect-CT` header if sent
263 * ``referrer_policy``: The referrer policy to use, either `"same-origin"` or `"no-referrer"`.
264
265 ## :mrf_user_allowlist
266
267 The keys in this section are the domain names that the policy should apply to.
268 Each key should be assigned a list of users that should be allowed through by
269 their ActivityPub ID.
270
271 An example:
272
273 ```exs
274 config :pleroma, :mrf_user_allowlist,
275 "example.org": ["https://example.org/users/admin"]
276 ```
277
278 ## :web_push_encryption, :vapid_details
279
280 Web Push Notifications configuration. You can use the mix task `mix web_push.gen.keypair` to generate it.
281
282 * ``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.
283 * ``public_key``: VAPID public key
284 * ``private_key``: VAPID private key
285
286 ## Pleroma.Captcha
287 * `enabled`: Whether the captcha should be shown on registration
288 * `method`: The method/service to use for captcha
289 * `seconds_valid`: The time in seconds for which the captcha is valid
290
291 ### Pleroma.Captcha.Kocaptcha
292 Kocaptcha is a very simple captcha service with a single API endpoint,
293 the source code is here: https://github.com/koto-bank/kocaptcha. The default endpoint
294 `https://captcha.kotobank.ch` is hosted by the developer.
295
296 * `endpoint`: the kocaptcha endpoint to use
297
298 ## :admin_token
299
300 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:
301
302 ```exs
303 config :pleroma, :admin_token, "somerandomtoken"
304 ```
305
306 You can then do
307
308 ```sh
309 curl "http://localhost:4000/api/pleroma/admin/invite_token?admin_token=somerandomtoken"
310 ```
311
312 ## :pleroma_job_queue
313
314 [Pleroma Job Queue](https://git.pleroma.social/pleroma/pleroma_job_queue) configuration: a list of queues with maximum concurrent jobs.
315
316 Pleroma has the following queues:
317 * `federator_outgoing` - Outgoing federation
318 * `federator_incoming` - Incoming federation
319 * `mailer` - Email sender, see [`Pleroma.Mailer`](#pleroma-mailer)
320
321 Example:
322
323 ```elixir
324 config :pleroma_job_queue, :queues,
325 federator_incoming: 50,
326 federator_outgoing: 50
327 ```
328
329 This config contains two queues: `federator_incoming` and `federator_outgoing`. Both have the `max_jobs` set to `50`.
330
331 ## Pleroma.Web.Federator.RetryQueue
332
333 * `enabled`: If set to `true`, failed federation jobs will be retried
334 * `max_jobs`: The maximum amount of parallel federation jobs running at the same time.
335 * `initial_timeout`: The initial timeout in seconds
336 * `max_retries`: The maximum number of times a federation job is retried
337
338 ## Pleroma.Web.Metadata
339 * `providers`: a list of metadata providers to enable. Providers availible:
340 * Pleroma.Web.Metadata.Providers.OpenGraph
341 * Pleroma.Web.Metadata.Providers.TwitterCard
342 * `unfurl_nsfw`: If set to `true` nsfw attachments will be shown in previews
343
344 ## :rich_media
345 * `enabled`: if enabled the instance will parse metadata from attached links to generate link previews
346
347 ## :fetch_initial_posts
348 * `enabled`: if enabled, when a new user is federated with, fetch some of their latest posts
349 * `pages`: the amount of pages to fetch
350
351 ## :hackney_pools
352
353 Advanced. Tweaks Hackney (http client) connections pools.
354
355 There's three pools used:
356
357 * `:federation` for the federation jobs.
358 You may want this pool max_connections to be at least equal to the number of federator jobs + retry queue jobs.
359 * `:media` for rich media, media proxy
360 * `:upload` for uploaded media (if using a remote uploader and `proxy_remote: true`)
361
362 For each pool, the options are:
363
364 * `max_connections` - how much connections a pool can hold
365 * `timeout` - retention duration for connections
366
367 ## :auto_linker
368
369 Configuration for the `auto_linker` library:
370
371 * `class: "auto-linker"` - specify the class to be added to the generated link. false to clear
372 * `rel: "noopener noreferrer"` - override the rel attribute. false to clear
373 * `new_window: true` - set to false to remove `target='_blank'` attribute
374 * `scheme: false` - Set to true to link urls with schema `http://google.com`
375 * `truncate: false` - Set to a number to truncate urls longer then the number. Truncated urls will end in `..`
376 * `strip_prefix: true` - Strip the scheme prefix
377 * `extra: false` - link urls with rarely used schemes (magnet, ipfs, irc, etc.)
378
379 Example:
380
381 ```exs
382 config :auto_linker,
383 opts: [
384 scheme: true,
385 extra: true,
386 class: false,
387 strip_prefix: false,
388 new_window: false,
389 rel: false
390 ]
391 ```
392
393 ## :ldap
394
395 Use LDAP for user authentication. When a user logs in to the Pleroma
396 instance, the name and password will be verified by trying to authenticate
397 (bind) to an LDAP server. If a user exists in the LDAP directory but there
398 is no account with the same name yet on the Pleroma instance then a new
399 Pleroma account will be created with the same name as the LDAP user name.
400
401 * `enabled`: enables LDAP authentication
402 * `host`: LDAP server hostname
403 * `port`: LDAP port, e.g. 389 or 636
404 * `ssl`: true to use SSL, usually implies the port 636
405 * `sslopts`: additional SSL options
406 * `tls`: true to start TLS, usually implies the port 389
407 * `tlsopts`: additional TLS options
408 * `base`: LDAP base, e.g. "dc=example,dc=com"
409 * `uid`: LDAP attribute name to authenticate the user, e.g. when "cn", the filter will be "cn=username,base"
410
411 ## Pleroma.Web.Auth.Authenticator
412
413 * `Pleroma.Web.Auth.PleromaAuthenticator`: default database authenticator
414 * `Pleroma.Web.Auth.LDAPAuthenticator`: LDAP authentication
415
416 ## :auth
417
418 Authentication / authorization settings.
419
420 * `oauth_consumer_strategies`: lists enabled OAuth consumer strategies; by default it's set by OAUTH_CONSUMER_STRATEGIES environment variable.
421
422 OAuth consumer mode allows sign in / sign up via external OAuth providers (e.g. Twitter, Facebook, Google, Microsoft, etc.).
423 Implementation is based on Ueberauth; see the list of [available strategies](https://github.com/ueberauth/ueberauth/wiki/List-of-Strategies).
424
425 Note: each strategy is shipped as a separate dependency; in order to get the strategies, run `OAUTH_CONSUMER_STRATEGIES="..." mix deps.get`,
426 e.g. `OAUTH_CONSUMER_STRATEGIES="twitter facebook google microsoft" mix deps.get`.
427 The server should also be started with `OAUTH_CONSUMER_STRATEGIES="..." mix phx.server` in case you enable any strategies.
428
429 Note: each strategy requires separate setup (on external provider side and Pleroma side). Below are the guidelines on setting up most popular strategies.
430
431 * For Twitter, [register an app](https://developer.twitter.com/en/apps), configure callback URL to https://<your_host>/oauth/twitter/callback
432
433 * 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/
434
435 * For Google, [register an app](https://console.developers.google.com), configure callback URL to https://<your_host>/oauth/google/callback
436
437 * For Microsoft, [register an app](https://portal.azure.com), configure callback URL to https://<your_host>/oauth/microsoft/callback
438
439 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`,
440 per strategy's documentation (e.g. [ueberauth_twitter](https://github.com/ueberauth/ueberauth_twitter)). Example config basing on environment variables:
441
442 ```
443 # Twitter
444 config :ueberauth, Ueberauth.Strategy.Twitter.OAuth,
445 consumer_key: System.get_env("TWITTER_CONSUMER_KEY"),
446 consumer_secret: System.get_env("TWITTER_CONSUMER_SECRET")
447
448 # Facebook
449 config :ueberauth, Ueberauth.Strategy.Facebook.OAuth,
450 client_id: System.get_env("FACEBOOK_APP_ID"),
451 client_secret: System.get_env("FACEBOOK_APP_SECRET"),
452 redirect_uri: System.get_env("FACEBOOK_REDIRECT_URI")
453
454 # Google
455 config :ueberauth, Ueberauth.Strategy.Google.OAuth,
456 client_id: System.get_env("GOOGLE_CLIENT_ID"),
457 client_secret: System.get_env("GOOGLE_CLIENT_SECRET"),
458 redirect_uri: System.get_env("GOOGLE_REDIRECT_URI")
459
460 # Microsoft
461 config :ueberauth, Ueberauth.Strategy.Microsoft.OAuth,
462 client_id: System.get_env("MICROSOFT_CLIENT_ID"),
463 client_secret: System.get_env("MICROSOFT_CLIENT_SECRET")
464
465 config :ueberauth, Ueberauth,
466 providers: [
467 microsoft: {Ueberauth.Strategy.Microsoft, [callback_params: []]}
468 ]
469 ```