zulip/templates/zerver/integrations/errbot.md at a9b51f80bac539c82865ae30d1e8b8b51bd24042

mirror of https://github.com/zulip/zulip.git synced 2025-11-22 15:31:20 +00:00

Files

David Rosa 33a618d169 integrations: Add generic bot macro to relevant docs.

There are a handful of integration docs that instruct users to create
a bot and select the "Generic bot" type without using a helper macro.

Adds a new macro to replace these instructions, including a screenshot
of the latest UI for selecting a bot type.

2022-09-09 16:31:33 -07:00

1.7 KiB

Raw Blame History

Run your favorite chatbot in Zulip!

Install errbot and follow to instructions to set up a config.py.
Check out our Errbot integration package for Zulip. Clone this repository somewhere convenient.
Install the requirements listed in errbot-backend-zulip/requirements.txt.
{!create-a-generic-bot.md!}
Download your Zulip bot's zuliprc config file. You will need its content for the next step.

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

Start ErrBot.

{!congrats.md!}

Tips

Rooms in ErrBot are streams in Zulip.

1.7 KiB Raw Blame History

Tips

1.7 KiB

Raw Blame History