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     irc_nick = server nickname
  12
  13 `irc` is used to determine whether the IRC thread will be started or the
  14 Electrum server will run in private mode. In private mode,
  15 `./server.py peers` will always return an empty list.
  16
  17 `host` is a fully-qualified domain name (FQDN) of your Electrum server. It is
  18 used both when binding the listener for incoming client connections and as part
  19 of the realname field in IRC (see below).
  20
  21 `irc_nick` is a nick name that will be appended to E_ when
  22 composing the IRC nickname to identify your server on #electrum.
  23
  24 Please note the IRC name field can only contain 50 chars and will be composed
  25 of `host` + protocol version number + Port numbers for the various protocols.
  26 Please check whether port numbers are cut off at the end
  27