From f529bc0d013a48e6ddb8e3e72eeba97621533380 Mon Sep 17 00:00:00 2001 From: rht Date: Sun, 9 Aug 2020 05:39:10 -0400 Subject: [PATCH] IRC bridge: Add documentation on nick password. --- zulip/integrations/bridge_with_irc/README.md | 7 ++++--- 1 file changed, 4 insertions(+), 3 deletions(-) diff --git a/zulip/integrations/bridge_with_irc/README.md b/zulip/integrations/bridge_with_irc/README.md index 8fa7147..936ae1f 100644 --- a/zulip/integrations/bridge_with_irc/README.md +++ b/zulip/integrations/bridge_with_irc/README.md @@ -6,14 +6,15 @@ ./irc-mirror.py --irc-server=IRC_SERVER --channel= --nick-prefix= --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