From e41435f13cc225d954a6b3422a7c2f64f591c06c Mon Sep 17 00:00:00 2001 From: stratself Date: Sat, 12 Sep 2026 07:58:39 +0000 Subject: [PATCH] docs(auth): Rename rego page to "internal auth" & add pwd reset details * Moved around a few paragraphs to fit new title as well --- docs/authentication/_meta.json | 4 +- .../{registration.mdx => internal.mdx} | 37 ++++++++++++------- 2 files changed, 25 insertions(+), 16 deletions(-) rename docs/authentication/{registration.mdx => internal.mdx} (67%) diff --git a/docs/authentication/_meta.json b/docs/authentication/_meta.json index 1224bfce5..b9ac83b46 100644 --- a/docs/authentication/_meta.json +++ b/docs/authentication/_meta.json @@ -1,8 +1,8 @@ [ { "type": "file", - "name": "registration", - "label": "Registration" + "name": "internal", + "label": "Internal authentication" }, { "type": "file", diff --git a/docs/authentication/registration.mdx b/docs/authentication/internal.mdx similarity index 67% rename from docs/authentication/registration.mdx rename to docs/authentication/internal.mdx index a6acafc75..ab186cc13 100644 --- a/docs/authentication/registration.mdx +++ b/docs/authentication/internal.mdx @@ -1,20 +1,22 @@ -# Registration +# Internal authentication + +Continuwuity by default comes with an internal database for user authentication. Using the internal database allows for self-servicing of account registration, linking emails, and password resets. + +## Registration Registration is disabled by default. To enable it, set `allow_registration = true` in your config file and configure at least one of the registration methods below. -## Registration methods +| Method | Description | Additional configuration needed | +| ------ | --------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- | +| 1 | Admin-issued tokens (recommended) | None. Use the `!admin issue token` command | +| 2 | Static registration token | `registration_token` or `registration_token_file` | +| 3 | reCAPTCHA-only registration | `recaptcha_site_key` and `recaptcha_private_site_key` | +| 4 | Static token + reCAPTCHA | Methods 2 + 3 | +| 5 | Static token + email | Method 2 + `require_email_for_token_registration = true` in `[global.smtp]`. See [Email configuration](#email-configuration) | +| 6 | Static token + email + reCAPTCHA | Methods 3 + 5 | +| 7 | Email only | `require_email_for_registration = true` in `[global.smtp]` section. See [Email configuration](#email-configuration) | -The registration methods below can be completed via Continuwuity's account management page. If legacy login is allowed, it can also be completed in-band with a supporting Matrix client. - -| Method | Description | Additional configuration needed | -| ------ | --------------------------------- | ----------------------------------------------------------------------------------- | -| 1 | Admin-issued tokens (recommended) | None. Use the `!admin issue token` command | -| 2 | Static registration token | `registration_token` or `registration_token_file` | -| 3 | reCAPTCHA-only registration | `recaptcha_site_key` and `recaptcha_private_site_key` | -| 4 | Static token + reCAPTCHA | Methods 2 + 3 | -| 5 | Static token + email | Method 2 + `require_email_for_token_registration = true` in `[global.smtp]` section | -| 6 | Static token + email + reCAPTCHA | Methods 3 + 5 | -| 7 | Email only | `require_email_for_registration = true` in `[global.smtp]` section | +Registrations can be made via Continuwuity's account management page, as well as in-band from within a Matrix client (if legacy login is enabled). Admin-issued tokens are the recommended method of registration. These tokens can be scoped with an expiry duration or maximum times used, and are suited for private/invite-only homeservers. See the `!admin token` commands for more details. @@ -22,7 +24,7 @@ Other registration methods are meant for **untrusted, public registration**. Car ## Email configuration -Continuwuity can be configured to send emails via an SMTP relay of your choice. These are used for verifying user email addresses, and sending password resets links to them. +Continuwuity can be configured to send emails via an SMTP relay of your choice. These are used for verifying user email addresses and sending password resets links to them. A user is associated with only **one** email address at a time. @@ -38,3 +40,10 @@ sender = "John's Continuwuity server " A user's email address can also be modified by the `!admin users change-email` command. To view current user-email associations, use the `!admin users get-email` and `!admin users get-user-by-email` command. Use `!admin debug send-test-email` to test that your email setup is working. + +## Password resets + +Password resets in Continuwuity can be made via: + +- Self-service password resets. This requires a user's email to be set up and verified. +- Using the `!admin users reset-password` command.