CodeCow/zulip
1
0
Fork 0
mirror of https://github.com/zulip/zulip.git synced 2026-07-15 21:03:26 +08:00
Code Issues Actions Packages Projects Releases Wiki Activity
e32ee53fa3
zulip/templates/zerver/integrations/errbot.md
Alexandra Ciobica 869c5ce27b integrations: Change integrations content. 
We remove the title from `errbot` integration documentation so that
all documentations have the same style.  See
https://github.com/zulip/python-zulip-api/pull/515 for a similar
change to integrations where the docs live elsewhere in version control.

We also remove the `margin: 0` from the instruction tip because where
the tip is followed by a list, there is no space between the two; this
change doesn't mess up the other places where the tip is used.
2019-06-12 17:33:00 -07:00

1.8 KiB
Raw Blame History

Run your favorite chatbot in Zulip!

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

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

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

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

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

    Sections you need to edit are marked with <>.

  7. Start ErrBot.

{!congrats.md!}

Tips

  • Rooms in ErrBot are streams in Zulip.