bridge_between_zulips: Add explanation of --stream to README.md.
This commit is contained in:
parent
6dd52439bf
commit
ceda54b50c
|
@ -13,3 +13,8 @@ Steps to create an inter-realm bridge:
|
||||||
4. Make sure `bot_1` is subscribed to `stream_1`
|
4. Make sure `bot_1` is subscribed to `stream_1`
|
||||||
5. Enter the stream and the subject into the config file.
|
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`
|
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.
|
||||||
|
|
|
@ -63,8 +63,10 @@ if __name__ == "__main__":
|
||||||
Relay each message received at a specified subject in a specified stream from
|
Relay each message received at a specified subject in a specified stream from
|
||||||
the first realm to a specified subject in a specified stream in the second realm.
|
the first realm to a specified subject in a specified stream in the second realm.
|
||||||
|
|
||||||
If the --stream flag is added, then the tunnel granularity becomes
|
If the --stream flag is added, then the mirroring
|
||||||
stream-wide. All subjects are mirrored as-is without translation.
|
granularity becomes stream-wide. Instead of one subject,
|
||||||
|
all subjects within the stream are mirrored as-is without
|
||||||
|
translation.
|
||||||
"""
|
"""
|
||||||
sys.path.append(os.path.join(os.path.dirname(__file__), '..'))
|
sys.path.append(os.path.join(os.path.dirname(__file__), '..'))
|
||||||
|
|
||||||
|
|
Loading…
Reference in a new issue