diff options
| author | Patrick Cloke <clokep@users.noreply.github.com> | 2022-09-22 09:11:50 -0400 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2022-09-22 09:11:50 -0400 |
| commit | 8c3dcdf1b96355ed1ff135e1009ee8e3f2e28517 (patch) | |
| tree | f97e7f99573c8760a559bac40fb4015b1c2012fc | |
| parent | Properly paginate forward in the /relations API. (#13840) (diff) | |
| download | synapse-8c3dcdf1b96355ed1ff135e1009ee8e3f2e28517.tar.xz | |
Fix the cross-link from register admin API to config docs. (#13870)
| -rw-r--r-- | changelog.d/13870.doc | 1 | ||||
| -rw-r--r-- | docs/admin_api/register_api.md | 2 |
2 files changed, 2 insertions, 1 deletions
diff --git a/changelog.d/13870.doc b/changelog.d/13870.doc new file mode 100644 index 0000000000..2598bc270c --- /dev/null +++ b/changelog.d/13870.doc @@ -0,0 +1 @@ +Fix a cross-link from the register admin API to the `registration_shared_secret` configuration documentation. diff --git a/docs/admin_api/register_api.md b/docs/admin_api/register_api.md index f6be31b443..dd2830f3a1 100644 --- a/docs/admin_api/register_api.md +++ b/docs/admin_api/register_api.md @@ -5,7 +5,7 @@ non-interactive way. This is generally used for bootstrapping a Synapse instance with administrator accounts. To authenticate yourself to the server, you will need both the shared secret -([`registration_shared_secret`](../configuration/config_documentation.md#registration_shared_secret) +([`registration_shared_secret`](../usage/configuration/config_documentation.md#registration_shared_secret) in the homeserver configuration), and a one-time nonce. If the registration shared secret is not configured, this API is not enabled. |