Skip to content

Commit 424e5c6

Browse files
author
Suguru Hirahara
committed
Update docs/configuring-playbook-synapse-simple-antispam.md: add the section for installing
Signed-off-by: Suguru Hirahara <[email protected]>
1 parent 5adaaf7 commit 424e5c6

File tree

1 file changed

+14
-1
lines changed

1 file changed

+14
-1
lines changed

docs/configuring-playbook-synapse-simple-antispam.md

Lines changed: 14 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
<!--
22
SPDX-FileCopyrightText: 2019 Slavi Pantaleev
3-
SPDX-FileCopyrightText: 2024 Suguru Hirahara
3+
SPDX-FileCopyrightText: 2024 - 2025 Suguru Hirahara
44
55
SPDX-License-Identifier: AGPL-3.0-or-later
66
-->
@@ -24,3 +24,16 @@ matrix_synapse_ext_spam_checker_synapse_simple_antispam_config_blocked_homeserve
2424
- example.com
2525
- example.net
2626
```
27+
28+
## Installing
29+
30+
After configuring the playbook, run it with [playbook tags](playbook-tags.md) as below:
31+
32+
<!-- NOTE: let this conservative command run (instead of install-all) to make it clear that failure of the command means something is clearly broken. -->
33+
```sh
34+
ansible-playbook -i inventory/hosts setup.yml --tags=setup-all,start
35+
```
36+
37+
The shortcut commands with the [`just` program](just.md) are also available: `just install-all` or `just setup-all`
38+
39+
`just install-all` is useful for maintaining your setup quickly ([2x-5x faster](../CHANGELOG.md#2x-5x-performance-improvements-in-playbook-runtime) than `just setup-all`) when its components remain unchanged. If you adjust your `vars.yml` to remove other components, you'd need to run `just setup-all`, or these components will still remain installed. Note these shortcuts run the `ensure-matrix-users-created` tag too.

0 commit comments

Comments
 (0)