README.md

   1 Electrum-server for the Electrum client
   2 =========================================
   3
   4   * Author: thomasv@bitcointalk
   5   * Language: Python
   6
   7 Features
   8 --------
   9
  10   * The server uses a bitcoind and bitcoin-abe or a leveldb backend.
  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. To install and run a pruning server (easiest setup) see README.leveldb
  21   2. Install [bitcoin-abe](https://github.com/jtobey/bitcoin-abe).
  22   3. Install [jsonrpclib](https://github.com/joshmarshall/jsonrpclib).
  23   4. Launch the server: `nohup python -u server.py > /var/log/electrum.log &`
  24      or use the included `start` script.
  25
  26 See the included `HOWTO.md` for greater detail on the installation process.
  27
  28 ### Important Note
  29
  30 Do not run bitcoin-abe and electrum-server simultaneously, because they will
  31 both try to update the database.
  32
  33 If you want bitcoin-abe to be available on your website, run it with
  34 the `--no-update` option.
  35
  36 ### Upgrading Abe
  37
  38 If you upgrade abe, you might need to update the database. In the abe directory, type:
  39
  40     python -m Abe.abe --config=abe.conf --upgrade
  41
  42 License
  43 -------
  44
  45 Electrum-server is made available under the terms of the [GNU Affero General
  46 Public License](http://www.gnu.org/licenses/agpl.html), version 3. See the
  47 included `LICENSE` for more details.