Browse Source

add email verification docs

tags/v2.1.0
Shivaram Lingamneni 4 years ago
parent
commit
c7199798c8
1 changed files with 21 additions and 0 deletions
  1. 21
    0
      docs/MANUAL.md

+ 21
- 0
docs/MANUAL.md View File

@@ -29,6 +29,7 @@ _Copyright © Daniel Oaks <daniel@danieloaks.net>, Shivaram Lingamneni <slingamn
29 29
 - Features
30 30
     - User Accounts
31 31
         - Nickname reservation
32
+        - Email verification
32 33
     - Channel Registration
33 34
     - Language
34 35
     - Multiclient ("Bouncer")
@@ -257,6 +258,26 @@ To enable this mode, set the following configs:
257 258
 * `accounts.nick-reservation.method = strict`
258 259
 * `accounts.nick-reservation.force-nick-equals-account = true`
259 260
 
261
+### Email verification
262
+
263
+By default, account registrations complete immediately and do not require a verification step. However, like other service frameworks, Oragono's NickServ can be configured to require email verification of registrations. The main challenge here is to prevent your emails from being marked as spam, which you can do by configuring [SPF](https://en.wikipedia.org/wiki/Sender_Policy_Framework), [DKIM](https://en.wikipedia.org/wiki/DomainKeys_Identified_Mail), and [DMARC](https://en.wikipedia.org/wiki/DMARC). For example, this configuration (when added to the `accounts.registration` section) enables email verification, with the emails being signed with a DKIM key and sent directly from Oragono:
264
+
265
+```yaml
266
+        enabled-callbacks:
267
+            - mailto
268
+
269
+        callbacks:
270
+            mailto:
271
+                sender: "admin@my.network"
272
+                require-tls: true
273
+                dkim:
274
+                    domain: "my.network"
275
+                    selector: "20200525"
276
+                    key-file: "dkim-private-20200525.pem"
277
+```
278
+
279
+You must create the corresponding TXT record `20200525._domainkey.my.network` to hold your public key. You can also use an MTA ("relay" or "smarthost") to send the email, in which case DKIM signing can be deferred to the MTA; see the example config for details.
280
+
260 281
 
261 282
 ## Channel Registration
262 283
 

Loading…
Cancel
Save