diff --git a/README.md b/README.md index 09b46f4a4..0bd304e43 100644 --- 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 @@ -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 diff --git a/docs/configuring-playbook.md b/docs/configuring-playbook.md index b11f214c0..411b09ca4 100644 --- a/docs/configuring-playbook.md +++ b/docs/configuring-playbook.md @@ -40,24 +40,31 @@ 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 +- Server components: + - [Using an external PostgreSQL server](configuring-playbook-external-postgres.md) + + - [Adjusting TURN server configuration](configuring-playbook-turn.md) (advanced) + + - [Configuring the Traefik reverse-proxy](configuring-playbook-traefik.md) (advanced) + + - [Using your own webserver, instead of this playbook's Traefik reverse-proxy](configuring-playbook-own-webserver.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) + - [Storing Matrix media files using matrix-media-repo](configuring-playbook-matrix-media-repo.md) - [Storing Synapse media files on Amazon S3 or another compatible Object Storage](configuring-playbook-s3.md) - [Storing Matrix media files on Amazon S3 with Goofys](docs/configuring-playbook-s3-goofys.md) -- [Using an external PostgreSQL server](configuring-playbook-external-postgres.md) - -- [Adjusting SSL certificate retrieval](configuring-playbook-ssl-certificates.md) (advanced) - - [Serving the base domain](configuring-playbook-base-domain-serving.md) -- [Configuring the Traefik reverse-proxy](configuring-playbook-traefik.md) (advanced) - -- [Using your own webserver, instead of this playbook's Traefik reverse-proxy](configuring-playbook-own-webserver.md) (advanced) - -- [Adjusting TURN server configuration](configuring-playbook-turn.md) (advanced) - ### Clients - [Configuring Element](configuring-playbook-client-element.md), if you're going with the default/recommended client @@ -86,18 +93,12 @@ When you're done with all the configuration you'd like to do, continue with [Ins - [Controlling Matrix federation](configuring-playbook-federation.md) -- [Adjusting email-sending settings](configuring-playbook-email.md) - -- [Setting up Dynamic DNS](configuring-playbook-dynamic-dns.md) - ### Authentication and user-related - [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) diff --git a/docs/container-images.md b/docs/container-images.md index 5c96be450..8f4c2aa0d 100644 --- a/docs/container-images.md +++ b/docs/container-images.md @@ -33,8 +33,6 @@ 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 @@ -133,6 +131,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