integrations: Add Errbot documentation.

Fixes zulip/python-zulip-api#49.
This commit is contained in:
derAnfaenger
2017-10-26 23:51:26 +02:00
committed by Tim Abbott
parent 84790f8e21
commit 64025d2ce7
4 changed files with 51 additions and 0 deletions

Binary file not shown.

After

Width:  |  Height:  |  Size: 81 KiB

View File

@@ -0,0 +1 @@
<svg xmlns="http://www.w3.org/2000/svg" width="190.045" height="200.801"><path fill="#f07e2a" stroke="#e1ddda" stroke-width="1.991" stroke-miterlimit="10" d="M32.703 6.927c-.29.012-.577.039-.871.078-4.71.621-8.089 4.463-7.546 8.572.456 3.453 3.53 5.991 7.297 6.348l3.827 29.032 5.259-.684-3.859-29.297c3.039-1.5 4.945-4.497 4.528-7.655-.509-3.852-4.284-6.581-8.635-6.394zm98.89-13.023c-.29.013-.577.024-.872.062-4.71.622-8.088 4.464-7.546 8.573.456 3.453 3.53 5.99 7.297 6.348l3.843 29.017 5.259-.7L135.7 7.937c3.044-1.499 4.944-4.495 4.527-7.655-.508-3.852-4.284-6.565-8.634-6.379zM13.818 126.38c.358 2.709-3.09 5.399-7.7 6.007-4.61.608-8.637-1.095-8.994-3.805l-1.915-14.504c-.357-2.71 3.09-5.4 7.7-6.008 4.61-.608 8.637 1.095 8.995 3.805l1.914 14.504zm179.349-23.212c.358 2.71-3.09 5.4-7.7 6.008-4.61.609-8.638-1.094-8.995-3.804l-1.914-14.504c-.358-2.71 3.09-5.4 7.7-6.008 4.61-.609 8.637 1.095 8.995 3.804l1.914 14.504zm-12.751 64.557c.339 2.564-1.776 4.958-4.722 5.348L32.087 192.025c-2.946.389-5.609-1.375-5.948-3.939L9.642 63.088c-.339-2.565 1.775-4.959 4.721-5.348l143.608-18.953c2.946-.389 5.61 1.375 5.947 3.94l16.498 124.998z"/><path d="M77.905 117.548a5.975 5.975 0 0 1-5.141 6.705l-35.699 4.712a5.975 5.975 0 0 1-6.705-5.142l-4.567-34.61a5.974 5.974 0 0 1 5.141-6.704l35.699-4.711a5.975 5.975 0 0 1 6.705 5.141l4.567 34.61zm79.186-10.45a5.975 5.975 0 0 1-5.143 6.704l-35.697 4.712a5.975 5.975 0 0 1-6.705-5.141l-4.568-34.61a5.974 5.974 0 0 1 5.141-6.705l35.699-4.71a5.974 5.974 0 0 1 6.705 5.14l4.568 34.61z" fill="#fff"/><path d="M137.272 147.74l-71.16 17.99"/><path fill="#273069" d="M138.126 151.118L66.112 165.73l70.305-21.368"/><g fill="#273069" stroke="#000" stroke-miterlimit="10" transform="translate(-81.87 -46.563) scale(.49787)"><ellipse cx="285.602" cy="272.225" ry="11.029" rx="10.662" transform="rotate(-7.52 285.625 272.278)"/><ellipse cx="448.949" cy="250.666" ry="11.029" rx="10.662" transform="rotate(-7.52 448.827 250.59)"/></g></svg>

After

Width:  |  Height:  |  Size: 1.9 KiB

View File

@@ -0,0 +1,49 @@
# Run your favorite chatbot in Zulip!
0. [Install errbot](http://errbot.io/en/latest/user_guide/setup.html)
and follow to instructions to setup a `config.py`.
0. Check our our [Errbot integration package for Zulip](https://github.com/zulip/errbot-backend-zulip)
Clone this repository somewhere convenient.
0. Install the requirements listed in `errbot-backend-zulip/requirements.txt`.
0. Next, on your {{ settings_html|safe }}, [create a bot](/help/add-a-bot-or-integration) for
{{ integration_display_name }}. Make sure that you select **Generic bot** as the **Bot type**.
0. Download your Zulip bot's `zuliprc` config file. You will need its content for the next step.
0. 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](http://errbot.io/en/latest/user_guide/setup.html#starting-the-daemon).
{!congrats.md!}
![](/static/images/integrations/errbot/000.png)
Tips
----
* Rooms in ErrBot are streams in Zulip.

View File

@@ -373,6 +373,7 @@ INTEGRATIONS = {
doc='zerver/integrations/discourse.md'),
'email': EmailIntegration('email', 'email', ['communication'],
doc='zerver/integrations/email.md'),
'errbot': Integration('errbot', 'errbot', ['meta-integration', 'bots'], doc='zerver/integrations/errbot.md'),
'git': Integration('git', 'git', ['version-control'], doc='zerver/integrations/git.md'),
'google-calendar': Integration(
'google-calendar',