ContextQMD
Back to Zulip

Zulip Errbot integration

templates/zerver/integrations/errbot.md

12.02.1 KB
Original Source

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 the 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!}

  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 = {
   'email': '<[email protected]>',
   'key': '<api-key-of-your-bot>',
   'site': '<your-zulip-organization-url>'
 }
 BOT_ADMINS = ('<[email protected]>',)
 CHATROOM_PRESENCE = ()
 BOT_PREFIX = '@**<your-bot-name>**'

    Sections you need to edit are marked with <>. Replace the <...> placeholders with your own values, removing the < and > brackets.

    Use the details of the Zulip bot created above for the BOT_IDENTITY and BOT_PREFIX sections.

  5. Start ErrBot.

!!! tip ""

ErrBot uses the term "Rooms" for Zulip channels.

{end_tabs}

{!congrats.md!}