@@ -4,6 +4,50 @@ This is a bridge between Slack and Zulip.
4
4
5
5
## Usage
6
6
7
+ ### 1. Zulip endpoint
8
+
9
+ 1 . Create a generic Zulip bot, with a full name like ` Slack Bot ` .
10
+
11
+ 2 . (Important) Subscribe the bot user to the Zulip channel you'd like to bridge
12
+ your Slack channel into.
13
+
14
+ 3 . Create a [ Slack Webhook integration bot] ( https://zulip.com/integrations/doc/slack )
15
+ to get messages form Slack to Zulip.
16
+
17
+ 4 . In the ` zulip ` section of the configuration file, fill ` integration_bot_email `
18
+ with ** Integration bot** 's email. Note that this is the bot you created in
19
+ step 3 and not in step 1.
20
+
21
+ 5 . Also in the ` zulip ` section, enter the ** Generic bot's** ` zuliprc `
22
+ details (` email ` , ` api_key ` , and ` site ` ).
23
+
24
+ 6 . Moving to over the ` channel_mapping ` section, enter the Zulip ` channel ` and ` topic ` .
25
+ Make sure that they match the same ` channel ` and ` topic ` you configured in steps 2
26
+ and 3.
27
+
28
+ ### 2. Slack endpoint
29
+
30
+ 1 . Go to the [ Slack Apps menu] ( https://api.slack.com/apps ) and open the same Slack app that
31
+ you have use to set up the Slack Webhook integration previously.
32
+
33
+ 2 . Navigate to the "OAuth & Permissions" menu and scroll down to the "Scopes"
34
+ section in the same page and make sure:
35
+ - "Bot Token Scopes" includes: ` chat:write `
36
+ - "User Tokens Scopes" includes: ` chat:write `
37
+
38
+ 3 . Next, also in the same menu find and note down the "Bot User OAuth Token".
39
+ It starts with "xoxp-...".
40
+
41
+ 4 . In the ` slack ` section of the Zulip-Slack bridge configuration file, enter the bot name
42
+ (e.g "zulip_mirror"), token (e.g xoxp-...), and the channel ID (note: must be ID, not name).
43
+
44
+ ### Running the bridge
45
+
46
+ Run Slack Bridge: ` python3 run-slack-bridge `
47
+
48
+ <details >
49
+ <summary >Legacy: If you're still using classic Slack app, follow this instruction instead!</summary >
50
+
7
51
### 1. Zulip endpoint
8
52
1 . Create a generic Zulip bot, with a full name like ` Slack Bot ` .
9
53
2 . (Important) Subscribe the bot user to the Zulip stream you'd like to bridge your Slack
@@ -31,4 +75,6 @@ This is a bridge between Slack and Zulip.
31
75
32
76
### Running the bridge
33
77
34
- Run ` python3 run-slack-bridge `
78
+ Run Legacy Slack Bridge: ` python3 run-slack-bridge --legacy `
79
+
80
+ </details >
0 commit comments