]> kaliko git repositories - sid.git/blob - doc/source/rtbl.rst
Fixed 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     # Create the virtual env
9     python3 -m venv --prompt "rtbl-bot" venv
10     . ./venv/bin/activate
11     pip install -U pip wheel slixmpp==1.8.3
12     # Fetch the code
13     git clone -b dev https://gitlab.com/kaliko/sid.git
14     # Smoke test
15     python3 -m sid.rtbl --help
16
17
18 Then run, within the same virtual env:
19
20 .. code:: bash
21
22     # Activate the previously created virtual env
23     . ./venv/bin/activate
24     # Run the bot
25     python3 -m sid.rtbl --jid botjid@example.org \
26                         --room muc_to_moderate@conf.example.org \
27                         --rtbl xmppbl.org
28
29 .. vim: spell spelllang=en