Skip to content

Commit f578704

Browse files
committed
doc: document invite tokens
1 parent 7319977 commit f578704

File tree

1 file changed

+15
-1
lines changed

1 file changed

+15
-1
lines changed

README.md

Lines changed: 15 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -284,8 +284,22 @@ Fresh chatmail addresses have a mailbox directory that contains:
284284
will typically be empty unless the user of that address hasn't been online
285285
for a while.
286286

287+
## Restrict address creation
287288

288-
## Emergency Commands to disable automatic address creation
289+
### Only allow new addresses with an invite token
290+
291+
To restrict address creation for anyone who doesn't have the invite link/QR code:
292+
293+
1. Use the `invite_token` option to add
294+
one or more tokens of your choice to `chatmail.ini`:
295+
`invite_token = s3cr3t privil3g3`
296+
2. Run `scripts/cmdeploy run`
297+
3. Distribute a `dcaccount` invite link/QR code
298+
(like the one on your web page)
299+
with one of your invite tokens added at the end,
300+
for example: `dcaccount:https://example.org/new?s3cr3t`
301+
302+
### Emergency Command to disable automatic address creation
289303

290304
If you need to stop address creation,
291305
e.g. because some script is wildly creating addresses,

0 commit comments

Comments
 (0)