more readme
[errbot-exec.git] / README.rst
1 **************************
2 Exec plugin for `errbot`__
3 **************************
4
5 __ http://errbot.io/
6
7 Execute an external command when the bot is talked to.
8
9 I wrote it so I can write bots in PHP, while letting `errbot`__ do
10 all the connection handling and stuff.
11
12 The executed script gets the message as first, and the username
13 sending the message as second parameter.
14
15 __ http://errbot.io/
16
17 =============
18 Configuration
19 =============
20 In ``config.py``::
21
22     EXEC = {
23         'command': 'echo'
24     }
25
26 Useful default errbot config settings:
27
28 - Only allow some users to talk to the bot::
29
30     ACCESS_CONTROLS_DEFAULT = {
31         'allowusers': ('gbin@localhost', 'user@example.org'),
32     }