From: Ovidiu Constantin <ovidiu@mybox.ro>
Date: Wed, 30 Nov 2011 15:08:01 +0000 (+0200)
Subject: * small IRC fix and doc
X-Git-Url: https://git.novaco.in/?p=electrum-server.git;a=commitdiff_plain;h=fdeb0fddcbe2cfafb80febeac1e4c3f35ceb6ee3

* small IRC fix and doc
---

diff --git a/README-IRC.txt b/README-IRC.txt
new file mode 100644
index 0000000..49650a8
--- /dev/null
+++ b/README-IRC.txt
@@ -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'
diff --git a/server.py b/server.py
index da2364c..693e45c 100755
--- a/server.py
+++ b/server.py
@@ -40,6 +40,7 @@ config.set('server', 'host', 'ecdsa.org')
 config.set('server', 'port', 50000)
 config.set('server', 'password', '')
 config.set('server', 'irc', 'yes')
+config.set('server', 'ircname', 'Electrum server')
 config.add_section('database')
 config.set('database', 'type', 'psycopg2')
 config.set('database', 'database', 'abe')