blob: 63dea51adf31f02950babc16669078e7447d2912 (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
|
## Blacklist import script
### installation
Python 3 virtual environment
```bash
virtualenv -p python3
pip install -r requirements.txt
```
### usage main.py
```
usage: main.py [-h] [-o OUTFILE] [-dr]
optional arguments:
-h, --help show this help message and exit
-o OUTFILE, --outfile OUTFILE
set path to output file
-dr, --dry-run perform a dry run
```
#### without any arguments
Running `main.py` without any arguments, will cause the script to update the local cache and the corresponding `.etag`
file. After that the script will output the error and the help message to stderr, before exiting with error code `2`
```bash
no outfile assigned
...
```
#### dry run
If `main.py` is executed with `-dr` or `--dry-run` as argument the output would look like this. The script will check
the blacklist repository and output everything to stdout without touching any system file.
```bash
$ /path/blacklist_import: python main.py --dr
outfile selected: None
acl:
spamblacklist:
server:
- "a-server.tld"
- "b-server.tld"
```
#### --outfile /path/
Run without the `--dry-run` argument and a valid outfile, the script will return nothing and do its thing.
##### *ejabberd reload_config*
The ejabberd instance will be reloaded automatically, but only if changes in the `outfile` occured.
## configuration
### ejabberd
To use this script properly, you need to add this line to the `ACL` section of your ejabberd instance. Furthermore a
separate `yml` file is necessary, as the script will overwrite the file. To further protect the integrity of your
config the `allow_only` sections defines only `acl` rules.
```yaml
"/etc/ejabberd/blacklist.yml":
allow_only:
- acl
```
### script itself
The script is meant to be used in an automatic fashion.
For example the script could be executed every day at 00:01 to automatically add and remove affected servers from the
blacklist file.
```cron
# jabber blacklist update
# with virtualenv enabled
1 0 * * * /path/blacklist_import/venv/bin/python /path/blacklist_import/main.py -o /etc/ejabberd/config/blacklist.yml
# without virtualenv
1 0 * * * python3 /path/blacklist_import/main.py -o /etc/ejabberd/config/blacklist.yml
```
|
