doc/init.md

   1 Sample init scripts and service configuration for bitcoind
   2 ==========================================================
   3
   4 Sample scripts and configuration files for systemd, Upstart and OpenRC
   5 can be found in the contrib/init folder.
   6
   7     contrib/init/bitcoind.service:    systemd service unit configuration
   8     contrib/init/bitcoind.openrc:     OpenRC compatible SysV style init script
   9     contrib/init/bitcoind.openrcconf: OpenRC conf.d file
  10     contrib/init/bitcoind.conf:       Upstart service configuration file
  11     contrib/init/bitcoind.init:       CentOS compatible SysV style init script
  12
  13 1. Service User
  14 ---------------------------------
  15
  16 All three startup configurations assume the existence of a "bitcoin" user
  17 and group.  They must be created before attempting to use these scripts.
  18
  19 2. Configuration
  20 ---------------------------------
  21
  22 At a bare minimum, bitcoind requires that the rpcpassword setting be set
  23 when running as a daemon.  If the configuration file does not exist or this
  24 setting is not set, bitcoind will shutdown promptly after startup.
  25
  26 This password does not have to be remembered or typed as it is mostly used
  27 as a fixed token that bitcoind and client programs read from the configuration
  28 file, however it is recommended that a strong and secure password be used
  29 as this password is security critical to securing the wallet should the
  30 wallet be enabled.
  31
  32 If bitcoind is run with the "-server" flag (set by default), and no rpcpassword is set,
  33 it will use a special cookie file for authentication. The cookie is generated with random
  34 content when the daemon starts, and deleted when it exits. Read access to this file
  35 controls who can access it through RPC.
  36
  37 By default the cookie is stored in the data directory, but it's location can be overridden
  38 with the option '-rpccookiefile'.
  39
  40 This allows for running bitcoind without having to do any manual configuration.
  41
  42 `conf`, `pid`, and `wallet` accept relative paths which are interpreted as
  43 relative to the data directory. `wallet` *only* supports relative paths.
  44
  45 For an example configuration file that describes the configuration settings,
  46 see `contrib/debian/examples/bitcoin.conf`.
  47
  48 3. Paths
  49 ---------------------------------
  50
  51 All three configurations assume several paths that might need to be adjusted.
  52
  53 Binary:              `/usr/bin/bitcoind`
  54 Configuration file:  `/etc/bitcoin/bitcoin.conf`
  55 Data directory:      `/var/lib/bitcoind`
  56 PID file:            `/var/run/bitcoind/bitcoind.pid` (OpenRC and Upstart) or `/var/lib/bitcoind/bitcoind.pid` (systemd)
  57 Lock file:           `/var/lock/subsys/bitcoind` (CentOS)
  58
  59 The configuration file, PID directory (if applicable) and data directory
  60 should all be owned by the bitcoin user and group.  It is advised for security
  61 reasons to make the configuration file and data directory only readable by the
  62 bitcoin user and group.  Access to bitcoin-cli and other bitcoind rpc clients
  63 can then be controlled by group membership.
  64
  65 4. Installing Service Configuration
  66 -----------------------------------
  67
  68 4a) systemd
  69
  70 Installing this .service file consists of just copying it to
  71 /usr/lib/systemd/system directory, followed by the command
  72 `systemctl daemon-reload` in order to update running systemd configuration.
  73
  74 To test, run `systemctl start bitcoind` and to enable for system startup run
  75 `systemctl enable bitcoind`
  76
  77 4b) OpenRC
  78
  79 Rename bitcoind.openrc to bitcoind and drop it in /etc/init.d.  Double
  80 check ownership and permissions and make it executable.  Test it with
  81 `/etc/init.d/bitcoind start` and configure it to run on startup with
  82 `rc-update add bitcoind`
  83
  84 4c) Upstart (for Debian/Ubuntu based distributions)
  85
  86 Drop bitcoind.conf in /etc/init.  Test by running `service bitcoind start`
  87 it will automatically start on reboot.
  88
  89 NOTE: This script is incompatible with CentOS 5 and Amazon Linux 2014 as they
  90 use old versions of Upstart and do not supply the start-stop-daemon utility.
  91
  92 4d) CentOS
  93
  94 Copy bitcoind.init to /etc/init.d/bitcoind. Test by running `service bitcoind start`.
  95
  96 Using this script, you can adjust the path and flags to the bitcoind program by
  97 setting the BITCOIND and FLAGS environment variables in the file
  98 /etc/sysconfig/bitcoind. You can also use the DAEMONOPTS environment variable here.
  99
 100 5. Auto-respawn
 101 -----------------------------------
 102
 103 Auto respawning is currently only configured for Upstart and systemd.
 104 Reasonable defaults have been chosen but YMMV.
 105