From f479a1ef37dbc34d73c37f35f444e1f705e52a6b Mon Sep 17 00:00:00 2001 From: Steve Howell Date: Wed, 14 Dec 2016 14:54:24 -0800 Subject: [PATCH] contrib_bots: Add "Third Party Configuration" to docs. --- contrib_bots/lib/readme.md | 15 ++++++++++++++- 1 file changed, 14 insertions(+), 1 deletion(-) diff --git a/contrib_bots/lib/readme.md b/contrib_bots/lib/readme.md index 5cf1e02..088b71e 100644 --- a/contrib_bots/lib/readme.md +++ b/contrib_bots/lib/readme.md @@ -40,7 +40,7 @@ to suppress these messages. The bot code will run continuously until you kill them with control-C (or otherwise). -### Configuration +### Zulip Configuration For this document we assume you have some prior experience with using the Zulip API, but here is a quick review of @@ -53,6 +53,19 @@ page to create a user-owned bot. key= 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 In order to make bot development easy, we separate