History

Anders Kaseorg 5b5fda2354 Fix % formatting without a tuple. Signed-off-by: Anders Kaseorg <anders@zulip.com>		2021-03-04 15:04:38 -08:00
..
irc-mirror.py	cleanup: Remove unused imports.	2020-04-18 20:31:14 -07:00
irc_mirror_backend.py	Fix % formatting without a tuple.	2021-03-04 15:04:38 -08:00
README.md	IRC bridge: Add documentation on nick password.	2020-08-10 17:12:04 -07:00
requirements.txt	[BUGFIX] IRC bridge: Use connection initialized from aio_reactor.	2020-08-10 17:12:04 -07: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>