Mirror
/
zulip
mirror of https://github.com/zulip/zulip.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

docs: Consistently use Botserver instead of botserver or bot server.

This commit is contained in:
Robert Hönig 2018-05-29 10:53:45 +02:00 committed by Tim Abbott
parent 04d68d2570
commit fe6b46dfa6
3 changed files with 9 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
templates/zerver/api/deploying-bots.md
View File

@ -61,20 +61,20 @@ pip install zulip_botserver
1. Download the `zuliprc` file for your bot from the *Active Bots* 1. Download the `zuliprc` file for your bot from the *Active Bots*
panel, using the download button. panel, using the download button.
1. Run the bot server, where `helloworld` is the name of the bot you 1. Run the Botserver, where `helloworld` is the name of the bot you
want to run: want to run:
`zulip-bot-server --config-file <path_to_zuliprc> --bot-name=helloworld` `zulip-bot-server --config-file <path_to_zuliprc> --bot-name=helloworld`
You can specify the port number and various other options; run You can specify the port number and various other options; run
`zulip-bot-server --help` to see how to do this. `zulip-bot-server --help` to see how to do this.
1. Congrats, everything is set up! Test your botserver like you would 1. Congrats, everything is set up! Test your Botserver like you would
test a normal bot. test a normal bot.
### Running multiple bots using the Zulip botserver ### Running multiple bots using the Zulip Botserver
The Zulip botserver also supports running multiple bots from a single The Zulip Botserver also supports running multiple bots from a single
botserver process. You can do this with the following procedure. Botserver process. You can do this with the following procedure.
1. Download the `botserverrc` from the `your-bots` settings page, using 1. Download the `botserverrc` from the `your-bots` settings page, using
the "Download config of all active outgoing webhook bots in Zulip the "Download config of all active outgoing webhook bots in Zulip
@ -134,7 +134,7 @@ running it manually.
command=zulip-bot-server --config-file=<path/to/your/botserverrc> command=zulip-bot-server --config-file=<path/to/your/botserverrc>
--hostname <address> --port <port> --hostname <address> --port <port>
startsecs=3 startsecs=3
stdout_logfile=/var/log/zulip-botserver.log ; all output of your botserver will be logged here stdout_logfile=/var/log/zulip-botserver.log ; all output of your Botserver will be logged here
redirect_stderr=true redirect_stderr=true
* Edit the `<>` sections according to your preferences. * Edit the `<>` sections according to your preferences.
@ -156,6 +156,6 @@ running it manually.
The output should include a line similar to this: The output should include a line similar to this:
> zulip-bot-server RUNNING pid 28154, uptime 0:00:27 > zulip-bot-server RUNNING pid 28154, uptime 0:00:27
The standard output of the bot server will be logged to the path in The standard output of the Botserver will be logged to the path in
your *supervisord* configuration. your *supervisord* configuration.

2
templates/zerver/api/outgoing-webhooks.md
View File

@ -5,7 +5,7 @@ which are notified when certain types of messages are sent in
Zulip. When one of those events is triggered, we'll send a HTTP POST Zulip. When one of those events is triggered, we'll send a HTTP POST
payload to the webhook's configured URL. Webhooks can be used to payload to the webhook's configured URL. Webhooks can be used to
power a wide range of Zulip integrations. For example, the power a wide range of Zulip integrations. For example, the
[Zulip botserver][zulip-botserver] is built on top of this API. [Zulip Botserver][zulip-botserver] is built on top of this API.
Zulip supports outgoing webhooks both in a clean native Zulip format, Zulip supports outgoing webhooks both in a clean native Zulip format,
as well as a format that's compatible with as well as a format that's compatible with

2
templates/zerver/help/add-a-bot-or-integration.md
View File

@ -51,7 +51,7 @@ You can create three types of bots:
to this Endpoint URL. to this Endpoint URL.
Choose this type if you want to: Choose this type if you want to:
* make Zulip post messages to a URL. * make Zulip post messages to a URL.
* deploy Zulip's [botserver](/api/deploying-bots). * deploy Zulip's [Botserver](/api/deploying-bots).
*This is the default way of deploying bots used in production.* *This is the default way of deploying bots used in production.*
## Add an integration ## Add an integration