xenofem/python-zulip-api
1
0
Fork 0
Code Issues Pull requests Packages Projects Releases Wiki Activity
python-zulip-api/zulip/integrations/bridge_between_zulips
History
rht ceda54b50c bridge_between_zulips: Add explanation of --stream to README.md.
2020-04-07 16:20:19 -07:00
..
interrealm_bridge_config.py bridges: Bring inter-realm (zulip) bridge into zulip/ & rename others. 2018-08-08 17:26:15 -07:00
README.md bridge_between_zulips: Add explanation of --stream to README.md. 2020-04-07 16:20:19 -07:00
run-interrealm-bridge bridge_between_zulips: Add explanation of --stream to README.md. 2020-04-07 16:20:19 -07:00

README.md

Inter-realm bot

Let realm_1 be the first realm, realm_2 be the second realm. Let bot_1 be the relay bot in realm_1, bot_2 be the relay bot in realm_2.

This bot relays each message received at a specified subject in a specified stream from realm_1 to a specified subject in a specified stream in realm_2.

Steps to create an inter-realm bridge:

  1. Register a generic bot (bot_1) in realm_1
  2. Enter the api info of bot_1 into the config file (interrealm_bridge_config.py)
  3. Create a stream in realm_1 (stream_1) and a subject for the bridge
  4. Make sure bot_1 is subscribed to stream_1
  5. Enter the stream and the subject into the config file.
  6. Do step 1-5 but for bot_2 and with all occurrences of _1 replaced with _2
  7. Run the script run-interrealm-bridge

If the --stream flag is added (i.e. run-interrealm-bridge --stream), then the mirroring granularity becomes stream-wide. Instead of one subject, all subjects within the stream are mirrored as-is without translation.