Merge pull request #6 from robsiemb/document-secret-vars

Add some documentation around configuration and setup

Author: DaAwesomeP

README.md

@@ -0,0 +1,22 @@
+# Zulip / Slack / Groupme Bridge Bot
+
+## Features
+
+- Relays two-way between Zulip, Groupme, and Slack.
+- Logs all public relayed traffic to a single Zulip stream.
+- Logs private relayed traffic to a dedicated Zulip stream.
+
+## Installation
+
+1. Install redis.  A simple way to do this if you have docker installed is:
+
+```
+docker run -d --rm -p 6379:6379 --name redis_master redis:5.0
+```
+
+2. Create a slack bot account with bot user, add that bot to the appropriate channel on a slack.
+3. Create a zulip bot account on the zulip instance you intend to run.
+4. If you are using Groupme, get a Groupme bot account.
+5. Edit `secrets.py` to configure the auth credentials for the above.
+6. Configure stream/channel/topic names into `PUBLIC_TWO_WAY`, `PUBLIC_TWO_WAY_STREAM`, `ZULIP_LOG_PUBLIC_STREAM`, `ZULIP_LOG_PRIVATE_STREAM`.
+7. If using Groupme, set `GROUPME_ENABLE` and the cert chain paths.

__init__.py

@@ -16,21 +16,21 @@
 import zulip
 
 from secrets import (PUBLIC_TWO_WAY, ZULIP_BOT_NAME, ZULIP_BOT_EMAIL,
-                     ZULIP_API_KEY, ZULIP_URL, ZULIP_STREAM, ZULIP_PUBLIC,
+                     ZULIP_API_KEY, ZULIP_URL, PUBLIC_TWO_WAY_STREAM,
                      SLACK_BOT_ID, SLACK_TOKEN, REDIS_HOSTNAME, REDIS_PORT,
                      REDIS_PASSWORD, SLACK_EDIT_UPDATE_ZULIP_TTL,
                      REDIS_PREFIX, SLACK_ERR_CHANNEL, GROUPME_TWO_WAY,
                      GROUPME_ENABLE, SSL_CERT_CHAIN_PATH, SSL_CERT_KEY_PATH,
-                     ZULIP_PRIVATE)
+                     ZULIP_LOG_PUBLIC_STREAM, ZULIP_LOG_PRIVATE_STREAM)
 
 REDIS_USERS = REDIS_PREFIX + ':users:'
 REDIS_BOTS = REDIS_PREFIX + ':bots:'
 REDIS_CHANNELS = REDIS_PREFIX + ':channels:'
 REDIS_CHANNELS_BY_NAME = REDIS_PREFIX + ':channels.by.name:'
 REDIS_MSG_SLACK_TO_ZULIP = {
-    ZULIP_STREAM: REDIS_PREFIX + ':msg.slack.to.zulip:',
-    ZULIP_PUBLIC: REDIS_PREFIX + ':msg.slack.to.zulip.pub:',
-    ZULIP_PRIVATE: REDIS_PREFIX + ':msg.slack.to.zulip.priv:'
+    PUBLIC_TWO_WAY_STREAM:    REDIS_PREFIX + ':msg.slack.to.zulip.pub:',
+    ZULIP_LOG_PUBLIC_STREAM:  REDIS_PREFIX + ':msg.slack.to.zulip:',
+    ZULIP_LOG_PRIVATE_STREAM: REDIS_PREFIX + ':msg.slack.to.zulip.priv:'
 }
 
 GROUP_UPDATES = ['channel_archive', 'channel_join', 'channel_leave',
@@ -576,11 +576,11 @@ def send_to_zulip(self, subject, msg, user=None, slack_id=None,
                             attach_txt += "\n"
                         attach_txt += '```'
 
-            to = ZULIP_STREAM
+            to = ZULIP_LOG_PUBLIC_STREAM
             if send_public:
-                to = ZULIP_PUBLIC
+                to = PUBLIC_TWO_WAY_STREAM
             elif private:
-                to = ZULIP_PRIVATE
+                to = ZULIP_LOG_PRIVATE_STREAM
             if edit and slack_id:
                 redis_key = REDIS_MSG_SLACK_TO_ZULIP[to] + slack_id
                 zulip_id = self.redis.get(redis_key)

secrets.py

@@ -1,23 +1,34 @@
+# Slack / Zulip / Groupe Bridge Config
 # Please fill in all constants before operating
-SLACK_BOT_ID = 'U00000000'
-SLACK_ERR_CHANNEL = 'U00000000'
-ZULIP_STREAM = 'my stream'
-ZULIP_BOT_NAME = 'ack-bot'
-ZULIP_BOT_EMAIL = 'some-bot@site.zulipchat.com'
+
+# Authentication / Authorization configuration
+SLACK_BOT_ID = 'U00000000'                       # User ID of Bot
+ZULIP_BOT_NAME = 'some-bot'                      # Localpart of bot email
+ZULIP_BOT_EMAIL = '[email protected]'       # Bot Email for zulip config.
 ZULIP_API_KEY = '000000000000000000'
 ZULIP_URL = 'https://andrew.zulipchat.com'
 SLACK_TOKEN = 'xoxb-000000000000000000000000000'
-TWO_WAY = ['social']
-ZULIP_PUBLIC = 'social'
-ZULIP_PRIVATE = 'my private stream'
 
+# Slack Destination ID for Slack for bot error logs
+SLACK_ERR_CHANNEL = 'U00000000'
+
+# List of topics / slack channels to relay publicly.  They must be identically named on slack and zulip.
+# Bot must be added to these slack channels.
+PUBLIC_TWO_WAY = ['social']
+PUBLIC_TWO_WAY_STREAM = 'abtech'  # Zulip stream for public two-way communications
+
+# Configuration for zulip-side logging streams
+ZULIP_LOG_PUBLIC_STREAM = 'slack'           # Public logging zulip stream
+ZULIP_LOG_PRIVATE_STREAM = 'slack-private'  # Private logging zulip stream
+
+# Redis configuration
 REDIS_HOSTNAME = '127.0.0.1'
 REDIS_PORT = 6379
 REDIS_PASSWORD = ''
 SLACK_EDIT_UPDATE_ZULIP_TTL = 60*60
 REDIS_PREFIX = 'zulip.slack'
 
-
+# Groupme configuration.  If not using Groupme, just set GROUPME_ENABLE to False.
 GROUPME_ENABLE = False
 SSL_CERT_CHAIN_PATH = ''
 SSL_CERT_KEY_PATH = ''