diff --git a/docs/configuring-captcha.md b/docs/configuring-captcha.md index a4a16a1dc..0bdd76d50 100644 --- a/docs/configuring-captcha.md +++ b/docs/configuring-captcha.md @@ -1,3 +1,12 @@ + + (Adapted from the [upstream project](https://github.com/element-hq/synapse/blob/develop/docs/CAPTCHA_SETUP.md)) # Overview diff --git a/docs/configuring-playbook-base-domain-serving.md b/docs/configuring-playbook-base-domain-serving.md index 3a3335e70..b24ab3d38 100644 --- a/docs/configuring-playbook-base-domain-serving.md +++ b/docs/configuring-playbook-base-domain-serving.md @@ -1,3 +1,10 @@ + + # Serving the base domain (optional) By default, this playbook sets up services on your Matrix server (`matrix.example.com`), but has it configured so that it presents itself as the base domain (`example.com`). To have this server officially be responsible for Matrix services for the base domain (`example.com`), you need to set up server delegation / redirection. diff --git a/docs/configuring-playbook-federation.md b/docs/configuring-playbook-federation.md index e87d10e79..c06928748 100644 --- a/docs/configuring-playbook-federation.md +++ b/docs/configuring-playbook-federation.md @@ -1,3 +1,11 @@ + + # Controlling Matrix federation (optional) By default, your server federates with the whole Matrix network. That is, people on your server can communicate with people on any other Matrix server. diff --git a/docs/configuring-playbook-nginx.md b/docs/configuring-playbook-nginx.md index 2d3353081..c15ad7f14 100644 --- a/docs/configuring-playbook-nginx.md +++ b/docs/configuring-playbook-nginx.md @@ -1,3 +1,14 @@ + + # Configure Nginx (optional, advanced) Since 2024-01, this playbook no longer uses nginx as its reverse-proxy. diff --git a/docs/configuring-playbook-own-webserver.md b/docs/configuring-playbook-own-webserver.md index e49c454ae..0cac72b64 100644 --- a/docs/configuring-playbook-own-webserver.md +++ b/docs/configuring-playbook-own-webserver.md @@ -1,3 +1,21 @@ + + # Using your own webserver, instead of this playbook's Traefik reverse-proxy (optional, advanced) By default, this playbook installs its own [Traefik](https://traefik.io/) reverse-proxy server (in a Docker container) which listens on ports 80 and 443. If that's okay, you can skip this document. diff --git a/docs/configuring-playbook-ssl-certificates.md b/docs/configuring-playbook-ssl-certificates.md index 94c4d58c5..50f2fbc2b 100644 --- a/docs/configuring-playbook-ssl-certificates.md +++ b/docs/configuring-playbook-ssl-certificates.md @@ -1,3 +1,14 @@ + + # Adjusting SSL certificate retrieval (optional, advanced) By default, this playbook retrieves and auto-renews free SSL certificates from [Let's Encrypt](https://letsencrypt.org/) for the domains it needs (e.g. `matrix.example.com` and others) diff --git a/docs/configuring-playbook-telemetry.md b/docs/configuring-playbook-telemetry.md index aa26fb734..58e67543a 100644 --- a/docs/configuring-playbook-telemetry.md +++ b/docs/configuring-playbook-telemetry.md @@ -1,3 +1,13 @@ + + # Enabling Telemetry for your Matrix server (optional) By default, this playbook configures your Matrix homeserver to not send any telemetry data anywhere. diff --git a/docs/configuring-well-known.md b/docs/configuring-well-known.md index cd387bc00..ec5ad90ce 100644 --- a/docs/configuring-well-known.md +++ b/docs/configuring-well-known.md @@ -1,3 +1,16 @@ + + # Configuring Service Discovery via .well-known This documentation page explains how to configure Service discovery via `/.well-known/` files. Service discovery is a way for the Matrix network to discover where a Matrix server is. diff --git a/docs/container-images.md b/docs/container-images.md index fbafe02e0..d9bb657f9 100644 --- a/docs/container-images.md +++ b/docs/container-images.md @@ -1,3 +1,20 @@ + + # Container images used by the playbook This page summarizes the container ([Docker](https://www.docker.com/)) images used by the playbook when setting up your server. diff --git a/docs/howto-server-delegation.md b/docs/howto-server-delegation.md index 602fda481..fb6a26f79 100644 --- a/docs/howto-server-delegation.md +++ b/docs/howto-server-delegation.md @@ -1,3 +1,15 @@ + + # Server Delegation By default, this playbook sets up services on your Matrix server (`matrix.example.com`). To have this server officially be responsible for Matrix services for the base domain (`example.com`), you need to set up server delegation / redirection. diff --git a/docs/howto-srv-server-delegation.md b/docs/howto-srv-server-delegation.md index 4512dfca8..7a13ddab4 100644 --- a/docs/howto-srv-server-delegation.md +++ b/docs/howto-srv-server-delegation.md @@ -1,3 +1,11 @@ + + # Server Delegation via a DNS SRV record (advanced) **Reminder** : unless you are affected by the [Downsides of well-known-based Server Delegation](howto-server-delegation.md#downsides-of-well-known-based-server-delegation), we suggest you **stay on the simple/default path**: [Server Delegation](howto-server-delegation.md) by [configuring well-known files](configuring-well-known.md) at the base domain. diff --git a/docs/importing-postgres.md b/docs/importing-postgres.md index 1113caf1e..a27c7d6d5 100644 --- a/docs/importing-postgres.md +++ b/docs/importing-postgres.md @@ -1,3 +1,12 @@ + + # Importing an existing Postgres database from another installation (optional) You can manually import your database from a previous default installation of Synapse. diff --git a/docs/importing-synapse-media-store.md b/docs/importing-synapse-media-store.md index 69c8b0ef6..08993f952 100644 --- a/docs/importing-synapse-media-store.md +++ b/docs/importing-synapse-media-store.md @@ -1,3 +1,10 @@ + + # Importing `media_store` data files from an existing Synapse installation (optional) You can manually import your `media_store` files from a previous installation of Synapse. diff --git a/docs/importing-synapse-sqlite.md b/docs/importing-synapse-sqlite.md index 0fe0ec84e..f3ce1d2f4 100644 --- a/docs/importing-synapse-sqlite.md +++ b/docs/importing-synapse-sqlite.md @@ -1,3 +1,11 @@ + + # Importing an existing SQLite database from another Synapse installation (optional) You can manually import your database from a previous default installation of Synapse. diff --git a/docs/maintenance-migrating.md b/docs/maintenance-migrating.md index 2aa2e5a86..2b07201c4 100644 --- a/docs/maintenance-migrating.md +++ b/docs/maintenance-migrating.md @@ -1,3 +1,12 @@ + + # Migrating to new server This documentation explains how to migrate your Matrix services (server, client, bridges, etc.) and data **from an old server to a new server**. diff --git a/docs/maintenance-synapse.md b/docs/maintenance-synapse.md index e7cb17c9d..15b6eb62b 100644 --- a/docs/maintenance-synapse.md +++ b/docs/maintenance-synapse.md @@ -1,3 +1,14 @@ + + # Synapse maintenance This document shows you how to perform various maintenance tasks related to the Synapse chat server. diff --git a/docs/obtaining-access-tokens.md b/docs/obtaining-access-tokens.md index 3466f1a4e..1600e413c 100644 --- a/docs/obtaining-access-tokens.md +++ b/docs/obtaining-access-tokens.md @@ -1,3 +1,12 @@ + + # Obtaining an Access Token When setting up some optional features like bots and bridges you will need to provide an access token for some user. This document provides documentation on how to obtain such an access token. diff --git a/docs/quick-start.md b/docs/quick-start.md index 21b8515e2..c9513c964 100644 --- a/docs/quick-start.md +++ b/docs/quick-start.md @@ -1,3 +1,9 @@ + + # Quick start + # Registering users This documentation page tells you how to create user accounts on your Matrix server. diff --git a/docs/self-building.md b/docs/self-building.md index d09e587df..d1aa855b7 100644 --- a/docs/self-building.md +++ b/docs/self-building.md @@ -1,3 +1,17 @@ + + # Self-building **Caution: self-building does not have to be used on its own. See the [Alternative Architectures](alternative-architectures.md) page.** diff --git a/docs/updating-users-passwords.md b/docs/updating-users-passwords.md index 87a844bb8..7a9eade91 100644 --- a/docs/updating-users-passwords.md +++ b/docs/updating-users-passwords.md @@ -1,3 +1,15 @@ + + # Updating users passwords ## Option 1 (if you are using the integrated Postgres database):