xenofem/python-zulip-api
1
0
Fork 0
Code Issues Pull requests Packages Projects Releases Wiki Activity

contrib_bots: Add "Third Party Configuration" to docs.

Browse source
This commit is contained in:
Steve Howell 2016-12-14 14:54:24 -08:00
parent 0010b519fd
commit f479a1ef37
1 changed files with 14 additions and 1 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

15
contrib_bots/lib/readme.md
View file

@ -40,7 +40,7 @@ to suppress these messages.
The bot code will run continuously until you kill them with The bot code will run continuously until you kill them with
control-C (or otherwise). control-C (or otherwise).
### Configuration ### Zulip Configuration
For this document we assume you have some prior experience For this document we assume you have some prior experience
with using the Zulip API, but here is a quick review of with using the Zulip API, but here is a quick review of
@ -53,6 +53,19 @@ page to create a user-owned bot.
key=<your api key> key=<your api key>
site=https://zulip.somewhere.com site=https://zulip.somewhere.com
### Third Party Configuration
If your bot interacts with a non-Zulip service, you may
have to configure keys or usernames or URLs or similar
information to hit the other service.
Do **not** put third party configuration information in your
`.zuliprc` file. Do not put third party configuration
information anywhere in your Zulip directory. Instead,
create a separate configuration file for the third party's
configuration in your home directory.
## Architecture ## Architecture
In order to make bot development easy, we separate In order to make bot development easy, we separate