]> kaliko git repositories - sid.git/blob - doc/source/rtbl.rst
Fixed rtbl documentation
[sid.git] / doc / source / rtbl.rst
1 Real time block list
2 --------------------
3
4 The real time block list plugin can be used easily calling the module:
5
6 .. code:: bash
7
8     # Fetch the code
9     git clone -b dev https://gitlab.com/kaliko/sid.git
10     cd sid
11     # Create the virtual env
12     python3 -m venv --prompt "rtbl-bot" venv
13     . ./venv/bin/activate
14     pip install -U pip wheel slixmpp==1.8.3
15     # Smoke test
16     python3 -m sid.rtbl --help
17
18
19 Then run, within the same virtual env:
20
21 .. code:: bash
22
23     # Activate the previously created virtual env
24     . ./venv/bin/activate
25     # Run the bot
26     python3 -m sid.rtbl --jid botjid@example.org \
27                         --room muc_to_moderate@conf.example.org \
28                         --rtbl xmppbl.org
29
30 .. vim: spell spelllang=en