paulmataruso/zulip
1
0
Fork 0
mirror of https://github.com/zulip/zulip.git synced 2025-10-31 12:03:46 +00:00
Code Issues Packages Projects Releases Wiki Activity
Files
318cb2bfcee14d8f506dfe5159110da4e6d60f81
zulip/api_docs/running-bots.md
David Rosa 3c0cb4c6a2 api-docs: Use start_tabs formatting and add "Related articles". 
- Updates API docs that have numbered instructions to use the
  `{start_tabs}` formatting we use in the help center.
- Cleans up formatting and revises documentation that shouldn't
  be formatted as a numbered instructions block.
- Cross-links related articles.

Fixes #28876.
2024-02-24 08:14:32 -08:00

2.7 KiB
Raw Blame History

Interactive bots

Zulip's API has a powerful framework for interactive bots that react to messages in Zulip.

Running a bot

This guide will show you how to run an existing Zulip bot found in zulip_bots/bots.

You'll need:

Note: Please be considerate when testing experimental bots on public servers such as chat.zulip.org.

{start_tabs}

  1. Create a bot, making sure to select Generic bot as the Bot type.

  2. Download the bot's zuliprc file.

  3. Use the following command to install the zulip_bots Python package:

     pip3 install zulip_bots

  4. Use the following command to start the bot process (replacing ~/path/to/zuliprc with the path to the zuliprc file you downloaded above):

     zulip-run-bot <bot-name> --config-file ~/path/to/zuliprc

  5. Check the output of the command above to make sure your bot is running. It should include the following line:

     INFO:root:starting message handling...

  6. Test your setup by starting a new direct message with the bot or mentioning the bot on a stream.

!!! tip ""

To use the latest development version of the `zulip_bots` package, follow
[these steps](writing-bots#installing-a-development-version-of-the-zulip-bots-package).

{end_tabs}

You can now play around with the bot and get it configured the way you like. Eventually, you'll probably want to run it in a production environment where it'll stay up, by deploying it on a server using the Zulip Botserver.

Common problems

  • My bot won't start
    • Ensure that your API config file is correct (download the config file from the server).
    • Ensure that your bot script is located in zulip_bots/bots/<my-bot>/
    • Are you using your own Zulip development server? Ensure that you run your bot outside the Vagrant environment.
    • Some bots require Python 3. Try switching to a Python 3 environment before running your bot.

Related articles