Merge 9cb2a3d927 into 8078a8ad2e

Merge pull request #3734 from luixxiul/fix
Update docs/configuring-playbook.md: adopt the same structure and order for entries as ones on README.md
2024-11-06 02:37:31 +01:00 · 2024-11-03 19:09:13 +00:00 · 2024-11-03 21:08:42 +02:00 · 2024-11-03 19:43:06 +09:00 · 2024-11-03 19:41:59 +09:00 · 2024-11-03 19:39:54 +09:00
3 changed files with 85 additions and 57 deletions
--- a/README.md
+++ b/README.md
@ -66,8 +66,6 @@ Services that run on the server to make the various parts of your installation w
 | [ma1sd](https://github.com/ma1uta/ma1sd) | x | Matrix Identity Server | [Link](docs/configuring-playbook-ma1sd.md)
 | [Exim](https://www.exim.org/) | ✓ | Mail server, through which all Matrix services send outgoing email (can be configured to relay through another SMTP server) | [Link](docs/configuring-playbook-email.md) |
 | [ddclient](https://github.com/linuxserver/docker-ddclient) | x | Dynamic DNS | [Link](docs/configuring-playbook-dynamic-dns.md) |
-| [Sygnal](https://github.com/matrix-org/sygnal) | x | Push gateway | [Link](docs/configuring-playbook-sygnal.md) |
-| [ntfy](https://ntfy.sh) | x | Push notifications server | [Link](docs/configuring-playbook-ntfy.md) |


 ### Authentication
@ -162,7 +160,7 @@ Services that help you in administrating and monitoring your Matrix installation

 ### Misc

-Various services that don't fit any other category.
+Various services that don't fit any other categories.

 | Name | Default? | Description | Documentation |
 | ---- | -------- | ----------- | ------------- |
@ -175,6 +173,8 @@ Various services that don't fit any other category.
 | [Jitsi](https://jitsi.org/) | x | An open source video-conferencing platform | [Link](docs/configuring-playbook-jitsi.md) |
 | [Cactus Comments](https://cactus.chat) | x | A federated comment system built on Matrix | [Link](docs/configuring-playbook-cactus-comments.md) |
 | [Pantalaimon](https://github.com/matrix-org/pantalaimon) | x | An E2EE aware proxy daemon | [Link](docs/configuring-playbook-pantalaimon.md) |
+| [Sygnal](https://github.com/matrix-org/sygnal) | x | Push gateway | [Link](docs/configuring-playbook-sygnal.md) |
+| [ntfy](https://ntfy.sh) | x | Push notifications server | [Link](docs/configuring-playbook-ntfy.md) |


 ## Installation
--- a/docs/configuring-playbook.md
+++ b/docs/configuring-playbook.md
@ -31,18 +31,6 @@ When you're done with all the configuration you'd like to do, continue with [Ins

 ## Other configuration options

-### Additional useful services
-
- [Setting up the Jitsi video-conferencing platform](configuring-playbook-jitsi.md)
-
- [Setting up Etherpad](configuring-playbook-etherpad.md)
-
- [Enabling metrics and graphs (Prometheus, Grafana) for your Matrix server](configuring-playbook-prometheus-grafana.md)
-
- [Enabling metrics and graphs for NginX logs](docs/configuring-playbook-prometheus-nginxlog.md)
-
- [Enabling synapse-usage-exporter for Synapse usage statistics](configuring-playbook-synapse-usage-exporter.md)
-
 ### Core service adjustments

 - Homeserver configuration:
@ -52,52 +40,50 @@ When you're done with all the configuration you'd like to do, continue with [Ins

  - [Configuring Dendrite](configuring-playbook-dendrite.md), if you've switched to the [Dendrite](https://matrix-org.github.io/dendrite) homeserver implementation

- [Configuring Element](configuring-playbook-client-element.md)
+- Server components:
+  - [Using an external PostgreSQL server](configuring-playbook-external-postgres.md)

- [Storing Matrix media files using matrix-media-repo](configuring-playbook-matrix-media-repo.md)
+  - [Adjusting TURN server configuration](configuring-playbook-turn.md) (advanced)

- [Storing Synapse media files on Amazon S3 or another compatible Object Storage](configuring-playbook-s3.md)
+  - [Configuring the Traefik reverse-proxy](configuring-playbook-traefik.md) (advanced)

- [Storing Matrix media files on Amazon S3 with Goofys](docs/configuring-playbook-s3-goofys.md)
+  - [Using your own webserver, instead of this playbook's Traefik reverse-proxy](configuring-playbook-own-webserver.md) (advanced)

- [Using an external PostgreSQL server](configuring-playbook-external-postgres.md)
+  - [Adjusting SSL certificate retrieval](configuring-playbook-ssl-certificates.md) (advanced)

- [Adjusting SSL certificate retrieval](configuring-playbook-ssl-certificates.md) (advanced)
+  - [Adjusting email-sending settings](configuring-playbook-email.md)
+
+  - [Setting up ma1sd Identity Server](configuring-playbook-ma1sd.md)
+
+  - [Setting up Dynamic DNS](configuring-playbook-dynamic-dns.md)
+
+- Server connectivity:
+  - [Enabling Telemetry for your Matrix server](configuring-playbook-telemetry.md)
+
+  - [Controlling Matrix federation](configuring-playbook-federation.md)

 - [Serving the base domain](configuring-playbook-base-domain-serving.md)

- [Configuring the Traefik reverse-proxy](configuring-playbook-traefik.md) (advanced)
+### Clients

- [Using your own webserver, instead of this playbook's Traefik reverse-proxy](configuring-playbook-own-webserver.md) (advanced)
+Web clients for Matrix that you can host on your own domains.

- [Adjusting TURN server configuration](configuring-playbook-turn.md) (advanced)
+- [Configuring Element](configuring-playbook-client-element.md), if you're going with the default/recommended client

+- [Setting up Hydrogen](configuring-playbook-client-hydrogen.md), if you've enabled [Hydrogen](https://github.com/element-hq/hydrogen-web), a lightweight Matrix client with legacy and mobile browser support

-### Server connectivity
-
- [Enabling Telemetry for your Matrix server](configuring-playbook-telemetry.md)
-
- [Controlling Matrix federation](configuring-playbook-federation.md)
-
- [Adjusting email-sending settings](configuring-playbook-email.md)
-
- [Setting up Dynamic DNS](configuring-playbook-dynamic-dns.md)
-
- [Setting up Hydrogen](configuring-playbook-client-hydrogen.md) - a new lightweight Matrix client with legacy and mobile browser support
-
- [Setting up Cinny](configuring-playbook-client-cinny.md) - a web client focusing primarily on simple, elegant and secure interface
-
- [Setting up SchildiChat](configuring-playbook-client-schildichat.md) - a web client based on [Element](https://element.io/) with some extras and tweaks
+- [Setting up Cinny](configuring-playbook-client-cinny.md), if you've enabled [Cinny](https://github.com/ajbura/cinny), a web client focusing primarily on simple, elegant and secure interface

+- [Setting up SchildiChat](configuring-playbook-client-schildichat.md), if you've enabled [SchildiChat](https://schildi.chat/), a web client based on [Element](https://element.io/) with some extras and tweaks

 ### Authentication and user-related

+Extend and modify how users are authenticated on your homeserver.
+
 - [Setting up Matrix Authentication Service](configuring-playbook-matrix-authentication-service.md) (Next-generation auth for Matrix, based on OAuth 2.0/OIDC)

 - [Setting up Appservice Double Puppet](configuring-playbook-appservice-double-puppet.md)

- [Setting up ma1sd Identity Server](configuring-playbook-ma1sd.md)
-
 - [Setting up Synapse Admin](configuring-playbook-synapse-admin.md)

 - [Setting up matrix-registration](configuring-playbook-matrix-registration.md)
@ -112,15 +98,22 @@ When you're done with all the configuration you'd like to do, continue with [Ins

 - [Setting up Synapse Simple Antispam](configuring-playbook-synapse-simple-antispam.md) (advanced)

- [Setting up Matrix Corporal](configuring-playbook-matrix-corporal.md) (advanced)
-
 - [Setting up Matrix User Verification Service](configuring-playbook-user-verification-service.md) (advanced)

- [Setting up Pantalaimon (E2EE aware proxy daemon)](configuring-playbook-pantalaimon.md) (advanced)
+### File Storage

+Use alternative file storage to the default `media_store` folder.
+
+- [Storing Matrix media files on Amazon S3 with Goofys](docs/configuring-playbook-s3-goofys.md)
+
+- [Storing Synapse media files on Amazon S3 or another compatible Object Storage](configuring-playbook-s3.md)
+
+- [Storing Matrix media files using matrix-media-repo](configuring-playbook-matrix-media-repo.md)

 ### Bridging other networks

+Bridges can be used to connect your Matrix installation with third-party communication networks.
+
 - [Setting up Mautrix Discord bridging](configuring-playbook-bridge-mautrix-discord.md)

 - [Setting up Mautrix Telegram bridging](configuring-playbook-bridge-mautrix-telegram.md)
@ -182,6 +175,8 @@ When you're done with all the configuration you'd like to do, continue with [Ins

 ### Bots

+Bots provide various additional functionality to your installation.
+
 - [Setting up baibot](configuring-playbook-bot-baibot.md) - a bot through which you can talk to various [AI](https://en.wikipedia.org/wiki/Artificial_intelligence) / [Large Language Models](https://en.wikipedia.org/wiki/Large_language_model) services ([OpenAI](https://openai.com/)'s [ChatGPT](https://openai.com/blog/chatgpt/) and [others](https://github.com/etkecc/baibot/blob/main/docs/providers.md))

 - [Setting up matrix-reminder-bot](configuring-playbook-bot-matrix-reminder-bot.md) - a bot to remind you about stuff
@ -200,32 +195,49 @@ When you're done with all the configuration you'd like to do, continue with [Ins

 - [Setting up Buscarron](configuring-playbook-bot-buscarron.md) - a bot you can use to send any form (HTTP POST, HTML) to a (encrypted) Matrix room

+### Administration

-### Backups
+Services that help you in administrating and monitoring your Matrix installation.

- [Setting up BorgBackup](configuring-playbook-backup-borg.md) - a full Matrix server backup solution, including the Postgres database
+- [Setting up Prometheus Alertmanager integration via matrix-alertmanager-receiver](configuring-playbook-alertmanager-receiver.md)

- [Setting up postgres backup](configuring-playbook-postgres-backup.md) - a Postgres-database backup solution (note: does not include other files)
+- [Enabling metrics and graphs (Prometheus, Grafana) for your Matrix server](configuring-playbook-prometheus-grafana.md)

+- [Enabling metrics and graphs for NginX logs](docs/configuring-playbook-prometheus-nginxlog.md)
+
+- [Setting up the rageshake bug report server](configuring-playbook-rageshake.md)
+
+- [Enabling synapse-usage-exporter for Synapse usage statistics](configuring-playbook-synapse-usage-exporter.md)
+
+- Backups:
+  - [Setting up BorgBackup](configuring-playbook-backup-borg.md) - a full Matrix server backup solution, including the Postgres database
+
+  - [Setting up postgres backup](configuring-playbook-postgres-backup.md) - a Postgres-database backup solution (note: does not include other files)

 ### Other specialized services

- [Setting up synapse-auto-compressor](configuring-playbook-synapse-auto-compressor.md) for compressing the database on Synapse homeservers
+Various services that don't fit any other categories.
+
+- [Setting up the Sliding Sync proxy](configuring-playbook-sliding-sync-proxy.md) for clients which require Sliding Sync support (like Element X)

 - [Setting up Synapse Auto Invite Accept](configuring-playbook-synapse-auto-accept-invite.md)

- [Setting up the Sliding Sync proxy](configuring-playbook-sliding-sync-proxy.md) for clients which require Sliding Sync support (like Element X)
+- [Setting up synapse-auto-compressor](configuring-playbook-synapse-auto-compressor.md) for compressing the database on Synapse homeservers
+
+- [Setting up Matrix Corporal](configuring-playbook-matrix-corporal.md) (advanced)
+
+- [Setting up Etherpad](configuring-playbook-etherpad.md)
+
+- [Setting up the Jitsi video-conferencing platform](configuring-playbook-jitsi.md)
+
+- [Setting up Cactus Comments](configuring-playbook-cactus-comments.md) - a federated comment system built on Matrix
+
+- [Setting up Pantalaimon (E2EE aware proxy daemon)](configuring-playbook-pantalaimon.md) (advanced)

 - [Setting up the Sygnal push gateway](configuring-playbook-sygnal.md)

 - [Setting up the ntfy push notifications server](configuring-playbook-ntfy.md)

- [Setting up Cactus Comments](configuring-playbook-cactus-comments.md) - a federated comment system built on Matrix
-
- [Setting up the rageshake bug report server](configuring-playbook-rageshake.md)
-
- [Setting up Prometheus Alertmanager integration via matrix-alertmanager-receiver](configuring-playbook-alertmanager-receiver.md)
-
 ### Deprecated / unmaintained / removed services

 **Note**: since a deprecated or unmaintained service will not be updated, its bug or vulnerability will be unlikely to get patched. It is recommended to migrate from the service to an alternative if any, and make sure to do your own research before you decide to keep it running nonetheless.
--- a/docs/container-images.md
+++ b/docs/container-images.md
@ -15,6 +15,8 @@ We try to stick to official images (provided by their respective projects) as mu

 ## Clients

+Web clients for Matrix that you can host on your own domains.
+
 | Service | Container image | Default? | Description |
 | ------- | --------------- | -------- | ----------- |
 | [Element](configuring-playbook-client-element.md) | [vectorim/element-web](https://hub.docker.com/r/vectorim/element-web/) | ✓ | Web UI, which is configured to connect to your own Synapse server by default |
@ -24,6 +26,8 @@ We try to stick to official images (provided by their respective projects) as mu

 ## Server Components

+Services that run on the server to make the various parts of your installation work.
+
 | Service | Container image | Default? | Description |
 | ------- | --------------- | -------- | ----------- |
 | [PostgreSQL](configuring-playbook-external-postgres.md) | [postgres](https://hub.docker.com/_/postgres/) | ✓ | Database for Synapse. [Using an external PostgreSQL server](configuring-playbook-external-postgres.md) is also possible. |
@ -33,11 +37,11 @@ We try to stick to official images (provided by their respective projects) as mu
 | [ma1sd](configuring-playbook-ma1sd.md) | [ma1uta/ma1sd](https://hub.docker.com/r/ma1uta/ma1sd/) | x | Matrix Identity Server |
 | [Exim](configuring-playbook-email.md) | [devture/exim-relay](https://hub.docker.com/r/devture/exim-relay/) | ✓ | Mail server, through which all Matrix services send outgoing email (can be configured to relay through another SMTP server) |
 | [ddclient](configuring-playbook-dynamic-dns.md) | [linuxserver/ddclient](https://hub.docker.com/r/linuxserver/ddclient) | x | Update dynamic DNS entries for accounts on Dynamic DNS Network Service Provider |
-| [Sygnal](configuring-playbook-sygnal.md) | [matrixdotorg/sygnal](https://hub.docker.com/r/matrixdotorg/sygnal/) | x | Reference Push Gateway for Matrix |
-| [ntfy](configuring-playbook-ntfy.md) | [binwiederhier/ntfy](https://hub.docker.com/r/binwiederhier/ntfy/) | x | Self-hosted, UnifiedPush-compatible push notifications server |

 ## Authentication

+Extend and modify how users are authenticated on your homeserver.
+
 | Service | Container image | Default? | Description |
 | ------- | --------------- | -------- | ----------- |
 | [matrix-synapse-rest-auth](configuring-playbook-rest-auth.md) | (N/A) | x | REST authentication password provider module |
@ -49,6 +53,8 @@ We try to stick to official images (provided by their respective projects) as mu

 ## File Storage

+Use alternative file storage to the default `media_store` folder.
+
 | Service | Container image | Default? | Description |
 | ------- | --------------- | -------- | ----------- |
 | [Goofys](configuring-playbook-s3-goofys.md) | [ewoutp/goofys](https://hub.docker.com/r/ewoutp/goofys/) | x | [Amazon S3](https://aws.amazon.com/s3/) (or other S3-compatible object store) storage for Synapse's content repository (`media_store`) files |
@ -57,6 +63,8 @@ We try to stick to official images (provided by their respective projects) as mu

 # Bridges

+Bridges can be used to connect your Matrix installation with third-party communication networks.
+
 | Service | Container image | Default? | Description |
 | ------- | --------------- | -------- | ----------- |
 | [mautrix-discord](configuring-playbook-bridge-mautrix-discord.md) | [mautrix/discord](https://mau.dev/mautrix/discord/container_registry) | x | Bridge to [Discord](https://discord.com/) |
@ -90,6 +98,8 @@ We try to stick to official images (provided by their respective projects) as mu

 ## Bots

+Bots provide various additional functionality to your installation.
+
 | Service | Container image | Default? | Description |
 | ------- | --------------- | -------- | ----------- |
 | [baibot](configuring-playbook-bot-baibot.md) | [etke.cc/baibot](https://ghcr.io/etkecc/baibot) | x | A bot that exposes the power of [AI](https://en.wikipedia.org/wiki/Artificial_intelligence) / [Large Language Models](https://en.wikipedia.org/wiki/Large_language_model) to you |
@ -103,6 +113,8 @@ We try to stick to official images (provided by their respective projects) as mu

 ## Administration

+Services that help you in administrating and monitoring your Matrix installation.
+
 | Service | Container image | Default? | Description |
 | ------- | --------------- | -------- | ----------- |
 | [matrix-alertmanager-receiver](configuring-playbook-alertmanager-receiver.md) | [metio/matrix-alertmanager-receiver](https://hub.docker.com/r/metio/matrix-alertmanager-receiver)  | x | Prometheus' [Alertmanager](https://prometheus.io/docs/alerting/latest/alertmanager/) client |
@ -118,6 +130,8 @@ We try to stick to official images (provided by their respective projects) as mu

 ## Misc

+Various services that don't fit any other categories.
+
 | Service | Container image | Default? | Description |
 | ------- | --------------- | -------- | ----------- |
 | [sliding-sync](configuring-playbook-sliding-sync-proxy.md) | [matrix-org/sliding-sync](https://ghcr.io/matrix-org/sliding-sync) | x | Sliding Sync support for clients which require it (e.g. Element X) |
@ -133,6 +147,8 @@ We try to stick to official images (provided by their respective projects) as mu
 | [Cactus Comments](configuring-playbook-cactus-comments.md) | [cactuscomments/cactus-appservice](https://hub.docker.com/r/cactuscomments/cactus-appservice/) | x | A federated comment system built on Matrix |
 | [Cactus Comments](configuring-playbook-cactus-comments.md) | [joseluisq/static-web-server](https://hub.docker.com/r/joseluisq/static-web-server) | x | A federated comment system built on Matrix |
 | [Pantalaimon](configuring-playbook-pantalaimon.md) | [matrixdotorg/pantalaimon](https://hub.docker.com/r/matrixdotorg/pantalaimon) | x | An E2EE aware proxy daemon |
+| [Sygnal](configuring-playbook-sygnal.md) | [matrixdotorg/sygnal](https://hub.docker.com/r/matrixdotorg/sygnal/) | x | Reference Push Gateway for Matrix |
+| [ntfy](configuring-playbook-ntfy.md) | [binwiederhier/ntfy](https://hub.docker.com/r/binwiederhier/ntfy/) | x | Self-hosted, UnifiedPush-compatible push notifications server |

 ## Container images of deprecated / unmaintained services
Author	SHA1	Message	Date
renovate[bot]	e03772f657	Merge `9cb2a3d927` into `8078a8ad2e`	2024-11-03 19:09:13 +00:00
Slavi Pantaleev	8078a8ad2e	Merge pull request #3734 from luixxiul/fix Update docs/configuring-playbook.md: adopt the same structure and order for entries as ones on README.md	2024-11-03 21:08:42 +02:00
Suguru Hirahara	68b8f1137f	Update docs/configuring-playbook.md and docs/container-images.md: add explanations to each section These sentences are copied from README.md Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>	2024-11-03 19:43:06 +09:00
Suguru Hirahara	16104b6e57	Update docs/configuring-playbook.md: move entries to "Other specialized services" section These entries are ones categorized under "Misc" section on README.md Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>	2024-11-03 19:41:59 +09:00
Suguru Hirahara	69273b30e4	Update docs/configuring-playbook.md: create "Administration" section Reorganize "Additional useful services" section and "Other specialized services" section Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>	2024-11-03 19:39:54 +09:00
Suguru Hirahara	d630668f46	Update docs/configuring-playbook.md: move "Additional useful services" section down under "Bots" section Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>	2024-11-03 19:38:45 +09:00
Suguru Hirahara	2376821722	Update docs/configuring-playbook.md: create "File Storage" section under "Authentication and user-related" section This basically follows the order of the tables on README.md Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>	2024-11-03 19:37:59 +09:00
Suguru Hirahara	eaeb2f99b5	Update docs/configuring-playbook.md: move "Authentication and user-related" section up Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>	2024-11-03 19:37:40 +09:00
Suguru Hirahara	15fd33fb45	Update docs/configuring-playbook.md: merge "Server connectivity" section to "Core service adjustments" section Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>	2024-11-03 19:37:13 +09:00
Suguru Hirahara	c404995456	Update docs/configuring-playbook.md: create a list for server components based on the table on README.md Also: update README.md and docs/container-images.md Move Sygnal and ntfy from "Server Components" to "Misc", following the existing categorization on docs/configuring-playbook.md where they are categorized as "Other specialzed services". This categorization makes more sense as they are not really services which make the components on the server work (per README.md) Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>	2024-11-03 19:34:41 +09:00
Suguru Hirahara	7511b3d3ea	Update docs/configuring-playbook.md: create a section "Clients" Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>	2024-11-03 19:32:59 +09:00
Suguru Hirahara	6e92a5da3f	Update docs/configuring-playbook.md: move "Core service adjustments" section up Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>	2024-11-03 19:32:03 +09:00