64898b2c79
Some checks failed
Code scanning / CodeQL (push) Failing after 15s
Zulip production suite / Ubuntu 22.04 production build (push) Failing after 26s
Zulip production suite / Debian 12 production install with custom db name and user (push) Has been skipped
Zulip production suite / Ubuntu 22.04 production install and PostgreSQL upgrade with pgroonga (push) Has been skipped
Zulip production suite / Ubuntu 24.04 production install (push) Has been skipped
Zulip production suite / Ubuntu 26.04 production install (push) Has been skipped
Zulip production suite / Debian 13 production install (push) Has been skipped
Zulip production suite / 7.0 Version Upgrade (push) Has been skipped
Zulip production suite / 8.0 Version Upgrade (push) Has been skipped
Zulip production suite / 6.0 Version Upgrade (push) Has been skipped
Zulip production suite / 10.0 Version Upgrade (push) Has been skipped
Zulip production suite / 9.0 Version Upgrade (push) Has been skipped
Zulip production suite / 12.0 Version Upgrade (push) Has been skipped
Zulip production suite / 11.0 Version Upgrade (push) Has been skipped
GitHub Actions Security Analysis with zizmor / zizmor (push) Failing after 3s
Zulip CI / Debian 12 (Python 3.11, backend + documentation) (push) Failing after 26s
Zulip CI / Ubuntu 22.04 (Python 3.10, backend + frontend) (push) Failing after 3s
Zulip CI / Ubuntu 24.04 (Python 3.12, backend) (push) Failing after 25s
Zulip CI / Ubuntu 26.04 (Python 3.14, backend) (push) Failing after 25s
Zulip CI / Debian 13 (Python 3.13, backend) (push) Failing after 28s
Zulip production suite / Required jobs (push) Has been cancelled
Zulip CI / Required jobs (push) Has been cancelled
API Documentation Update Check / check-feature-level-updated (push) Has been cancelled
API Documentation Update Check / notify-if-api-docs-changed (push) Has been cancelled
67 lines
2.1 KiB
Markdown
67 lines
2.1 KiB
Markdown
# Zulip Errbot integration
|
|
|
|
Run your favorite chatbot in Zulip!
|
|
|
|
{start_tabs}
|
|
|
|
1. [Install errbot][install-errbot], and follow the instructions to set up a
|
|
`config.py`.
|
|
|
|
1. Clone the [Errbot integration package for Zulip][errbot-package]
|
|
repository somewhere convenient, and install the requirements listed in
|
|
`errbot-backend-zulip/requirements.txt`.
|
|
|
|
1. {!create-a-generic-bot.md!}
|
|
|
|
1. 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': '<your-bot@email.address>',
|
|
'key': '<api-key-of-your-bot>',
|
|
'site': '<your-zulip-organization-url>'
|
|
}
|
|
BOT_ADMINS = ('<your@email.address>',)
|
|
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.
|
|
|
|
1. [Start ErrBot][start-errbot].
|
|
|
|
!!! tip ""
|
|
|
|
ErrBot uses the term "Rooms" for Zulip channels.
|
|
|
|
{end_tabs}
|
|
|
|
{!congrats.md!}
|
|
|
|
|
|
|
|
### Related documentation
|
|
|
|
- [Errbot Documentation](https://errbot.readthedocs.io/en/latest/)
|
|
- [Errbot integration package for Zulip][errbot-package]
|
|
- [Python bindings Configuration][config-python-bindings]
|
|
|
|
[install-errbot]: https://errbot.readthedocs.io/en/latest/user_guide/setup.html
|
|
[errbot-package]: https://github.com/zulip/errbot-backend-zulip
|
|
[start-errbot]: https://errbot.readthedocs.io/en/latest/user_guide/setup.html#starting-the-daemon
|
|
[config-python-bindings]: https://zulip.com/api/configuring-python-bindings
|