config.md 23.7 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
* `filters`: List of `Pleroma.Upload.Filter` to use.
rinpatch's avatar
rinpatch committed
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`
href's avatar
href committed
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.
href's avatar
href committed
12
13
14
* `proxy_opts`: Proxy options, see `Pleroma.ReverseProxy` documentation.

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

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

## Pleroma.Upload.Filter.Mogrify

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

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

No specific configuration.

## Pleroma.Upload.Filter.AnonymizeFilename

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

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

34
## Pleroma.Emails.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
39

An example for Sendgrid adapter:

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

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

```exs
49
config :pleroma, Pleroma.Emails.Mailer,
50
51
52
53
54
55
56
57
58
59
  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
60
## :uri_schemes
Haelwenn's avatar
Haelwenn committed
61
62
* `valid_schemes`: List of the scheme part that is considered valid to be an URL

Haelwenn's avatar
Haelwenn committed
63
## :instance
64
* `name`: The instance’s name
Haelwenn's avatar
Haelwenn committed
65
* `email`: Email used to reach an Administrator/Moderator of the instance
66
* `notify_email`: Email used for notifications.
67
68
* `description`: The instance’s description, can be seen in nodeinfo and ``/api/v1/instance``
* `limit`: Posts character limit (CW/Subject included in the counter)
69
* `remote_limit`: Hard character limit beyond which remote posts will be dropped.
Haelwenn's avatar
Haelwenn committed
70
71
72
* `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
73
* `banner_upload_limit`: File size limit of user’s profile banners
74
75
* `registrations_open`: Enable registrations for anyone, invitations can be enabled when false.
* `invites_enabled`: Enable user invitations for admins (depends on `registrations_open: false`).
76
* `account_activation_required`: Require users to confirm their emails before signing in.
77
* `federating`: Enable federation with other instances
78
* `federation_reachability_timeout_days`: Timeout (in days) of each external federation target being unreachable prior to pausing federating to it.
79
* `allow_relay`: Enable Pleroma’s Relay, which makes it possible to follow a whole instance
80
81
82
83
84
* `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)
85
  * `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:.
86
* `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
87
88
89
* `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)
90
* `finmoji_enabled`: Whenether to enable the finmojis in the custom emojis.
Haelwenn's avatar
Haelwenn committed
91
* `mrf_transparency`: Make the content of your Message Rewrite Facility settings public (via nodeinfo).
scarlett's avatar
scarlett committed
92
93
94
95
96
97
* `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
98
* `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
99
    older software for theses nicknames.
100
* `max_pinned_statuses`: The maximum number of pinned statuses. `0` will disable the feature.
101
* `autofollowed_nicknames`: Set to nicknames of (local) users that every new user should automatically follow.
feld's avatar
feld committed
102
* `no_attachment_links`: Set to true to disable automatically adding attachment link text to statuses
lain's avatar
lain committed
103
* `welcome_message`: A message that will be send to a newly registered users as a direct message.
104
* `welcome_user_nickname`: The nickname of the local user that sends the welcome message.
lain's avatar
lain committed
105
106
* `max_report_comment_size`: The maximum size of the report comment (Default: `1000`)
* `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`)
Haelwenn's avatar
Haelwenn committed
107

108
## :logger
109
* `backends`: `:console` is used to send logs to stdout, `{ExSyslogger, :ex_syslogger}` to log to syslog, and `Quack.Logger` to log to Slack
110
111
112

An example to enable ONLY ExSyslogger (f/ex in ``prod.secret.exs``) with info and debug suppressed:
```
minibikini's avatar
minibikini committed
113
config :logger,
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
  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]
```

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

132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
An example of logging info to local syslog, but warn to a Slack channel:
```
config :logger,
  backends: [ {ExSyslogger, :ex_syslogger}, Quack.Logger ],
  level: :info

config :logger, :ex_syslogger,
  level: :info,
  ident: "pleroma",
  format: "$metadata[$level] $message"

config :quack,
  level: :warn,
  meta: [:all],
  webhook_url: "https://hooks.slack.com/services/YOUR-API-KEY-HERE"
```

See the [Quack Github](https://github.com/azohra/quack) for more details
lain's avatar
lain committed
150
151
152

## :frontend_configurations

Haelwenn's avatar
Haelwenn committed
153
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.
lain's avatar
lain committed
154
155
156
157
158

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

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

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

161
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
162

Haelwenn's avatar
Haelwenn committed
163
## :fe
lain's avatar
lain committed
164
__THIS IS DEPRECATED__
lain's avatar
lain committed
165

lain's avatar
lain committed
166
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
167

168
169
170
171
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
172
* `logo_mask`: Whether to use only the logo's shape as a mask (true) or as a regular image (false)
173
174
175
176
177
* `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.
178
* `scope_options_enabled`: Enable setting an notice visibility and subject/CW when posting
Haelwenn's avatar
Haelwenn committed
179
180
181
182
183
184
185
186
187
188
189
190
* `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

191
192
193
194
## :mrf_rejectnonpublic
* `allow_followersonly`: whether to allow followers-only posts
* `allow_direct`: whether to allow direct messages

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

rinpatch's avatar
rinpatch committed
199
200
## :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
201
* `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
202
* `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
203

Haelwenn's avatar
Haelwenn committed
204
205
## :media_proxy
* `enabled`: Enables proxying of remote media to the instance’s proxy
href's avatar
href committed
206
207
* `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
208
209
210
211
212

## :gopher
* `enabled`: Enables the gopher interface
* `ip`: IP address to bind to
* `port`: Port to bind to
213
* `dstport`: Port advertised in urls (optional, defaults to `port`)
214

215
216
217
218
219
220
221
## Pleroma.Web.Endpoint
`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
* `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
  - `ip` - a tuple consisting of 4 integers
  - `port`
* `url` - a list containing the configuration for generating urls, accepts
  - `host` - the host without the scheme and a post (e.g `example.com`, not `https://example.com:2020`)
222
  - `scheme` - e.g `http`, `https`
223
224
  - `port`
  - `path`
225
226
* `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.

227
228


229
**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
230

231
Example:
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
```elixir
config :pleroma, Pleroma.Web.Endpoint,
  url: [host: "example.com", port: 2020, scheme: "https"],
  http: [
    # start copied from config.exs
    dispatch: [
      {:_,
       [
         {"/api/v1/streaming", Pleroma.Web.MastodonAPI.WebsocketHandler, []},
         {"/websocket", Phoenix.Endpoint.CowboyWebSocket,
          {Phoenix.Transports.WebSocket,
           {Pleroma.Web.Endpoint, Pleroma.Web.UserSocket, websocket_config}}},
         {:_, Phoenix.Endpoint.Cowboy2Handler, {Pleroma.Web.Endpoint, []}}
       ]}
    # end copied from config.exs
    ],
    port: 8080,
    ip: {127, 0, 0, 1}
  ]
```

This will make Pleroma listen on `127.0.0.1` port `8080` and generate urls starting with `https://example.com:2020`

255
256
257
258
259
## :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
260

kaniini's avatar
kaniini committed
261
## :http_security
262
263
264
* ``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
265
* ``ct_max_age``: The maximum age for the `Expect-CT` header if sent
266
* ``referrer_policy``: The referrer policy to use, either `"same-origin"` or `"no-referrer"`.
kaniini's avatar
kaniini committed
267
268
269
270
271
272
273
274
275

## :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
276
```exs
kaniini's avatar
kaniini committed
277
278
279
config :pleroma, :mrf_user_allowlist,
  "example.org": ["https://example.org/users/admin"]
```
280

Haelwenn's avatar
Haelwenn committed
281
## :web_push_encryption, :vapid_details
282

lain's avatar
lain committed
283
Web Push Notifications configuration. You can use the mix task `mix web_push.gen.keypair` to generate it.
284
285
286
287

* ``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
288
289
290
291

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

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

299
300
301
302
303
304
* `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
305
```exs
306
307
308
309
config :pleroma, :admin_token, "somerandomtoken"
```

You can then do
minibikini's avatar
minibikini committed
310
311

```sh
312
313
curl "http://localhost:4000/api/pleroma/admin/invite_token?admin_token=somerandomtoken"
```
lain's avatar
lain committed
314

315
## :pleroma_job_queue
minibikini's avatar
minibikini committed
316

317
318
[Pleroma Job Queue](https://git.pleroma.social/pleroma/pleroma_job_queue) configuration: a list of queues with maximum concurrent jobs.

rinpatch's avatar
qs    
rinpatch committed
319
Pleroma has the following queues:
320

321
322
* `federator_outgoing` - Outgoing federation
* `federator_incoming` - Incoming federation
323
* `mailer` - Email sender, see [`Pleroma.Emails.Mailer`](#pleroma-emails-mailer)
324
* `transmogrifier` - Transmogrifier
325
* `web_push` - Web push notifications
326
* `scheduled_activities` - Scheduled activities, see [`Pleroma.ScheduledActivities`](#pleromascheduledactivity)
minibikini's avatar
minibikini committed
327
328
329

Example:

330
331
332
333
```elixir
config :pleroma_job_queue, :queues,
  federator_incoming: 50,
  federator_outgoing: 50
minibikini's avatar
minibikini committed
334
335
336
```

This config contains two queues: `federator_incoming` and `federator_outgoing`. Both have the `max_jobs` set to `50`.
lain's avatar
lain committed
337
338
339
340

## Pleroma.Web.Federator.RetryQueue

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

## Pleroma.Web.Metadata
Alexander Strizhakov's avatar
Alexander Strizhakov committed
346
* `providers`: a list of metadata providers to enable. Providers available:
rinpatch's avatar
rinpatch committed
347
348
  * Pleroma.Web.Metadata.Providers.OpenGraph
  * Pleroma.Web.Metadata.Providers.TwitterCard
Alexander Strizhakov's avatar
Alexander Strizhakov committed
349
  * Pleroma.Web.Metadata.Providers.RelMe - add links from user bio with rel=me into the `<header>` as `<link rel=me>`
350
* `unfurl_nsfw`: If set to `true` nsfw attachments will be shown in previews
href's avatar
href committed
351

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

355
356
357
358
## :fetch_initial_posts
* `enabled`: if enabled, when a new user is federated with, fetch some of their latest posts
* `pages`: the amount of pages to fetch

href's avatar
href committed
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
## :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

minibikini's avatar
minibikini committed
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
## :auto_linker

Configuration for the `auto_linker` library:

* `class: "auto-linker"` - specify the class to be added to the generated link. false to clear
* `rel: "noopener noreferrer"` - override the rel attribute. false to clear
* `new_window: true` - set to false to remove `target='_blank'` attribute
* `scheme: false` - Set to true to link urls with schema `http://google.com`
* `truncate: false` - Set to a number to truncate urls longer then the number. Truncated urls will end in `..`
* `strip_prefix: true` - Strip the scheme prefix
* `extra: false` - link urls with rarely used schemes (magnet, ipfs, irc, etc.)

Example:

```exs
config :auto_linker,
  opts: [
    scheme: true,
    extra: true,
    class: false,
    strip_prefix: false,
    new_window: false,
    rel: false
  ]
```
400

401
402
403
404
405
406
## Pleroma.ScheduledActivity

* `daily_user_limit`: the number of scheduled activities a user is allowed to create in a single day (Default: `25`)
* `total_user_limit`: the number of scheduled activities a user is allowed to create in total (Default: `300`)
* `enabled`: whether scheduled activities are sent to the job queue to be executed

407
408
409
410
411
## Pleroma.Web.Auth.Authenticator

* `Pleroma.Web.Auth.PleromaAuthenticator`: default database authenticator
* `Pleroma.Web.Auth.LDAPAuthenticator`: LDAP authentication

link0ff's avatar
link0ff committed
412
413
## :ldap

link0ff's avatar
link0ff committed
414
415
416
417
418
419
Use LDAP for user authentication.  When a user logs in to the Pleroma
instance, the name and password will be verified by trying to authenticate
(bind) to an LDAP server.  If a user exists in the LDAP directory but there
is no account with the same name yet on the Pleroma instance then a new
Pleroma account will be created with the same name as the LDAP user name.

link0ff's avatar
link0ff committed
420
421
422
* `enabled`: enables LDAP authentication
* `host`: LDAP server hostname
* `port`: LDAP port, e.g. 389 or 636
link0ff's avatar
link0ff committed
423
* `ssl`: true to use SSL, usually implies the port 636
link0ff's avatar
link0ff committed
424
* `sslopts`: additional SSL options
link0ff's avatar
link0ff committed
425
426
* `tls`: true to start TLS, usually implies the port 389
* `tlsopts`: additional TLS options
link0ff's avatar
link0ff committed
427
* `base`: LDAP base, e.g. "dc=example,dc=com"
link0ff's avatar
link0ff committed
428
* `uid`: LDAP attribute name to authenticate the user, e.g. when "cn", the filter will be "cn=username,base"
429

430
## :auth
431

432
Authentication / authorization settings.
433

434
* `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`.
435
436
* `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`.
* `oauth_consumer_strategies`: the list of enabled OAuth consumer strategies; by default it's set by OAUTH_CONSUMER_STRATEGIES environment variable.
437

438
# OAuth consumer mode
439
440
441
442
443
444
445
446

OAuth consumer mode allows sign in / sign up via external OAuth providers (e.g. Twitter, Facebook, Google, Microsoft, etc.).
Implementation is based on Ueberauth; see the list of [available strategies](https://github.com/ueberauth/ueberauth/wiki/List-of-Strategies).

Note: 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.

447
Note: each strategy requires separate setup (on external provider side and Pleroma side). Below are the guidelines on setting up most popular strategies.
448

449
450
Note: 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"`

451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
* For Twitter, [register an app](https://developer.twitter.com/en/apps), configure callback URL to https://<your_host>/oauth/twitter/callback

* 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/

* For Google, [register an app](https://console.developers.google.com), configure callback URL to https://<your_host>/oauth/google/callback

* For Microsoft, [register an app](https://portal.azure.com), configure callback URL to https://<your_host>/oauth/microsoft/callback

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`,
per strategy's documentation (e.g. [ueberauth_twitter](https://github.com/ueberauth/ueberauth_twitter)). Example config basing on environment variables:

```
# Twitter
config :ueberauth, Ueberauth.Strategy.Twitter.OAuth,
  consumer_key: System.get_env("TWITTER_CONSUMER_KEY"),
  consumer_secret: System.get_env("TWITTER_CONSUMER_SECRET")

# Facebook
config :ueberauth, Ueberauth.Strategy.Facebook.OAuth,
  client_id: System.get_env("FACEBOOK_APP_ID"),
  client_secret: System.get_env("FACEBOOK_APP_SECRET"),
  redirect_uri: System.get_env("FACEBOOK_REDIRECT_URI")

# Google
config :ueberauth, Ueberauth.Strategy.Google.OAuth,
  client_id: System.get_env("GOOGLE_CLIENT_ID"),
  client_secret: System.get_env("GOOGLE_CLIENT_SECRET"),
  redirect_uri: System.get_env("GOOGLE_REDIRECT_URI")

# Microsoft
config :ueberauth, Ueberauth.Strategy.Microsoft.OAuth,
  client_id: System.get_env("MICROSOFT_CLIENT_ID"),
  client_secret: System.get_env("MICROSOFT_CLIENT_SECRET")
484

485
486
487
488
489
config :ueberauth, Ueberauth,
  providers: [
    microsoft: {Ueberauth.Strategy.Microsoft, [callback_params: []]}
  ]
```