/errbot-backend-zulip

Zulip backend for err.

Primary LanguagePython

errbot-backend-zulip

This is a Zulip backend for Errbot.

Setup

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

  2. Clone this repository somewhere convenient.

  3. Install the requirements listed in requirements.txt.

  4. In Zulip, create a bot that will represent ErrBot. If you need help with this step, check out this guide on Zulip bots.

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

  6. 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 <>.

  7. Start ErrBot.

Tips

  • Rooms in ErrBot are streams in Zulip.