Merge branch 'master' of github.com:spesmilo/electrum-server

[electrum-server.git] / README-IRC.md

diff --git a/README-IRC.md b/README-IRC.md
index a849fcc..75a8a9b 100644 (file)
--- a/README-IRC.md
+++ b/README-IRC.md
@@ -8,7 +8,9 @@ The following config file options are used by the IRC part of Electrum server:
     [server]
     irc = yes
     host = fqdn.host.name.tld
+    #report_host = fqdn.host.name.tld
     irc_nick = server nickname
+    #report_stratum_http_port = 80
 
 `irc` is used to determine whether the IRC thread will be started or the 
 Electrum server will run in private mode. In private mode, 
@@ -18,7 +20,18 @@ Electrum server will run in private mode. In private mode,
 used both when binding the listener for incoming client connections and as part
 of the realname field in IRC (see below).
 
-`irc_nick` is a nick name that will be appended to E_ when 
+`report_host` is a an optional fully-qualified domain name (FQDN) of your Electrum server 
+instead of `host`. It is used as part of the name field in IRC for incoming client connections.
+This is useful in a NAT setup where you bind to a private IP locally but have an external IP
+set up at your router and external DNS.
+
+`report_stratum_tcp_port`, `report_stratum_http_port`, `report_stratum_tcp_ssl_port`, 
+`report_stratum_http_ssl_port` are optional settings for a port number to be reported in the
+IRC name field without actually binding this port locally. This is useful in a NAT setup
+where you might want to bind to a high port locally but DNAT a different possibly privileged
+port for inbound connections
+
+`irc_nick` is a nick name that will be appended to the E_ suffix when 
 composing the IRC nickname to identify your server on #electrum.
 
 Please note the IRC name field can only contain 50 chars and will be composed