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     ircname = a description
  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 `ircname` is a short text that will be appended to 'host' when composing the
  22 IRC realname field.
  23
  24 The `realname` = `host` + ' ' + `ircname`. For example, using the example
  25 configuration above, `realname` would be `fqdn.host.name.tld a description`.