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