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
  38 standard Linux commands. You should have basic understanding of git,
  39 Python packages. You should have knowledge about how to install and
  40 configure software on your Linux distribution. You should be able to
  41 add commands to your distribution's startup scripts. If one of the
  42 commands included in this document is not available or does not
  43 perform the operation described here, you are expected to fix the
  44 issue so 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. Configure and start bitcoind
  94
  95 In order to allow Electrum to "talk" to `bitcoind`, we need to set up a RPC
  96 username and password for `bitcoind`. We will then start `bitcoind` and
  97 wait for it to complete downloading the blockchain.
  98
  99     $ mkdir ~/.bitcoin
 100     $ $EDITOR ~/.bitcoin/bitcoin.conf
 101
 102 Write this in `bitcoin.conf`:
 103
 104     rpcuser=<rpc-username>
 105     rpcpassword=<rpc-password>
 106     daemon=1
 107
 108 Restart `bitcoind`:
 109
 110     $ bitcoind
 111
 112 Allow some time to pass, so `bitcoind` connects to the network and starts
 113 downloading blocks. You can check its progress by running:
 114
 115     $ bitcoind getinfo
 116
 117 You should also set up your system to automatically start bitcoind at boot
 118 time, running as the 'bitcoin' user. Check your system documentation to
 119 find out the best way to do this.
 120
 121 ### Step 3. Install Electrum dependencies
 122
 123 Electrum server depends on various standard Python libraries. These will be
 124 already installed on your distribution, or can be installed with your
 125 package manager. Electrum also depends on two Python libraries which we wil
 126 l need to install "by hand": `Abe` and `JSONRPClib`.
 127
 128     $ sudo easy_install jsonrpclib
 129     $ cd ~/src
 130     $ git clone git://github.com/jtobey/bitcoin-abe.git
 131     $ cd bitcoin-abe
 132     $ sudo python setup.py install
 133
 134 Please note that the path below might be slightly different on your system,
 135 for example python2.6 or 2.8.
 136
 137     $ sudo chmod +x /usr/local/lib/python2.7/dist-packages/Abe/abe.py
 138     $ ln -s /usr/local/lib/python2.7/dist-packages/Abe/abe.py ~/bin/abe
 139
 140 ### Step 4. Configure the database
 141
 142 Electrum server uses a SQL database to store the blockchain data. In theory,
 143 it supports all databases supported by Abe. At the time of this writing,
 144 MySQL and PostgreSQL are tested and work ok, SQLite was tested and *does not
 145 work* with Electrum server.
 146
 147 For MySQL:
 148
 149     $ mysql -u root -p
 150     mysql> create user 'electrum'@'localhost' identified by '<db-password>';
 151     mysql> create database electrum;
 152     mysql> grant all on electrum.* to 'electrum'@'localhost';
 153     mysql> exit
 154
 155 For PostgreSQL:
 156
 157     TBW!
 158
 159 ### Step 5. Configure Abe and import blockchain into the database
 160
 161 When you run Electrum server for the first time, it will automatically
 162 import the blockchain into the database, so it is safe to skip this step.
 163 However, our tests showed that, at the time of this writing, importing the
 164 blockchain via Abe is much faster (about 20-30 times faster) than
 165 allowing Electrum to do it.
 166
 167     $ cp ~/src/bitcoin-abe/abe.conf ~/abe.conf
 168     $ $EDITOR ~/abe.conf
 169
 170 For MySQL, you need these lines:
 171
 172     dbtype MySQLdb
 173     connect-args = { "db" : "electrum", "user" : "electrum" , "passwd" : "<database-password>" }
 174
 175 For PostgreSQL, you need these lines:
 176
 177     TBD!
 178
 179 Start Abe:
 180
 181     $ abe --config ~/abe.conf
 182
 183 Abe will now start to import blocks. You will see a lot of lines like this:
 184
 185     'block_tx <block-number> <tx-number>'
 186
 187 You should wait until you see this message on the screen:
 188
 189     Listening on http://localhost:2750
 190
 191 It means the blockchain is imported and you can exit Abe by pressing CTRL-C.
 192 You will not need to run Abe again after this step, Electrum server will
 193 update the blockchain by itself. We only used Abe because it is much faster
 194 for the initial import.
 195
 196 Important notice: This is a *very* long process. Even on fast machines,
 197 expect it to take hours. Here are some benchmarks for importing
 198 ~196K blocks (size of the Bitcoin blockchain at the time of this writing):
 199
 200   * System 1: ~9 hours.
 201           * CPU: Intel Core i7 Q740 @ 1.73GHz
 202           * HDD: very fast SSD
 203   * System 2: ~55 hours.
 204           * CPU: Intel Xeon X3430 @ 2.40GHz
 205           * HDD: 2 x SATA in a RAID1.
 206
 207 ### Step 6. Configure Electrum server
 208
 209 Electrum reads a config file (/etc/electrum.conf) when starting up. This
 210 file includes the database setup, bitcoind RPC setup, and a few other
 211 options.
 212
 213     $ sudo cp ~/src/electrum/server/electrum.conf.sample /etc/electrum.conf
 214     $ sudo $EDITOR /etc/electrum.conf
 215
 216 Write this in `electrum.conf`:
 217
 218     # sample config for a public Electrum server
 219     [server]
 220     host = host-fqdn
 221     native_port = 50000
 222     stratum_tcp_port:50001
 223     stratum_http_port:8081
 224     password = <electrum-server-password>
 225     banner = Welcome to Electrum server!
 226     irc = yes
 227     cache = yes
 228
 229     # sample config for a private server (does not advertise on IRC)
 230     [server]
 231     host = localhost
 232     native_port = 50000
 233     stratum_tcp_port:50001
 234     stratum_http_port:8081
 235     password = <electrum-server-password>
 236     banner = Welcome to my private Electrum server!
 237     irc = no
 238     cache = yes
 239
 240     # database setup - MySQL
 241     [database]
 242     type = MySQLdb
 243     database = electrum
 244     username = electrum
 245     password = <database-password>
 246
 247     # database setup - PostgreSQL
 248     TBD!
 249
 250     # bitcoind RPC setup
 251     [bitcoind]
 252     host = localhost
 253     port = 8332
 254     user = <rpc-username>
 255     password = <rpc-password>
 256
 257 ### Step 7. (Finally!) Run Electrum server
 258
 259 The magic moment has come: you can now start your Electrum server:
 260
 261     $ server
 262
 263 You should see this on the screen:
 264
 265     starting Electrum server
 266     cache: yes
 267
 268 If you want to stop Electrum server, open another shell and run:
 269
 270     $ electrum-server stop
 271
 272 You should also take a look at the 'start' and 'stop' scripts in
 273 `~/src/electrum/server`. You can use them as a starting point to create a
 274 init script for your system.
 275
 276 ### 8. Test the Electrum server
 277
 278 We will assume you have a working Electrum client, a wallet and some
 279 transactions history. You should start the client and click on the green
 280 checkmark (last button on the right of the status bar) to open the Server
 281 selection window. If your server is public, you should see it in the list
 282 and you can select it. If you server is private, you need to enter its IP
 283 or hostname and the port. Press Ok, the client will disconnect from the
 284 current server and connect to your new Electrum server. You should see your
 285 addresses and transactions history. You can see the number of blocks and
 286 response time in the Server selection window. You should send/receive some
 287 bitcoins to confirm that everything is working properly.