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
ff520a3d5224dc088013173e5f7a1d19e07dd7f6
zulip/api_docs/running-bots.md
Lauryn Menard dbacc00f0f api-docs: Move markdown files to top level directory. 
- Updates `.prettierignore` for the new directory.
- Updates any reference to the API documentation directory for
  markdown files to be `api_docs/` instead of `zerver/api/`.
- Removes a reference link from `docs/documentation/api.md` that
  hasn't referenced anything in the text since commit 0542c60.
- Update rendering of API documentation for new directory.
2023-02-02 17:25:40 -08:00

2.4 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.

  1. Go to your Zulip account and add a bot. Use Generic bot as the bot type.

  2. Download the bot's zuliprc configuration file to your computer.

  3. Download the zulip_bots Python package to your computer using pip3 install zulip_bots.

    Note: Click here to install the latest development version of the package.

  4. Start the bot process on your computer.

    • Run

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

      (replacing ~/path/to/zuliprc with the path to the zuliprc file you downloaded above).

    • Check the output of the command. It should include the following line:

        INFO:root:starting message handling...

      Congrats! Your bot is running.

  5. To talk with the bot, at-mention its name, like @**bot-name**.

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.