AaronFiore/electrum
1
0
Fork 0
Code Activity

* small IRC fix and doc

Browse Source
This commit is contained in:
Ovidiu Constantin
2011-11-30 17:08:01 +02:00
parent 493c74dde0
commit b513536fb1
2 changed files with 19 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

18
server/README-IRC.txt Normal file
View File

@@ -0,0 +1,18 @@
IRC is used by Electrum server to find 'peers' - other Electrum servers. The current list can be seen by running:
./server.py peers
The following config file options are used by the IRC part of Electrum server:
[server]
irc = yes
host = fqdn.host.name.tld
ircname = some short description
'irc' is used to determine whether the IRC thread will be started or the Electrum server will run in private mode. In private mode, ./server.py peers will always return an empty list.
'host' is a fqdn of your Electrum server. It is used both when binding the listener for incoming clien conections, and also as part of the realname field in IRC (see below).
'ircname' is a short text that will be appended to 'host' when composing the IRC realname field:
realname = 'host' + ' ' + 'ircname', for example 'fqdn.host.name.tld some short description'