Просмотр исходного кода

Update docs/configuring-playbook-matrix-corporal.md and docs/configuring-playbook-email2matrix.md: adopt common instructions

Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
pull/3842/head
Suguru Hirahara 1 год назад
Родитель
Сommit
87845a9cd4
Не найден GPG ключ соответствующий данной подписи Идентификатор GPG ключа: E4F9743DAB4B7B75
2 измененных файлов: 21 добавлений и 3 удалений
  1. +12
    -2
      docs/configuring-playbook-email2matrix.md
  2. +9
    -1
      docs/configuring-playbook-matrix-corporal.md

+ 12
- 2
docs/configuring-playbook-email2matrix.md Просмотреть файл

@@ -83,6 +83,16 @@ Refer to the official documentation [here](https://github.com/devture/email2matr

## Installing

To enable Email2Matrix, run the [installation](installing.md) command (`--tags=setup-email2matrix,start`).
To enable Email2Matrix, run the playbook with [playbook tags](playbook-tags.md) as below:

After installation, you may wish to send a test email to the email address assigned to `mailbox1` (default: `mailbox1@matrix.example.com`) to make sure that Email2Matrix works as expected.
```sh
ansible-playbook -i inventory/hosts setup.yml --tags=setup-email2matrix,start
```

**Notes**:

- The shortcut commands with `just` program are also available: `just run-tags setup-email2matrix,start` or `just run-tags setup-all,start`

`just run-tags setup-email2matrix,start` is useful for maintaining your setup quickly when its components remain unchanged. If you adjust your `vars.yml` to remove other components, you'd need to run `just run-tags setup-all,start`, or these components will still remain installed. For more information about `just` shortcuts, take a look at this page: [Running `just` commands](just.md)

- After installation, you may wish to send a test email to the email address assigned to `mailbox1` (default: `mailbox1@matrix.example.com`) to make sure that Email2Matrix works as expected.

+ 9
- 1
docs/configuring-playbook-matrix-corporal.md Просмотреть файл

@@ -116,8 +116,16 @@ To learn more about what the policy configuration, see the matrix-corporal docum

## Installing

After configuring the playbook, run the [installation](installing.md) command (`--tags=setup-all,start` or `--tags=setup-aux-files,setup-corporal,start`).
After configuring the playbook, run it with [playbook tags](playbook-tags.md) as below:

<!-- NOTE: let this conservative command run (instead of install-all) to make it clear that failure of the command means something is clearly broken. -->
```sh
ansible-playbook -i inventory/hosts setup.yml --tags=setup-all,start
```

The shortcut commands with `just` program are also available: `just run-tags setup-aux-files,setup-corporal,start` or `just run-tags setup-all,start`

`just run-tags setup-aux-files,setup-corporal,start` is useful for maintaining your setup quickly when its components remain unchanged. If you adjust your `vars.yml` to remove other components, you'd need to run `just run-tags setup-all,start`, or these components will still remain installed. For more information about `just` shortcuts, take a look at this page: [Running `just` commands](just.md)

## Matrix Corporal files



Загрузка…
Отмена
Сохранить