From b7b2fe7fedc590e252336b30d97ecdb604b7d981 Mon Sep 17 00:00:00 2001 From: Suguru Hirahara Date: Wed, 16 Oct 2024 04:13:18 +0900 Subject: [PATCH] Use a common expression to suggest to skip the document Signed-off-by: Suguru Hirahara --- docs/configuring-playbook-client-element.md | 3 +-- docs/configuring-playbook-external-postgres.md | 3 +-- docs/configuring-playbook-own-webserver.md | 4 +--- docs/configuring-playbook-s3.md | 3 +-- docs/configuring-playbook-synapse.md | 3 +-- 5 files changed, 5 insertions(+), 11 deletions(-) diff --git a/docs/configuring-playbook-client-element.md b/docs/configuring-playbook-client-element.md index 01fb06ba7..1e4ef79e5 100644 --- a/docs/configuring-playbook-client-element.md +++ b/docs/configuring-playbook-client-element.md @@ -1,7 +1,6 @@ # Configuring Element (optional) -By default, this playbook installs the [Element](https://github.com/element-hq/element-web) Matrix web client for you. -If that's okay, you can skip this document. +By default, this playbook installs the [Element](https://github.com/element-hq/element-web) Matrix web client for you. If that's okay, you can skip this document. ## Disabling Element diff --git a/docs/configuring-playbook-external-postgres.md b/docs/configuring-playbook-external-postgres.md index 3fe5c0776..2dc591b3a 100644 --- a/docs/configuring-playbook-external-postgres.md +++ b/docs/configuring-playbook-external-postgres.md @@ -1,7 +1,6 @@ # Using an external PostgreSQL server (optional) -By default, this playbook would set up a PostgreSQL database server on your machine, running in a Docker container. -If that's alright, you can skip this. +By default, this playbook would set up a PostgreSQL database server on your machine, running in a Docker container. If that's okay, you can skip this document. **Note**: using **an external Postgres server is currently [not very seamless](https://github.com/spantaleev/matrix-docker-ansible-deploy/issues/1682#issuecomment-1061461683) when it comes to enabling various other playbook services** - you will need to create a new database/credentials for each service and to point each service to its corresponding database using custom `vars.yml` configuration. **For the best experience with the playbook, stick to using the integrated Postgres server**. diff --git a/docs/configuring-playbook-own-webserver.md b/docs/configuring-playbook-own-webserver.md index cb20f57ee..f7d1ab9d8 100644 --- a/docs/configuring-playbook-own-webserver.md +++ b/docs/configuring-playbook-own-webserver.md @@ -1,8 +1,6 @@ # 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 alright, you can skip this. +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. ## Traefik diff --git a/docs/configuring-playbook-s3.md b/docs/configuring-playbook-s3.md index f73aa7012..48f44883d 100644 --- a/docs/configuring-playbook-s3.md +++ b/docs/configuring-playbook-s3.md @@ -1,7 +1,6 @@ # Storing Synapse media files on Amazon S3 or another compatible Object Storage (optional) -By default, this playbook configures your server to store Synapse's content repository (`media_store`) files on the local filesystem. -If that's alright, you can skip this. +By default, this playbook configures your server to store Synapse's content repository (`media_store`) files on the local filesystem. If that's okay, you can skip this document. As an alternative to storing media files on the local filesystem, you can store them on [Amazon S3](https://aws.amazon.com/s3/) or another S3-compatible object store. diff --git a/docs/configuring-playbook-synapse.md b/docs/configuring-playbook-synapse.md index 9802fc093..60f764bc7 100644 --- a/docs/configuring-playbook-synapse.md +++ b/docs/configuring-playbook-synapse.md @@ -1,7 +1,6 @@ # Configuring Synapse (optional) -By default, this playbook configures the [Synapse](https://github.com/element-hq/synapse) Matrix server, so that it works for the general case. -If that's enough for you, you can skip this document. +By default, this playbook configures the [Synapse](https://github.com/element-hq/synapse) Matrix server, so that it works for the general case. If that's okay, you can skip this document. The playbook provides lots of customization variables you could use to change Synapse's settings.