xenofem/python-zulip-api
1
0
Fork 0
Code Issues Pull requests Packages Projects Releases Wiki Activity

IRC bridge: Add documentation on nick password.

Browse source
This commit is contained in:
rht 2020-08-09 05:39:10 -04:00 committed by Tim Abbott
parent fe2a4d6fe8
commit f529bc0d01
1 changed files with 4 additions and 3 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

7
zulip/integrations/bridge_with_irc/README.md
View file

@ -6,14 +6,15 @@
./irc-mirror.py --irc-server=IRC_SERVER --channel=<CHANNEL> --nick-prefix=<NICK> --stream=<STREAM> [optional args]
```
`--stream` is a Zulip stream.
`--topic` is a Zulip topic, is optionally specified, defaults to "IRC".
`--stream` is a Zulip stream.
`--topic` is a Zulip topic, is optionally specified, defaults to "IRC".
`--nickserv-pw` is the IRC nick password.
IMPORTANT: Make sure the bot is subscribed to the relevant Zulip stream!!
Specify your Zulip API credentials and server in a ~/.zuliprc file or using the options.
Note that "_zulip" will be automatically appended to the IRC nick provided
IMPORTANT: Note that "_zulip" will be automatically appended to the IRC nick provided, so make sure that your actual registered nick ends with "_zulip".
## Example