diff --git a/docs/README.md b/docs/README.md index f1765920f..0473b77e5 100644 --- a/docs/README.md +++ b/docs/README.md @@ -19,7 +19,7 @@ There are two installation guides available for beginners and advanced users. - [Prerequisites](prerequisites.md) - - [Configuring your DNS settings](configuring-dns.md) + - [Configuring DNS settings](configuring-dns.md) - [Getting the playbook](getting-the-playbook.md) diff --git a/docs/configuring-dns.md b/docs/configuring-dns.md index 2b2b425eb..b88195ec9 100644 --- a/docs/configuring-dns.md +++ b/docs/configuring-dns.md @@ -15,9 +15,9 @@ SPDX-FileCopyrightText: 2024 - 2025 Suguru Hirahara SPDX-License-Identifier: AGPL-3.0-or-later --> -# Configuring your DNS settings +# Configuring DNS settings -[Prerequisites](prerequisites.md) > Configuring your DNS settings > [Getting the playbook](getting-the-playbook.md) > [Configuring the playbook](configuring-playbook.md) > [Installing](installing.md) +[Prerequisites](prerequisites.md) > Configuring DNS settings > [Getting the playbook](getting-the-playbook.md) > [Configuring the playbook](configuring-playbook.md) > [Installing](installing.md) To set up Matrix on your domain, you'd need to do some DNS configuration. diff --git a/docs/configuring-playbook.md b/docs/configuring-playbook.md index 2220c9d3f..756986f23 100644 --- a/docs/configuring-playbook.md +++ b/docs/configuring-playbook.md @@ -16,7 +16,7 @@ SPDX-License-Identifier: AGPL-3.0-or-later # Configuring the playbook -[Prerequisites](prerequisites.md) > [Configuring your DNS settings](configuring-dns.md) > [Getting the playbook](getting-the-playbook.md) > Configuring the playbook > [Installing](installing.md) +[Prerequisites](prerequisites.md) > [Configuring DNS settings](configuring-dns.md) > [Getting the playbook](getting-the-playbook.md) > Configuring the playbook > [Installing](installing.md) If you've configured your DNS records and retrieved the playbook's source code to your computer, you can start configuring the playbook. To do so, follow these steps inside the playbook directory: @@ -24,7 +24,7 @@ If you've configured your DNS records and retrieved the playbook's source code t 2. copy the sample configuration file (`cp examples/vars.yml inventory/host_vars/matrix.example.com/vars.yml`) -3. edit the configuration file (`inventory/host_vars/matrix.example.com/vars.yml`) to your liking. You may also take a look at the various `roles/*/ROLE_NAME_HERE/defaults/main.yml` files and see if there's something you'd like to copy over and override in your `vars.yml` configuration file. +3. edit the configuration file (`inventory/host_vars/matrix.example.com/vars.yml`) to your liking. You may also take a look at the various `roles/*/ROLE_NAME_HERE/defaults/main.yml` files (after importing external roles with `just update` into `roles/galaxy`) and see if there's something you'd like to copy over and override in your `vars.yml` configuration file. 4. copy the sample inventory hosts file (`cp examples/hosts inventory/hosts`) diff --git a/docs/getting-the-playbook.md b/docs/getting-the-playbook.md index d1c951fa5..7f725038b 100644 --- a/docs/getting-the-playbook.md +++ b/docs/getting-the-playbook.md @@ -7,7 +7,7 @@ SPDX-License-Identifier: AGPL-3.0-or-later # Getting the playbook -[Prerequisites](prerequisites.md) > [Configuring your DNS settings](configuring-dns.md) > Getting the playbook > [Configuring the playbook](configuring-playbook.md) > [Installing](installing.md) +[Prerequisites](prerequisites.md) > [Configuring DNS settings](configuring-dns.md) > Getting the playbook > [Configuring the playbook](configuring-playbook.md) > [Installing](installing.md) This Ansible playbook is meant to be executed on your own computer (not the Matrix server). diff --git a/docs/installing.md b/docs/installing.md index 6bc0a463e..c11a79b2b 100644 --- a/docs/installing.md +++ b/docs/installing.md @@ -14,7 +14,7 @@ SPDX-License-Identifier: AGPL-3.0-or-later # Installing -[Prerequisites](prerequisites.md) > [Configuring your DNS settings](configuring-dns.md) > [Getting the playbook](getting-the-playbook.md) > [Configuring the playbook](configuring-playbook.md) > Installing +[Prerequisites](prerequisites.md) > [Configuring DNS settings](configuring-dns.md) > [Getting the playbook](getting-the-playbook.md) > [Configuring the playbook](configuring-playbook.md) > Installing If you've configured your DNS records and the playbook, you can start the installation procedure. diff --git a/docs/maintenance-postgres.md b/docs/maintenance-postgres.md index 7beff8e7c..70596f90f 100644 --- a/docs/maintenance-postgres.md +++ b/docs/maintenance-postgres.md @@ -5,7 +5,7 @@ SPDX-FileCopyrightText: 2020 Hardy Erlinger SPDX-FileCopyrightText: 2021 - 2024 MDAD project contributors SPDX-FileCopyrightText: 2021 Marc Leuser SPDX-FileCopyrightText: 2024 Kim Brose -SPDX-FileCopyrightText: 2024 Suguru Hirahara +SPDX-FileCopyrightText: 2024 - 2025 Suguru Hirahara SPDX-License-Identifier: AGPL-3.0-or-later --> @@ -23,7 +23,7 @@ Table of contents: ## Getting a database terminal -You can use the `/matrix/postgres/bin/cli` tool to get interactive terminal access ([psql](https://www.postgresql.org/docs/11/app-psql.html)) to the PostgreSQL server. +You can use the `/matrix/postgres/bin/cli` tool to get interactive terminal access ([psql](https://www.postgresql.org/docs/current/app-psql.html)) to the PostgreSQL server. If you are using an [external Postgres server](configuring-playbook-external-postgres.md), the above tool will not be available. @@ -59,9 +59,9 @@ Example playbook invocations: ## Backing up PostgreSQL -To automatically make Postgres database backups on a fixed schedule, see [Setting up Postgres backup](configuring-playbook-postgres-backup.md). +To automatically make Postgres database backups on a fixed schedule, consider enabling the [Postgres Backup](configuring-playbook-postgres-backup.md) service. -To make a one off back up of the current PostgreSQL database, make sure it's running and then execute a command like this on the server: +To make a one-off back up of the current PostgreSQL database, make sure it's running and then execute a command like this on the server: ```sh /usr/bin/docker exec \ diff --git a/docs/prerequisites.md b/docs/prerequisites.md index 0e65548b5..dc0b73e5d 100644 --- a/docs/prerequisites.md +++ b/docs/prerequisites.md @@ -11,7 +11,7 @@ SPDX-License-Identifier: AGPL-3.0-or-later # Prerequisites -Prerequisites > [Configuring your DNS settings](configuring-dns.md) > [Getting the playbook](getting-the-playbook.md) > [Configuring the playbook](configuring-playbook.md) > [Installing](installing.md) +Prerequisites > [Configuring DNS settings](configuring-dns.md) > [Getting the playbook](getting-the-playbook.md) > [Configuring the playbook](configuring-playbook.md) > [Installing](installing.md) To install Matrix services using this Ansible playbook, you need to prepare several requirements both on your local computer (where you will run the playbook to configure the server) and the server (where the playbook will install the Matrix services for you). **These requirements need to be set up manually** before proceeding to the next step. diff --git a/docs/quick-start.md b/docs/quick-start.md index cedb18a9d..21b8515e2 100644 --- a/docs/quick-start.md +++ b/docs/quick-start.md @@ -37,7 +37,7 @@ One of the main reasons of basic errors is using an incompatible version of requ ## Configure your DNS settings -This section is optimized for this quick-start guide and is derived from the following full-documentation page: [Configuring your DNS settings](configuring-dns.md) +This section is optimized for this quick-start guide and is derived from the following full-documentation page: [Configuring DNS settings](configuring-dns.md) After installing and configuring prerequisites, you will need to **configure DNS records**.