HOWTO.md

   1 How to run your own Electrum server
   2 ===================================
   3
   4 Abstract
   5 --------
   6
   7 This document is an easy to follow guide to installing and running your own
   8 Electrum server on Linux. It is structured as a series of steps you need to
   9 follow, ordered in the most logical way. The next two sections describe some
  10 conventions we use in this document and hardware, software and expertise
  11 requirements.
  12
  13 The most up-to date version of this document is available at:
  14
  15     https://gitorious.org/electrum/server/blobs/master/HOWTO
  16
  17 Conventions
  18 -----------
  19
  20 In this document, lines starting with a hash sign (#) or a dollar sign ($)
  21 contain commands. Commands starting with a hash should be run as root,
  22 commands starting with a dollar should be run as a normal user (in this
  23 document, we assume that user is called 'bitcoin'). We also assume the
  24 bitcoin user has sudo rights, so we use '$ sudo command' when we need to.
  25
  26 Strings that are surrounded by "lower than" and "greater than" ( < and > )
  27 should be replaced by the user with something appropriate. For example,
  28 <password> should be replaced by a user chosen password. Do not confuse this
  29 notation with shell redirection ('command < file' or 'command > file')!
  30
  31 Lines that lack hash or dollar signs are pastes from config files. They
  32 should be copied verbatim or adapted, without the indentation tab.
  33
  34 Prerequisites
  35 -------------
  36
  37 **Expertise.** You should be familiar with Linux command line and standard
  38 Linux commands. You should have basic understanding of git, Python packages,
  39 compiling and applying patches to source code. You should have knowledge
  40 about how to install and configure software on your Linux distribution. You
  41 should be able to add commands to your distribution's startup scripts. If
  42 one of the commands included in this document is not available or does not
  43 perform the operation described here, you are expected to fix the issue so
  44 you can continue following this howto.
  45
  46 **Software.** A recent Linux distribution with the following software
  47 installed: `python`, `easy_install`, `git`, a SQL server, standard C/C++
  48 build chain. You will need root access in order to install other software or
  49 Python libraries. You will need access to the SQL server to create users and
  50 databases.
  51
  52 **Hardware.** Running a Bitcoin node and Electrum server is
  53 resource-intensive. At the time of this writing, the Bitcoin blockchain is
  54 3.5 GB large. The corresponding SQL database is about 4 time larger, so you
  55 should have a minimum of 14 GB free space. You should expect the total size
  56 to grow with time. CPU speed is also important, mostly for the initial block
  57 chain import, but also if you plan to run a public Electrum server, which
  58 could serve tens of concurrent requests. See step 6 below for some initial
  59 import benchmarks.
  60
  61 Instructions
  62 ------------
  63
  64 ### Step 0. Create a user for running bitcoind and Electrum server
  65
  66 This step is optional, but for better security and resource separation I
  67 suggest you create a separate user just for running `bitcoind` and Electrum.
  68 We will also use the `~/bin` directory to keep locally installed files
  69 (others might want to use `/usr/local/bin` instead). We will download source
  70 code files to the `~/src` directory.
  71
  72     # sudo adduser bitcoin
  73     # su - bitcoin
  74     $ mkdir ~/bin ~/src
  75     $ echo $PATH
  76
  77 If you don't see `/home/bitcoin/bin` in the output, you should add this line
  78 to your `.bashrc`, `.profile` or `.bash_profile`, then logout and relogin:
  79
  80     PATH="$HOME/bin:$PATH"
  81
  82 ### Step 1. Download and install Electrum
  83
  84 We will download the latest git snapshot for Electrum and 'install' it in
  85 our ~/bin directory:
  86
  87     $ mkdir -p ~/src/electrum
  88     $ cd ~/src/electrum
  89     $ git://gitorious.org/electrum/server.git
  90     $ chmod +x ~/src/electrum/server/server.py
  91     $ ln -s ~/src/electrum/server/server.py ~/bin/electrum
  92
  93 ### Step 2. Install a patched version of bitcoind
  94
  95 Electrum server requires some small modifications to the bitcoind daemon.
  96 The patch is included in the Electrum sources we just downloaded, now we
  97 will download the Bitcoin sources, patch, compile and install the binary to
  98 our `~/bin` directory.
  99
 100 Note that updated versions may affect these instructions, so *be mindful of
 101 what you are doing!*
 102
 103     $ cd ~/src
 104     $ wget https://github.com/bitcoin/bitcoin/tarball/v0.6.0 -O bitcoin-0.6.0.tgz
 105     $ tar xvzf bitcoin-0.6.0.tgz
 106     $ mv bitcoin-bitcoin-b3b5ab1 bitcoin-0.6.0
 107     $ cd bitcoin-0.6.0/src
 108     $ patch -p 2 < ~/src/electrum/server/patches/bitcoin-0.6.0.diff
 109     $ make -f makefile.unix
 110     $ strip bitcoind
 111     $ mv bitcoind ~/bin
 112
 113 ### Step 3. Configure and start bitcoind
 114
 115 In order to allow Electrum to "talk" to `bitcoind`, we need to set up a RPC
 116 username and password for `bitcoind`. We will then start `bitcoind` and
 117 wait for it to complete downloading the blockchain.
 118
 119     $ mkdir ~/.bitcoin
 120     $ $EDITOR ~/.bitcoin/bitcoin.conf
 121
 122 Write this in `bitcoin.conf`:
 123
 124     rpcuser=<rpc-username>
 125     rpcpassword=<rpc-password>
 126     daemon=1
 127
 128 Restart `bitcoind`:
 129
 130     $ bitcoind
 131
 132 Allow some time to pass, so `bitcoind` connects to the network and starts
 133 downloading blocks. You can check its progress by running:
 134
 135     $ bitcoind getinfo
 136
 137 You should also set up your system to automatically start bitcoind at boot
 138 time, running as the 'bitcoin' user. Check your system documentation to
 139 find out the best way to do this.
 140
 141 ### Step 4. Install Electrum dependencies
 142
 143 Electrum server depends on various standard Python libraries. These will be
 144 already installed on your distribution, or can be installed with your
 145 package manager. Electrum also depends on two Python libraries which we wil
 146 l need to install "by hand": `Abe` and `JSONRPClib`.
 147
 148     $ sudo easy_install jsonrpclib
 149     $ cd ~/src
 150     $ git clone git://github.com/jtobey/bitcoin-abe.git
 151     $ cd bitcoin-abe
 152     $ sudo python setup.py install
 153
 154 Please note that the path below might be slightly different on your system,
 155 for example python2.6 or 2.8.
 156
 157     $ sudo chmod +x /usr/local/lib/python2.7/dist-packages/Abe/abe.py
 158     $ ln -s /usr/local/lib/python2.7/dist-packages/Abe/abe.py ~/bin/abe
 159
 160 ### Step 5. Configure the database
 161
 162 Electrum server uses a SQL database to store the blockchain data. In theory,
 163 it supports all databases supported by Abe. At the time of this writing,
 164 MySQL and PostgreSQL are tested and work ok, SQLite was tested and *does not
 165 work* with Electrum server.
 166
 167 For MySQL:
 168
 169     $ mysql -u root -p
 170     mysql> create user 'electrum'@'localhost' identified by '<db-password>';
 171     mysql> create database electrum;
 172     mysql> grant all on electrum.* to 'electrum'@'localhost';
 173     mysql> exit
 174
 175 For PostgreSQL:
 176
 177     TBW!
 178
 179 ### Step 6. Configure Abe and import blockchain into the database
 180
 181 When you run Electrum server for the first time, it will automatically
 182 import the blockchain into the database, so it is safe to skip this step.
 183 However, our tests showed that, at the time of this writing, importing the
 184 blockchain via Abe is much faster (about 20-30 times faster) than
 185 allowing Electrum to do it.
 186
 187     $ cp ~/src/bitcoin-abe/abe.conf ~/abe.conf
 188     $ $EDITOR ~/abe.conf
 189
 190 For MySQL, you need these lines:
 191
 192     dbtype MySQLdb
 193     connect-args = { "db" : "electrum", "user" : "electrum" , "passwd" : "<database-password>" }
 194
 195 For PostgreSQL, you need these lines:
 196
 197     TBD!
 198
 199 Start Abe:
 200
 201     $ abe --config ~/abe.conf
 202
 203 Abe will now start to import blocks. You will see a lot of lines like this:
 204
 205     'block_tx <block-number> <tx-number>'
 206
 207 You should wait until you see this message on the screen:
 208
 209     Listening on http://localhost:2750
 210
 211 It means the blockchain is imported and you can exit Abe by pressing CTRL-C.
 212 You will not need to run Abe again after this step, Electrum server will
 213 update the blockchain by itself. We only used Abe because it is much faster
 214 for the initial import.
 215
 216 Important notice: This is a *very* long process. Even on fast machines,
 217 expect it to take hours. Here are some benchmarks for importing
 218 ~196K blocks (size of the Bitcoin blockchain at the time of this writing):
 219
 220   * System 1: ~9 hours.
 221           * CPU: Intel Core i7 Q740 @ 1.73GHz
 222           * HDD: very fast SSD
 223   * System 2: ~55 hours.
 224           * CPU: Intel Xeon X3430 @ 2.40GHz
 225           * HDD: 2 x SATA in a RAID1.
 226
 227 ### Step 7. Configure Electrum server
 228
 229 Electrum reads a config file (/etc/electrum.conf) when starting up. This
 230 file includes the database setup, bitcoind RPC setup, and a few other
 231 options.
 232
 233     $ sudo cp ~/src/electrum/server/electrum.conf.sample /etc/electrum.conf
 234     $ sudo $EDITOR /etc/electrum.conf
 235
 236 Write this in `electrum.conf`:
 237
 238     # sample config for a public Electrum server
 239     [server]
 240     host = host-fqdn
 241     native_port = 50000
 242     stratum_tcp_port:50001
 243     stratum_http_port:8081
 244     password = <electrum-server-password>
 245     banner = Welcome to Electrum server!
 246     irc = yes
 247     cache = yes
 248
 249     # sample config for a private server (does not advertise on IRC)
 250     [server]
 251     host = localhost
 252     native_port = 50000
 253     stratum_tcp_port:50001
 254     stratum_http_port:8081
 255     password = <electrum-server-password>
 256     banner = Welcome to my private Electrum server!
 257     irc = no
 258     cache = yes
 259
 260     # database setup - MySQL
 261     [database]
 262     type = MySQLdb
 263     database = electrum
 264     username = electrum
 265     password = <database-password>
 266
 267     # database setup - PostgreSQL
 268     TBD!
 269
 270     # bitcoind RPC setup
 271     [bitcoind]
 272     host = localhost
 273     port = 8332
 274     user = <rpc-username>
 275     password = <rpc-password>
 276
 277 ### Step 8. (Finally!) Run Electrum server
 278
 279 The magic moment has come: you can now start your Electrum server:
 280
 281     $ electrum-server
 282
 283 You should see this on the screen:
 284
 285     starting Electrum server
 286     cache: yes
 287
 288 If you want to stop Electrum server, open another shell and run:
 289
 290     $ electrum-server stop
 291
 292 You should also take a look at the 'start' and 'stop' scripts in
 293 `~/src/electrum/server`. You can use them as a starting point to create a
 294 init script for your system.
 295
 296 ### 9. Test the Electrum server
 297
 298 We will assume you have a working Electrum client, a wallet and some
 299 transactions history. You should start the client and click on the green
 300 checkmark (last button on the right of the status bar) to open the Server
 301 selection window. If your server is public, you should see it in the list
 302 and you can select it. If you server is private, you need to enter its IP
 303 or hostname and the port. Press Ok, the client will disconnect from the
 304 current server and connect to your new Electrum server. You should see your
 305 addresses and transactions history. You can see the number of blocks and
 306 response time in the Server selection window. You should send/receive some
 307 bitcoins to confirm that everything is working properly.