https://github.com/zulip/errbot-backend-zulip
Zulip backend for err.
https://github.com/zulip/errbot-backend-zulip
Last synced: 3 months ago
JSON representation
Zulip backend for err.
- Host: GitHub
- URL: https://github.com/zulip/errbot-backend-zulip
- Owner: zulip
- Created: 2017-10-04T11:12:56.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2019-11-18T20:13:22.000Z (over 5 years ago)
- Last Synced: 2025-01-19T22:48:10.190Z (3 months ago)
- Language: Python
- Size: 8.79 KB
- Stars: 5
- Watchers: 6
- Forks: 13
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# errbot-backend-zulip
*This is a Zulip backend for [Errbot](http://errbot.io/).*
Setup
-----
0. [Install errbot](http://errbot.io/en/latest/user_guide/setup.html)
and follow to instructions to setup a `config.py`.
0. Clone this repository somewhere convenient.
0. Install the requirements listed in `requirements.txt`.
0. In Zulip, create a bot that will represent ErrBot. If you need help with this step,
check out [this](http://zulip.readthedocs.io/en/latest/bots-guide.html) guide on Zulip bots.
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:
```python
import logging
BACKEND = 'Zulip'
BOT_EXTRA_BACKEND_DIR = r''
BOT_DATA_DIR = r''
BOT_EXTRA_PLUGIN_DIR = r''
BOT_LOG_FILE = r''
BOT_LOG_LEVEL = logging.INFO
BOT_IDENTITY = { # Fill this with the corresponding values in your bot's `.zuliprc`
'email': '',
'key': '',
'site': ''
}
BOT_ADMINS = ('`.
0. [Start ErrBot](http://errbot.io/en/latest/user_guide/setup.html#starting-the-daemon).
Tips
----
* Rooms in ErrBot are streams in Zulip.