summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorHans Nielsen <hans@stackallocated.com>2014-06-25 22:38:03 -0700
committerHans Nielsen <hans@stackallocated.com>2015-02-24 19:52:17 -0800
commitee3f059e6d895cda94bee0a2df7136108012b910 (patch)
tree6efcf149fbaedf20362d2097751ff0c750fd0d6e /docs
parent6a28bad81440290e799c4d4985f31bea6493f58b (diff)
downloadirssi-ee3f059e6d895cda94bee0a2df7136108012b910.zip
Update proxy documentation with changes
Diffstat (limited to 'docs')
-rw-r--r--docs/proxy.txt22
-rw-r--r--docs/signals.txt1
2 files changed, 23 insertions, 0 deletions
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