zulip/templates/zerver/integrations/errbot.md

Run your favorite chatbot in Zulip!

0. Install errbot and follow to instructions to setup a config.py.

1. Check our our Errbot integration package for Zulip Clone this repository somewhere convenient.

2. Install the requirements listed in errbot-backend-zulip/requirements.txt.

3. Next, on your {{ settings_html|safe }}, create a bot for {{ integration_display_name }}. Make sure that you select Generic bot as the Bot type.

4. Download your Zulip bot's zuliprc config file. You will need its content for the next step.

5. 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@your.zulip.server**>'  # Needed for errbot to respond to @-mentions
   

   Sections you need to edit are marked with <>.

6. Start ErrBot.

{!congrats.md!}

Tips

• Rooms in ErrBot are streams in Zulip.