Update README.md
[electrum-server.git] / README.md
1 Electrum-server for the Electrum client
2 =========================================
3
4   * Author: thomasv@gitorious
5   * Language: Python
6
7 Features
8 --------
9
10   * The server uses a bitcoind and bitcoin-abe.
11   * The server code is open source. Anyone can run a server, removing single
12     points of failure concerns.
13   * The server knows which set of Bitcoin addresses belong to the same wallet,
14     which might raise concerns about anonymity. However, it should be possible
15     to write clients capable of using several servers.
16
17 Installation
18 ------------
19
20   1. Install [bitcoin-abe](https://github.com/jtobey/bitcoin-abe).
21   2. Install [jsonrpclib](https://github.com/joshmarshall/jsonrpclib).
22   3. Launch the server: `nohup python -u server.py > /var/log/electrum.log &`
23      or use the included `start` script.
24
25 See the included `HOWTO.md` for greater detail on the installation process.
26
27 ### Important Note
28
29 Do not run bitcoin-abe and electrum-server simultaneously, because they will
30 both try to update the database. 
31
32 If you want bitcoin-abe to be available on your website, run it with 
33 the `--no-update` option.
34
35 ### Upgrading Abe
36
37 If you upgrade abe, you might need to update the database. In the abe directory, type:
38
39     python -m Abe.abe --config=abe.conf --upgrade
40
41 License
42 -------
43
44 Electrum-server is made available under the terms of the [GNU Affero General
45 Public License](http://www.gnu.org/licenses/agpl.html), version 3. See the 
46 included `LICENSE` for more details.