From ee3f059e6d895cda94bee0a2df7136108012b910 Mon Sep 17 00:00:00 2001 From: Hans Nielsen Date: Wed, 25 Jun 2014 22:38:03 -0700 Subject: Update proxy documentation with changes --- docs/proxy.txt | 22 ++++++++++++++++++++++ docs/signals.txt | 1 + 2 files changed, 23 insertions(+) (limited to 'docs') diff --git a/docs/proxy.txt b/docs/proxy.txt index 41875aab..759ef1dc 100644 --- a/docs/proxy.txt +++ b/docs/proxy.txt @@ -12,6 +12,11 @@ In irssi, say: /LOAD proxy +If you want the proxy to be loaded automatically at startup, add the +load command to ~/.irssi/startup: + + echo "load proxy" >> ~/.irssi/startup + You really should set some password for the proxy with: /SET irssiproxy_password secret @@ -24,3 +29,20 @@ something like: There we have 3 different irc networks answering in 3 ports. Note that you'll have to make the correct /IRCNET ADD and /SERVER ADD commands to make it work properly. + +By default, the proxy binds to all available interfaces. To make it +only listen on (for example) the loopback address: + + /SET irssiproxy_bind 127.0.0.1 + +Note that bind address changes won't take effect until the proxy is +disabled and then reenabled. + +Once everything is set up, you can enable / disable the proxy: + + /TOGGLE irssiproxy + +When the proxy is configured and running, the following command will +show all the currently connected clients: + + /PROXY status diff --git a/docs/signals.txt b/docs/signals.txt index f0860d3e..bd5849f1 100644 --- a/docs/signals.txt +++ b/docs/signals.txt @@ -220,6 +220,7 @@ notifylist.c: proxy/listen.c: + "proxy client connecting", CLIENT_REC "proxy client connected", CLIENT_REC "proxy client disconnected", CLIENT_REC "proxy client command", CLIENT_REC, char *args, char *data -- cgit v1.2.3 From 7beffbdcc5d9ca7433f6617a652ed0b2feca3677 Mon Sep 17 00:00:00 2001 From: Hans Nielsen Date: Tue, 24 Feb 2015 19:46:59 -0800 Subject: Add help files for proxy module --- docs/help/in/proxy.in | 14 ++++++++++++++ 1 file changed, 14 insertions(+) create mode 100644 docs/help/in/proxy.in (limited to 'docs') diff --git a/docs/help/in/proxy.in b/docs/help/in/proxy.in new file mode 100644 index 00000000..2dc61f43 --- /dev/null +++ b/docs/help/in/proxy.in @@ -0,0 +1,14 @@ + +@SYNTAX:proxy@ + +%9Description:%9 + + Displays the list of clients connected to the proxy. + +%9Examples:%9 + + /PROXY + /PROXY STATUS + +%9See also:%9 LOAD PROXY, SET irssiproxy + -- cgit v1.2.3 From a47f45b5b7438209177d76f3efde559e61e5bdb7 Mon Sep 17 00:00:00 2001 From: dequis Date: Sun, 14 Jun 2015 11:57:11 -0300 Subject: Rename /proxy command to /irssiproxy for clarity --- docs/help/in/irssiproxy.in | 14 ++++++++++++++ docs/help/in/proxy.in | 14 -------------- docs/proxy.txt | 2 +- 3 files changed, 15 insertions(+), 15 deletions(-) create mode 100644 docs/help/in/irssiproxy.in delete mode 100644 docs/help/in/proxy.in (limited to 'docs') diff --git a/docs/help/in/irssiproxy.in b/docs/help/in/irssiproxy.in new file mode 100644 index 00000000..79d75b91 --- /dev/null +++ b/docs/help/in/irssiproxy.in @@ -0,0 +1,14 @@ + +@SYNTAX:irssiproxy@ + +%9Description:%9 + + Displays the list of clients connected to irssiproxy. + +%9Examples:%9 + + /IRSSIPROXY + /IRSSIPROXY STATUS + +%9See also:%9 LOAD PROXY, SET irssiproxy + diff --git a/docs/help/in/proxy.in b/docs/help/in/proxy.in deleted file mode 100644 index 2dc61f43..00000000 --- a/docs/help/in/proxy.in +++ /dev/null @@ -1,14 +0,0 @@ - -@SYNTAX:proxy@ - -%9Description:%9 - - Displays the list of clients connected to the proxy. - -%9Examples:%9 - - /PROXY - /PROXY STATUS - -%9See also:%9 LOAD PROXY, SET irssiproxy - diff --git a/docs/proxy.txt b/docs/proxy.txt index 759ef1dc..e6360a82 100644 --- a/docs/proxy.txt +++ b/docs/proxy.txt @@ -45,4 +45,4 @@ Once everything is set up, you can enable / disable the proxy: When the proxy is configured and running, the following command will show all the currently connected clients: - /PROXY status + /IRSSIPROXY status -- cgit v1.2.3