aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authornico wellpott <nico@magicbroccoli.de>2021-04-16 22:09:40 +0200
committernico wellpott <nico@magicbroccoli.de>2021-04-16 22:09:40 +0200
commit72120a18304cdee722d042c0ba57f73b556dc08b (patch)
tree86cc85bc96be150cb2183d21b0b7ff5a12bf4480
parentc227b55828d2ecf75f8294b4b72d50000954a0d4 (diff)
readme: copiable config
* add # to config comments to allow for easy copying
-rw-r--r--README.md12
1 files changed, 6 insertions, 6 deletions
diff --git a/README.md b/README.md
index 5f7ce49..57946f4 100644
--- a/README.md
+++ b/README.md
@@ -23,8 +23,8 @@ optional arguments:
```
#### without any arguments
-Running `bl-imp` without any arguments, cause the tool to update the local cache and the corresponding etag file. After
-that the tool will exit with the exit code `2` followed by the help message to stderr.
+Running `bl-imp` without any arguments, cause the tool to update the local cache and etag file. After that the tool will
+exit with the exit code `2` followed by the help message to stderr.
```bash
no outfile assigned
@@ -51,16 +51,16 @@ Adding the `outfile` argument while omitting the dry run argument runs the tools
To fully utilize the tool some configuration changes are required.
Firstly it is necessary that `bl-imp` is the only one editing the defined yml file, because any local change not
present in the remote list will be overwritten automatically. Furthermore it is necessary for the file to be separate
-from the "main" ejabberd configuration e.g `ejabberd.yml`. To further protect the integrity of your config the
+from the "main" ejabberd configuration e.g `ejabberd.yml`. Lastly to protect the integrity of your config files the
`allow_only` argument restricts the external file to only allow for `acl` rules.
#### ejabberd acl config
```yaml
## acl
include_config_file:
- "/etc/ejabberd/blacklist.yml": ⟵ the path is completely user configurable
- allow_only: ⟵ these two lines are optional but recommended
- - acl └─ to prevent potentially malicious acls to not incluse anthing but ACL rules
+ "/etc/ejabberd/blacklist.yml": # ⟵ the path is completely user configurable
+ allow_only: # ⟵ the allow_only section is optional but recommended
+ - acl
## access rules
access_rules: