X-Git-Url: https://git.novaco.in/?p=electrum-server.git;a=blobdiff_plain;f=README.md;h=e103a5e90956f7d7fd80cebb204a7113609c4050;hp=d2bd1906c4d97a05006b4a2d421a46b15ba52dbf;hb=9a744b08d0c856001c94e8d89c0e43340368204f;hpb=3da0c07024ca0a6158cb1d5688b266348b876161 diff --git a/README.md b/README.md index d2bd190..e103a5e 100644 --- a/README.md +++ b/README.md @@ -1,28 +1,40 @@ Electrum-server for the Electrum client ========================================= - * Author: thomasv@bitcointalk + * Author: Thomas Voegtlin (ThomasV on the bitcointalk forum) * Language: Python Features -------- - * The server uses a bitcoind and a leveldb backend. - * The server code is open source. Anyone can run a server, removing single - points of failure concerns. - * The server knows which set of Bitcoin addresses belong to the same wallet, - which might raise concerns about anonymity. However, it should be possible - to write clients capable of using several servers. + * The server indexes UTXOs by address, in a Patricia tree structure + described by Alan Reiner (see the 'ultimate blockchain + compression' thread in the Bitcointalk forum) + + * Te server requires bitcoind, leveldb and plyvel + + * The server code is open source. Anyone can run a server, removing + single points of failure concerns. + + * The server knows which set of Bitcoin addresses belong to the same + wallet, which might raise concerns about anonymity. However, it + should be possible to write clients capable of using several + servers. Installation ------------ - 1. To install and run a pruning server (easiest setup) see README.leveldb - 2. Install [jsonrpclib](https://github.com/joshmarshall/jsonrpclib). - 3. Launch the server: `nohup python -u server.py > /var/log/electrum.log &` - or use the included `start` script. + 1. To install and run a server, see README.leveldb. For greater + detail on the installation process, see HOWTO.md. + + 2. To start the server, use the 'start' script. If you do not have a + database, it will propose you o download it from the Electrum + foundry. + + 3. To stop the server, use the 'stop' script. It will shutdown the + database cleanly. + -See the included `HOWTO.md` for greater detail on the installation process. License -------