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 =============
  19 Configuration
  20 =============
  21 In ``config.py``::
  22
  23     EXEC = {
  24         'command': 'echo'
  25     }
  26
  27 Useful default errbot config settings:
  28
  29 - Only allow some users to talk to the bot::
  30
  31     ACCESS_CONTROLS_DEFAULT = {
  32         'allowusers': ('gbin@localhost', 'user@example.org'),
  33     }
  34
  35
  36 =======
  37 License
  38 =======
  39 ``errbot-exec`` is licensed under the `AGPL v3`__ or later.
  40
  41 __ http://www.gnu.org/licenses/agpl.html
  42
  43 ======
  44 Author
  45 ======
  46 Written by `Christian Weiske`__, cweiske+errbot@cweiske.de
  47
  48 __ http://cweiske.de/