paulmataruso/zulip
1
0
Fork 0
mirror of https://github.com/zulip/zulip.git synced 2025-11-03 21:43:21 +00:00
Code Issues Packages Projects Releases Wiki Activity

api: Fix confusing documentation about services for botserver.

Browse Source 
This fixes several super-confusing things in these docs.  Bot services
aren't a user-facing concept, and also, you need the URL before
creating the bot users.
This commit is contained in:
Tim Abbott
2018-05-14 09:20:58 -07:00
parent 485d5b6335
commit 1f837340d1
1 changed files with 14 additions and 19 deletions
Download Patch File Download Diff File Expand all files Collapse all files

33
templates/zerver/api/running-bots.md
View File

@@ -96,11 +96,24 @@ pip install zulip_botserver
### Running bots using the Zulip Botserver
1. Construct the URL for your bot, which will be of the form:
```
http://<hostname>:<port>/bots/<bot_name>
```
where the `hostname` is the hostname you'll be running the bot
server on, and `port` is the port for it (the recommended default
is `5002`). `bot_name` is the name of the Python module for the
bot you'd like to run.
1. Register new bot users on the Zulip server's web interface.
* Log in to the Zulip server.
* Navigate to *Settings (<i class="fa fa-cog"></i>)* -> *Your bots* -> *Add a new bot*.
Select *Outgoing webhook* for bot type, fill out the form and click on *Create bot*.
Select *Outgoing webhook* for bot type, fill out the form (using
the URL from above) and click on *Create bot*.
* A new bot user should appear in the *Active bots* panel.
1. Download the `flaskbotrc` from the `your-bots` settings page. It
@@ -116,24 +129,6 @@ pip install zulip_botserver
If omitted, `hostname` defaults to `127.0.0.1` and `port` to `5002`.
1. Now set up the outgoing webhook service which will interact with
the server: Create an **Outgoing webhook** bot with its Endpoint URL
of the form:
```
http://<hostname>:<port>/bots/<bot_name>
```
`bot_name` refers to the name in the email address you specified
for the bot. It can be obtained by removing `-bot@*.*` from the
bot email: For example, the bot name of a bot with an email
`followup-bot@zulip.com` is `followup`.
In the development environment, an outgoing webhook bot and
corresponding service already exist, with the email
`outgoing-webhook@zulip.com`. This can be used for interacting
with flask server bots.
1. Congrats, everything is set up! Test your botserver like you would
test a normal bot.