From e02dd88ed0c437707d7b6d45cfe47ee9d1f2615b Mon Sep 17 00:00:00 2001 From: Suguru Hirahara Date: Fri, 8 Nov 2024 23:42:06 +0900 Subject: [PATCH 01/14] Update docs/installing.md: add instruction to serve the base domain The instruction describes the easiest way of configuring Service Discovery (which is required for federation) should help to understand what basically to be done to finalize the installation. Signed-off-by: Suguru Hirahara --- docs/installing.md | 13 ++++++++++++- 1 file changed, 12 insertions(+), 1 deletion(-) diff --git a/docs/installing.md b/docs/installing.md index 4bae27d8f..a1459919a 100644 --- a/docs/installing.md +++ b/docs/installing.md @@ -100,10 +100,21 @@ A way to invoke these `ansible-playbook` commands with less typing in the future Now that services are running, you need to **finalize the installation process** (required for federation to work!) by [Configuring Service Discovery via .well-known](configuring-well-known.md). +If you need the base domain for anything else (such as hosting a website), you have to configure it manually, following the procedure described on the linked documentation. + +However, if you do not need the base domain (`example.com`) for anything else, the easiest way of configuring it is to [serve the base domain](configuring-playbook-base-domain-serving.md) from the integrated web server. It will enable you to use a Matrix user identifier like `@:example.com` while hosting services on a subdomain like `matrix.example.com`. + +To configure Service Discovery in this way, add the following configuration to your `inventory/host_vars/matrix.example.com/vars.yml` file: + +```yaml +matrix_static_files_container_labels_base_domain_enabled: true +``` + +After configuring the playbook, run the [installation](installing.md) command: `just install-all` or `just setup-all` ## 4. Things to do next -After you have started the services and **finalized the installation process** (required for federation to work!) by [Configuring Service Discovery via .well-known](configuring-well-known.md), you can: +After finilizing the installation, you can: - [check if services work](maintenance-checking-services.md) - or [create your first Matrix user account](registering-users.md) From 578b6b7ab7eed7396b0e1b225073a93546c600fa Mon Sep 17 00:00:00 2001 From: Suguru Hirahara Date: Sat, 9 Nov 2024 00:19:04 +0900 Subject: [PATCH 02/14] Update docs/installing.md: move "Maintaining your setup in the future" under "Things to do next" Maintenance work by running the playbook will be required after finalizing the installation Signed-off-by: Suguru Hirahara --- docs/installing.md | 18 ++++++++---------- 1 file changed, 8 insertions(+), 10 deletions(-) diff --git a/docs/installing.md b/docs/installing.md index a1459919a..f4b89582b 100644 --- a/docs/installing.md +++ b/docs/installing.md @@ -86,16 +86,6 @@ ansible-playbook -i inventory/hosts setup.yml --tags=start Proceed to [Maintaining your setup in the future](#2-maintaining-your-setup-in-the-future) and [Finalize the installation](#3-finalize-the-installation) - -## 2. Maintaining your setup in the future - -Feel free to **re-run the setup command any time** you think something is off with the server configuration. Ansible will take your configuration and update your server to match. - -Note that if you remove components from `vars.yml`, or if we switch some component from being installed by default to not being installed by default anymore, you'd need to run the setup command with `--tags=setup-all` instead of `--tags=install-all`. See [Playbook tags introduction](#playbook-tags-introduction) - -A way to invoke these `ansible-playbook` commands with less typing in the future is to use [just](https://github.com/casey/just) to run them: `just install-all` or `just setup-all`. See [our `justfile`](../justfile) for more information. - - ## 3. Finalize the installation Now that services are running, you need to **finalize the installation process** (required for federation to work!) by [Configuring Service Discovery via .well-known](configuring-well-known.md). @@ -125,3 +115,11 @@ After finilizing the installation, you can: * via the *Explore rooms* feature in Element Web or some other clients, or by discovering them using this [matrix-static list](https://view.matrix.org). **Note**: joining large rooms may overload small servers. * or come say Hi in our support room - [#matrix-docker-ansible-deploy:devture.com](https://matrix.to/#/#matrix-docker-ansible-deploy:devture.com). You might learn something or get to help someone else new to Matrix hosting. - or help make this playbook better by contributing (code, documentation, or [coffee/beer](https://liberapay.com/s.pantaleev/donate)) + +### Maintaining your setup in the future + +Feel free to **re-run the setup command any time** you think something is off with the server configuration. Ansible will take your configuration and update your server to match. + +Note that if you remove components from `vars.yml`, or if we switch some component from being installed by default to not being installed by default anymore, you'd need to run the setup command with `--tags=setup-all` instead of `--tags=install-all`. See [Playbook tags introduction](#playbook-tags-introduction) + +A way to invoke these `ansible-playbook` commands with less typing in the future is to use [just](https://github.com/casey/just) to run them: `just install-all` or `just setup-all`. See [our `justfile`](../justfile) for more information. From 66a812d99c12cb24f38f57fb271875ca80a9d4cc Mon Sep 17 00:00:00 2001 From: Suguru Hirahara Date: Sat, 9 Nov 2024 00:21:58 +0900 Subject: [PATCH 03/14] Update docs/installing.md: remove numbering from headers and links to the headers Remove nagivations for simplicity. Signed-off-by: Suguru Hirahara --- docs/installing.md | 11 +++-------- 1 file changed, 3 insertions(+), 8 deletions(-) diff --git a/docs/installing.md b/docs/installing.md index f4b89582b..50926fca8 100644 --- a/docs/installing.md +++ b/docs/installing.md @@ -34,7 +34,7 @@ Here are some playbook tags that you should be familiar with: `setup-*` tags and `install-*` tags **do not start services** automatically, because you may wish to do things before starting services, such as importing a database dump, restoring data from another server, etc. -## 1. Installing Matrix +## Install Matrix If you **don't** use SSH keys for authentication, but rather a regular password, you may need to add `--ask-pass` to the all Ansible commands @@ -53,9 +53,6 @@ ansible-playbook -i inventory/hosts setup.yml --tags=install-all,ensure-matrix-u This will do a full installation and start all Matrix services. -Proceed to [Maintaining your setup in the future](#2-maintaining-your-setup-in-the-future) and [Finalize the installation](#3-finalize-the-installation) - - ### Installing a server into which you'll import old data If you will be importing data into your newly created Matrix server, install it, but **do not** start its services just yet. Starting its services or messing with its database now will affect your data import later on. @@ -84,9 +81,7 @@ You can now: ansible-playbook -i inventory/hosts setup.yml --tags=start ``` -Proceed to [Maintaining your setup in the future](#2-maintaining-your-setup-in-the-future) and [Finalize the installation](#3-finalize-the-installation) - -## 3. Finalize the installation +## Finalize the installation Now that services are running, you need to **finalize the installation process** (required for federation to work!) by [Configuring Service Discovery via .well-known](configuring-well-known.md). @@ -102,7 +97,7 @@ matrix_static_files_container_labels_base_domain_enabled: true After configuring the playbook, run the [installation](installing.md) command: `just install-all` or `just setup-all` -## 4. Things to do next +## Things to do next After finilizing the installation, you can: From ea48e5e9ebb0ae09996e6471390f8abeb0ce44fc Mon Sep 17 00:00:00 2001 From: Suguru Hirahara Date: Sat, 9 Nov 2024 00:40:19 +0900 Subject: [PATCH 04/14] Create docs/playbook-tags.md: move explanation about playbook tags The playbook tags are not limited to installation, and the explanation's detail makes the section worth being split to a dedicated individual page. Signed-off-by: Suguru Hirahara --- docs/README.md | 2 ++ docs/installing.md | 29 +++-------------------------- docs/playbook-tags.md | 23 +++++++++++++++++++++++ 3 files changed, 28 insertions(+), 26 deletions(-) create mode 100644 docs/playbook-tags.md diff --git a/docs/README.md b/docs/README.md index 77c5099df..3fdf8bd6a 100644 --- a/docs/README.md +++ b/docs/README.md @@ -12,6 +12,8 @@ - [Installing](installing.md) +- [Playbook tags](playbook-tags.md) + - **Importing data from another server installation** - [Importing an existing SQLite database (from another Synapse installation)](importing-synapse-sqlite.md) (optional) diff --git a/docs/installing.md b/docs/installing.md index 50926fca8..64f256025 100644 --- a/docs/installing.md +++ b/docs/installing.md @@ -8,33 +8,11 @@ If you've [configured your DNS](configuring-dns.md) and have [configured the pla There's another shortcut (`just update`) which updates the playbook (`git pull`) and updates roles (`just roles`) at the same time. - -## Playbook tags introduction +## Install Matrix The Ansible playbook's tasks are tagged, so that certain parts of the Ansible playbook can be run without running all other tasks. -The general command syntax is: `ansible-playbook -i inventory/hosts setup.yml --tags=COMMA_SEPARATED_TAGS_GO_HERE` - -Here are some playbook tags that you should be familiar with: - -- `setup-all` - runs all setup tasks (installation and uninstallation) for all components, but does not start/restart services - -- `install-all` - like `setup-all`, but skips uninstallation tasks. Useful for maintaining your setup quickly when its components remain unchanged. If you adjust your `vars.yml` to remove components, you'd need to run `setup-all` though, or these components will still remain installed - -- `setup-SERVICE` (e.g. `setup-postmoogle`) - runs the setup tasks only for a given role, but does not start/restart services. You can discover these additional tags in each role (`roles/**/tasks/main.yml`). Running per-component setup tasks is **not recommended**, as components sometimes depend on each other and running just the setup tasks for a given component may not be enough. For example, setting up the [mautrix-telegram bridge](configuring-playbook-bridge-mautrix-telegram.md), in addition to the `setup-mautrix-telegram` tag, requires database changes (the `setup-postgres` tag) as well as reverse-proxy changes (the `setup-nginx-proxy` tag). - -- `install-SERVICE` (e.g. `install-postmoogle`) - like `setup-SERVICE`, but skips uninstallation tasks. See `install-all` above for additional information. - -- `start` - starts all systemd services and makes them start automatically in the future - -- `stop` - stops all systemd services - -- `ensure-matrix-users-created` - a special tag which ensures that all special users needed by the playbook (for bots, etc.) are created - -`setup-*` tags and `install-*` tags **do not start services** automatically, because you may wish to do things before starting services, such as importing a database dump, restoring data from another server, etc. - - -## Install Matrix +The general command syntax for installation (and also maintenance) is: `ansible-playbook -i inventory/hosts setup.yml --tags=COMMA_SEPARATED_TAGS_GO_HERE`. It is recommended to get yourself familiar with the [playbook tags](playbook-tags.md) before proceeding. If you **don't** use SSH keys for authentication, but rather a regular password, you may need to add `--ask-pass` to the all Ansible commands @@ -42,7 +20,6 @@ If you **do** use SSH keys for authentication, **and** use a non-root user to *b There 2 ways to start the installation process - depending on whether you're [Installing a brand new server (without importing data)](#installing-a-brand-new-server-without-importing-data) or [Installing a server into which you'll import old data](#installing-a-server-into-which-youll-import-old-data). - ### Installing a brand new server (without importing data) If this is **a brand new** Matrix server and you **won't be importing old data into it**, run all these tags: @@ -115,6 +92,6 @@ After finilizing the installation, you can: Feel free to **re-run the setup command any time** you think something is off with the server configuration. Ansible will take your configuration and update your server to match. -Note that if you remove components from `vars.yml`, or if we switch some component from being installed by default to not being installed by default anymore, you'd need to run the setup command with `--tags=setup-all` instead of `--tags=install-all`. See [Playbook tags introduction](#playbook-tags-introduction) +Note that if you remove components from `vars.yml`, or if we switch some component from being installed by default to not being installed by default anymore, you'd need to run the setup command with `--tags=setup-all` instead of `--tags=install-all`. See [this page on the playbook tags](playbook-tags.md) for more information. A way to invoke these `ansible-playbook` commands with less typing in the future is to use [just](https://github.com/casey/just) to run them: `just install-all` or `just setup-all`. See [our `justfile`](../justfile) for more information. diff --git a/docs/playbook-tags.md b/docs/playbook-tags.md new file mode 100644 index 000000000..0699164d0 --- /dev/null +++ b/docs/playbook-tags.md @@ -0,0 +1,23 @@ +# Playbook tags + +The Ansible playbook's tasks are tagged, so that certain parts of the Ansible playbook can be run without running all other tasks. + +The general command syntax is: `ansible-playbook -i inventory/hosts setup.yml --tags=COMMA_SEPARATED_TAGS_GO_HERE` + +Here are some playbook tags that you should be familiar with: + +- `setup-all` - runs all setup tasks (installation and uninstallation) for all components, but does not start/restart services + +- `install-all` - like `setup-all`, but skips uninstallation tasks. Useful for maintaining your setup quickly when its components remain unchanged. If you adjust your `vars.yml` to remove components, you'd need to run `setup-all` though, or these components will still remain installed + +- `setup-SERVICE` (e.g. `setup-postmoogle`) - runs the setup tasks only for a given role, but does not start/restart services. You can discover these additional tags in each role (`roles/**/tasks/main.yml`). Running per-component setup tasks is **not recommended**, as components sometimes depend on each other and running just the setup tasks for a given component may not be enough. For example, setting up the [mautrix-telegram bridge](configuring-playbook-bridge-mautrix-telegram.md), in addition to the `setup-mautrix-telegram` tag, requires database changes (the `setup-postgres` tag) as well as reverse-proxy changes (the `setup-nginx-proxy` tag). + +- `install-SERVICE` (e.g. `install-postmoogle`) - like `setup-SERVICE`, but skips uninstallation tasks. See `install-all` above for additional information. + +- `start` - starts all systemd services and makes them start automatically in the future + +- `stop` - stops all systemd services + +- `ensure-matrix-users-created` - a special tag which ensures that all special users needed by the playbook (for bots, etc.) are created + +`setup-*` tags and `install-*` tags **do not start services** automatically, because you may wish to do things before starting services, such as importing a database dump, restoring data from another server, etc. From 5dccd4e1069926690ac897d4b55dad40ff6b2f2b Mon Sep 17 00:00:00 2001 From: Suguru Hirahara Date: Sat, 9 Nov 2024 00:48:57 +0900 Subject: [PATCH 05/14] Update docs/installing.md: create "Update Ansible roles" section Also: mention running "just" role on maintainance Signed-off-by: Suguru Hirahara --- docs/installing.md | 8 ++++++-- 1 file changed, 6 insertions(+), 2 deletions(-) diff --git a/docs/installing.md b/docs/installing.md index 64f256025..6a1f14c54 100644 --- a/docs/installing.md +++ b/docs/installing.md @@ -4,7 +4,11 @@ If you've [configured your DNS](configuring-dns.md) and have [configured the playbook](configuring-playbook.md), you can start the installation procedure. -**Before installing** and each time you update the playbook in the future, you will need to update the Ansible roles in this playbook by running `just roles`. `just roles` is a shortcut (a `roles` target defined in [`justfile`](../justfile) and executed by the [`just`](https://github.com/casey/just) utility) which ultimately runs [agru](https://github.com/etkecc/agru) or [ansible-galaxy](https://docs.ansible.com/ansible/latest/cli/ansible-galaxy.html) (depending on what is available in your system) to download Ansible roles. If you don't have `just`, you can also manually run the `roles` commands seen in the `justfile`. +## Update Ansible roles + +Before installing, you need to update the Ansible roles in this playbook by running `just roles`. + +`just roles` is a shortcut (a `roles` target defined in [`justfile`](../justfile) and executed by the [`just`](https://github.com/casey/just) utility) which ultimately runs [agru](https://github.com/etkecc/agru) or [ansible-galaxy](https://docs.ansible.com/ansible/latest/cli/ansible-galaxy.html) (depending on what is available in your system) to download Ansible roles. If you don't have `just`, you can also manually run the `roles` commands seen in the `justfile`. There's another shortcut (`just update`) which updates the playbook (`git pull`) and updates roles (`just roles`) at the same time. @@ -90,7 +94,7 @@ After finilizing the installation, you can: ### Maintaining your setup in the future -Feel free to **re-run the setup command any time** you think something is off with the server configuration. Ansible will take your configuration and update your server to match. +Feel free to **re-run the setup command any time** you think something is off with the server configuration. Ansible will take your configuration and update your server to match. To update the playbook and the Ansible roles in the playbook, simply run `just roles`. Note that if you remove components from `vars.yml`, or if we switch some component from being installed by default to not being installed by default anymore, you'd need to run the setup command with `--tags=setup-all` instead of `--tags=install-all`. See [this page on the playbook tags](playbook-tags.md) for more information. From 5e23dee4bb7a8e9766eabbfe9c0e16d3084d7a27 Mon Sep 17 00:00:00 2001 From: Suguru Hirahara Date: Sat, 9 Nov 2024 02:10:06 +0900 Subject: [PATCH 06/14] Update docs/installing.md: add missing periods Signed-off-by: Suguru Hirahara --- docs/installing.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/installing.md b/docs/installing.md index 6a1f14c54..de3524dfc 100644 --- a/docs/installing.md +++ b/docs/installing.md @@ -18,9 +18,9 @@ The Ansible playbook's tasks are tagged, so that certain parts of the Ansible pl The general command syntax for installation (and also maintenance) is: `ansible-playbook -i inventory/hosts setup.yml --tags=COMMA_SEPARATED_TAGS_GO_HERE`. It is recommended to get yourself familiar with the [playbook tags](playbook-tags.md) before proceeding. -If you **don't** use SSH keys for authentication, but rather a regular password, you may need to add `--ask-pass` to the all Ansible commands +If you **don't** use SSH keys for authentication, but rather a regular password, you may need to add `--ask-pass` to the all Ansible commands. -If you **do** use SSH keys for authentication, **and** use a non-root user to *become* root (sudo), you may need to add `-K` (`--ask-become-pass`) to all Ansible commands +If you **do** use SSH keys for authentication, **and** use a non-root user to *become* root (sudo), you may need to add `-K` (`--ask-become-pass`) to all Ansible commands. There 2 ways to start the installation process - depending on whether you're [Installing a brand new server (without importing data)](#installing-a-brand-new-server-without-importing-data) or [Installing a server into which you'll import old data](#installing-a-server-into-which-youll-import-old-data). From e6b4ffdd935c3e2aa0822b7beba66df7d1c816d2 Mon Sep 17 00:00:00 2001 From: Suguru Hirahara Date: Sat, 9 Nov 2024 02:26:38 +0900 Subject: [PATCH 07/14] Update docs/installing.md: add note about making sure of proper installation of required software Until recently there have been a lot of questions about installing, which could have been avoided if required software such as compatible version of Ansible was installed. This note should encourage those who experience basic error to troubleshoot before giving up. Signed-off-by: Suguru Hirahara --- docs/installing.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/docs/installing.md b/docs/installing.md index de3524dfc..491d8a81c 100644 --- a/docs/installing.md +++ b/docs/installing.md @@ -34,6 +34,8 @@ ansible-playbook -i inventory/hosts setup.yml --tags=install-all,ensure-matrix-u This will do a full installation and start all Matrix services. +**Note**: if the command does not work as expected, make sure that you have properly installed and configured software required to run the playbook, as described on [Prerequisites](prerequisites.md). + ### Installing a server into which you'll import old data If you will be importing data into your newly created Matrix server, install it, but **do not** start its services just yet. Starting its services or messing with its database now will affect your data import later on. From f8b44a8eca26442ff540d0b2288b9803426410a2 Mon Sep 17 00:00:00 2001 From: Suguru Hirahara Date: Sat, 9 Nov 2024 03:02:08 +0900 Subject: [PATCH 08/14] Update docs/installing.md: mention just's "recipe" Signed-off-by: Suguru Hirahara --- docs/installing.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/installing.md b/docs/installing.md index 491d8a81c..83b5f5144 100644 --- a/docs/installing.md +++ b/docs/installing.md @@ -100,4 +100,4 @@ Feel free to **re-run the setup command any time** you think something is off wi Note that if you remove components from `vars.yml`, or if we switch some component from being installed by default to not being installed by default anymore, you'd need to run the setup command with `--tags=setup-all` instead of `--tags=install-all`. See [this page on the playbook tags](playbook-tags.md) for more information. -A way to invoke these `ansible-playbook` commands with less typing in the future is to use [just](https://github.com/casey/just) to run them: `just install-all` or `just setup-all`. See [our `justfile`](../justfile) for more information. +A way to invoke these `ansible-playbook` commands with less typing in the future is to use [just](https://github.com/casey/just) to run the "recipe": `just install-all` or `just setup-all`. See [our `justfile`](../justfile) for more information. From 50d1a8558e407664e3551a6e144c7b0417e56176 Mon Sep 17 00:00:00 2001 From: Suguru Hirahara Date: Sat, 9 Nov 2024 03:54:42 +0900 Subject: [PATCH 09/14] Update docs/installing.md: edit the heading "Install Matrix" Matrix is a name of the protocol and it does not really make sense to install it. Signed-off-by: Suguru Hirahara --- docs/installing.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/installing.md b/docs/installing.md index 83b5f5144..023d808e7 100644 --- a/docs/installing.md +++ b/docs/installing.md @@ -12,7 +12,7 @@ Before installing, you need to update the Ansible roles in this playbook by runn There's another shortcut (`just update`) which updates the playbook (`git pull`) and updates roles (`just roles`) at the same time. -## Install Matrix +## Install Matrix server and services The Ansible playbook's tasks are tagged, so that certain parts of the Ansible playbook can be run without running all other tasks. From 5a85bec8956cf6643e04cf1558ddffccc221da00 Mon Sep 17 00:00:00 2001 From: Suguru Hirahara Date: Sat, 9 Nov 2024 12:12:43 +0900 Subject: [PATCH 10/14] Update docs/installing.md: move `example.com` base domain Signed-off-by: Suguru Hirahara --- docs/installing.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/installing.md b/docs/installing.md index 023d808e7..9b0d79c9f 100644 --- a/docs/installing.md +++ b/docs/installing.md @@ -68,9 +68,9 @@ ansible-playbook -i inventory/hosts setup.yml --tags=start Now that services are running, you need to **finalize the installation process** (required for federation to work!) by [Configuring Service Discovery via .well-known](configuring-well-known.md). -If you need the base domain for anything else (such as hosting a website), you have to configure it manually, following the procedure described on the linked documentation. +If you need the base domain (`example.com`) for anything else such as hosting a website, you have to configure it manually, following the procedure described on the linked documentation. -However, if you do not need the base domain (`example.com`) for anything else, the easiest way of configuring it is to [serve the base domain](configuring-playbook-base-domain-serving.md) from the integrated web server. It will enable you to use a Matrix user identifier like `@:example.com` while hosting services on a subdomain like `matrix.example.com`. +However, if you do not need the base domain for anything else, the easiest way of configuring it is to [serve the base domain](configuring-playbook-base-domain-serving.md) from the integrated web server. It will enable you to use a Matrix user identifier like `@:example.com` while hosting services on a subdomain like `matrix.example.com`. To configure Service Discovery in this way, add the following configuration to your `inventory/host_vars/matrix.example.com/vars.yml` file: From 58603d79bc3c268b60befc30de556ca7dadd71fa Mon Sep 17 00:00:00 2001 From: Suguru Hirahara Date: Sat, 9 Nov 2024 13:53:17 +0900 Subject: [PATCH 11/14] Update docs/installing.md: replace the just recipe with the ansible-playbook command The concept of the just recipe is explained at the bottom of the page, therefore it should be safe to avoid using it here and prefer the ansible-playbook command like above. Signed-off-by: Suguru Hirahara --- docs/installing.md | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/docs/installing.md b/docs/installing.md index 9b0d79c9f..f67b9ce01 100644 --- a/docs/installing.md +++ b/docs/installing.md @@ -78,7 +78,11 @@ To configure Service Discovery in this way, add the following configuration to y matrix_static_files_container_labels_base_domain_enabled: true ``` -After configuring the playbook, run the [installation](installing.md) command: `just install-all` or `just setup-all` +After configuring the playbook, run the [installation](installing.md) command: + +```sh +ansible-playbook -i inventory/hosts setup.yml --tags=setup-all,start +``` ## Things to do next From 6d1b4781c93f9d82946f40112fcf901bcb5a1304 Mon Sep 17 00:00:00 2001 From: Suguru Hirahara Date: Sat, 9 Nov 2024 14:08:27 +0900 Subject: [PATCH 12/14] Update docs/installing.md: remove the link to itself Signed-off-by: Suguru Hirahara --- docs/installing.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/installing.md b/docs/installing.md index f67b9ce01..c431cb42b 100644 --- a/docs/installing.md +++ b/docs/installing.md @@ -78,7 +78,7 @@ To configure Service Discovery in this way, add the following configuration to y matrix_static_files_container_labels_base_domain_enabled: true ``` -After configuring the playbook, run the [installation](installing.md) command: +After configuring the playbook, run the installation command: ```sh ansible-playbook -i inventory/hosts setup.yml --tags=setup-all,start From 60dca4dd46169be252b5a29a26abe311b086de40 Mon Sep 17 00:00:00 2001 From: Suguru Hirahara Date: Sat, 9 Nov 2024 17:33:27 +0900 Subject: [PATCH 13/14] Update docs/installing.md Co-authored-by: Slavi Pantaleev --- docs/installing.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/installing.md b/docs/installing.md index c431cb42b..a4c9dfa3f 100644 --- a/docs/installing.md +++ b/docs/installing.md @@ -61,7 +61,7 @@ You can now: .. and then proceed to starting all services: ```sh -ansible-playbook -i inventory/hosts setup.yml --tags=start +ansible-playbook -i inventory/hosts setup.yml --tags=ensure-matrix-users-created,start ``` ## Finalize the installation From 61f7f8ff50e32c1b296347e80c554e355ee73e2d Mon Sep 17 00:00:00 2001 From: Suguru Hirahara Date: Sat, 9 Nov 2024 17:35:52 +0900 Subject: [PATCH 14/14] Update docs/installing.md Co-authored-by: Slavi Pantaleev --- docs/installing.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/installing.md b/docs/installing.md index a4c9dfa3f..7541c6593 100644 --- a/docs/installing.md +++ b/docs/installing.md @@ -81,7 +81,7 @@ matrix_static_files_container_labels_base_domain_enabled: true After configuring the playbook, run the installation command: ```sh -ansible-playbook -i inventory/hosts setup.yml --tags=setup-all,start +ansible-playbook -i inventory/hosts setup.yml --tags=install-all,start ``` ## Things to do next