Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>pull/3811/head
| @@ -15,6 +15,8 @@ To update your playbook directory and all upstream Ansible roles (defined in the | |||||
| If you don't have either `just` tool or `make` program, you can run the `ansible-galaxy` tool directly: `rm -rf roles/galaxy; ansible-galaxy install -r requirements.yml -p roles/galaxy/ --force` | If you don't have either `just` tool or `make` program, you can run the `ansible-galaxy` tool directly: `rm -rf roles/galaxy; ansible-galaxy install -r requirements.yml -p roles/galaxy/ --force` | ||||
| For details about `just` commands, take a look at: [Running `just` commands](just.md). | |||||
| ## Install Matrix server and services | ## 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. | The Ansible playbook's tasks are tagged, so that certain parts of the Ansible playbook can be run without running all other tasks. | ||||
| @@ -51,7 +53,7 @@ To do the installation **without** starting services, run `ansible-playbook` wit | |||||
| ansible-playbook -i inventory/hosts setup.yml --tags=install-all | ansible-playbook -i inventory/hosts setup.yml --tags=install-all | ||||
| ``` | ``` | ||||
| **Note**: do not run the just "recipe" `just install-all` instead, because it automatically starts services at the end of execution. | |||||
| **Note**: do not run the just "recipe" `just install-all` instead, because it automatically starts services at the end of execution. See: [Difference between playbook tags and shortcuts](just.md#difference-between-playbook-tags-and-shortcuts) | |||||
| When this command completes, services won't be running yet. | When this command completes, services won't be running yet. | ||||
| @@ -25,6 +25,8 @@ If it looks good to you, go to the `matrix-docker-ansible-deploy` directory, the | |||||
| If you don't have either `just` tool or `make` program, you can run the `ansible-galaxy` tool directly: `rm -rf roles/galaxy; ansible-galaxy install -r requirements.yml -p roles/galaxy/ --force` | If you don't have either `just` tool or `make` program, you can run the `ansible-galaxy` tool directly: `rm -rf roles/galaxy; ansible-galaxy install -r requirements.yml -p roles/galaxy/ --force` | ||||
| For details about `just` commands, take a look at: [Running `just` commands](just.md). | |||||
| - re-run the [playbook setup](installing.md#maintaining-your-setup-in-the-future) and restart all services: | - re-run the [playbook setup](installing.md#maintaining-your-setup-in-the-future) and restart all services: | ||||
| ```sh | ```sh | ||||
| @@ -33,6 +35,6 @@ If it looks good to you, go to the `matrix-docker-ansible-deploy` directory, the | |||||
| 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. | 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 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. If you don't have `just`, you can also manually run the commands seen in the `justfile`. | |||||
| A way to invoke these `ansible-playbook` commands with less typing is to run the `just` "recipe": `just install-all` or `just setup-all`. | |||||
| **Note**: major version upgrades to the internal PostgreSQL database are not done automatically. To upgrade it, refer to the [upgrading PostgreSQL guide](maintenance-postgres.md#upgrading-postgresql). | **Note**: major version upgrades to the internal PostgreSQL database are not done automatically. To upgrade it, refer to the [upgrading PostgreSQL guide](maintenance-postgres.md#upgrading-postgresql). | ||||
| @@ -22,4 +22,4 @@ Here are some playbook tags that you should be familiar with: | |||||
| **Notes**: | **Notes**: | ||||
| - `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. | - `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. | ||||
| - Please be careful not to confuse the playbook tags with the `just` shortcut commands ("recipes"). For details on `just` commands, see: [Running `just` commands](just.md) | |||||
| - Please be careful not to confuse the playbook tags with the `just` shortcut commands ("recipes"). For details about `just` commands, see: [Running `just` commands](just.md) | |||||
| @@ -14,7 +14,7 @@ We will be using `example.com` as the domain in the following instruction. Pleas | |||||
| - [`git`](https://git-scm.com/) as the recommended way to download the playbook. `git` may also be required on the server if you will be [self-building](self-building.md) components. | - [`git`](https://git-scm.com/) as the recommended way to download the playbook. `git` may also be required on the server if you will be [self-building](self-building.md) components. | ||||
| - [`just`](https://github.com/casey/just) for running `just roles`, `just update`, etc. (see [`justfile`](../justfile)), although you can also run these commands manually | |||||
| - [`just`](https://github.com/casey/just) for running `just roles`, `just update`, etc. (see [`justfile`](../justfile)), although you can also run these commands manually. Take at look at this documentation for more information: [Running `just` commands](just.md). | |||||
| - Strong password (random strings) generator. The playbook often requires you to create a strong password and use it for settings on `vars.yml`, components, etc. As any tools should be fine, this playbook has adopted [`pwgen`](https://linux.die.net/man/1/pwgen) (running `pwgen -s 64 1`). [Password Tech](https://pwgen-win.sourceforge.io/), formerly known as "PWGen for Windows", is available as free and open source password generator for Windows. Generally, using a random generator available on the internet is not recommended. | - Strong password (random strings) generator. The playbook often requires you to create a strong password and use it for settings on `vars.yml`, components, etc. As any tools should be fine, this playbook has adopted [`pwgen`](https://linux.die.net/man/1/pwgen) (running `pwgen -s 64 1`). [Password Tech](https://pwgen-win.sourceforge.io/), formerly known as "PWGen for Windows", is available as free and open source password generator for Windows. Generally, using a random generator available on the internet is not recommended. | ||||