History

rht ad9b0e62a4 IRC: Handle error by displaying the error message. The proper solution would be to handle each errors differently. But for now, logging the message is at least informative to the user.		2023-11-20 14:36:17 -08:00
..
irc-mirror.py	IRC: Add option for SASL authentication.	2023-11-14 15:42:56 -08:00
irc_mirror_backend.py	IRC: Handle error by displaying the error message.	2023-11-20 14:36:17 -08:00
README.md	IRC bridge: Add documentation on nick password.	2020-08-10 17:12:04 -07:00
requirements.txt	IRC: Add option for SASL authentication.	2023-11-14 15:42:56 -08:00

README.md

IRC <--> Zulip bridge

Usage

./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".
--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.

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

./irc-mirror.py --irc-server=irc.freenode.net --channel='#python-mypy' --nick-prefix=irc_mirror \
--stream='test here' --topic='#mypy' \
--site="https://chat.zulip.org" --user=<bot-email> \
--api-key=<bot-api-key>