README-IRC.md

   1 IRC is used by Electrum server to find 'peers' - other Electrum servers. The
   2 current list can be seen by running:
   3
   4     ./server.py peers
   5
   6 The following config file options are used by the IRC part of Electrum server:
   7
   8     [server]
   9     irc = yes
  10     host = fqdn.host.name.tld
  11     #report_host = fqdn.host.name.tld
  12     irc_nick = server nickname
  13     #report_stratum_http_port = 80
  14
  15 `irc` is used to determine whether the IRC thread will be started or the
  16 Electrum server will run in private mode (default). In private mode,
  17 `./server.py peers` will always return an empty list.
  18
  19 `host` is a fully-qualified domain name (FQDN) of your Electrum server. It is
  20 used both when binding the listener for incoming client connections and as part
  21 of the realname field in IRC (see below).
  22
  23 `report_host` is a an optional fully-qualified domain name (FQDN) of your Electrum server
  24 instead of `host`. It is used as part of the name field in IRC for incoming client connections.
  25 This is useful in a NAT setup where you bind to a private IP locally but have an external IP
  26 set up at your router and external DNS.
  27
  28 `report_stratum_tcp_port`, `report_stratum_http_port`, `report_stratum_tcp_ssl_port`,
  29 `report_stratum_http_ssl_port` are optional settings for a port number to be reported in the
  30 IRC name field without actually binding this port locally. This is useful in a NAT setup
  31 where you might want to bind to a high port locally but DNAT a different possibly privileged
  32 port for inbound connections
  33
  34 `irc_nick` is a nick name that will be appended to the E_ suffix when
  35 composing the IRC nickname to identify your server on #electrum.
  36
  37 Please note the IRC name field can only contain 50 chars and will be composed
  38 of `host` + protocol version number + Port numbers for the various protocols.
  39 Please check whether port numbers are cut off at the end
  40