zulip/templates/zerver/integrations/errbot.md

Zulip Errbot integration

Run your favorite chatbot in Zulip!

{start_tabs}

1. Install errbot, and follow the instructions to set up a config.py.

2. Clone our Errbot integration package for Zulip repository somewhere convenient, and install the requirements listed in errbot-backend-zulip/requirements.txt.

3. {!create-a-generic-bot.md!} Download its zuliprc config file.

4. Edit your ErrBot's config.py. Use the following template for a minimal configuration:

    import logging
   
    BACKEND = 'Zulip'
   
    BOT_EXTRA_BACKEND_DIR = r'<path/to/errbot-backend-zulip>'
    BOT_DATA_DIR = r'<path/to/your/errbot/data/directory>'
    BOT_EXTRA_PLUGIN_DIR = r'<path/to/your/errbot/plugin/directory>'
   
    BOT_LOG_FILE = r'<path/to/your/errbot/logfile.log>'
    BOT_LOG_LEVEL = logging.INFO
   
    BOT_IDENTITY = {  # Fill this with the corresponding values in your bot's `.zuliprc`
      'email': '<err-bot@your.zulip.server>',
      'key': '<abcdefghijklmnopqrstuvwxyz123456>',
      'site': '<http://your.zulip.server>'
    }
    BOT_ADMINS = ('<your@email.address',)
    CHATROOM_PRESENCE = ()
    BOT_PREFIX = '<@**err-bot**>'  # Providing errbot's full name in Zulip lets it respond to @-mentions.
   

   Sections you need to edit are marked with <>.

5. Start ErrBot.

!!! tip ""

Rooms in ErrBot are channels in Zulip.

{end_tabs}

{!congrats.md!}