Sample scripts and configuration files for systemd, Upstart and OpenRC can be found in the contrib/init folder.
contrib/init/bitcoinoild.service: systemd service unit configuration
contrib/init/bitcoinoild.openrc: OpenRC compatible SysV style init script
contrib/init/bitcoinoild.openrcconf: OpenRC conf.d file
contrib/init/bitcoinoild.conf: Upstart service configuration file
contrib/init/bitcoinoild.init: CentOS compatible SysV style init script
All three Linux startup configurations assume the existence of a "bitcoinoil" user and group. They must be created before attempting to use these scripts. The macOS configuration assumes bitcoinoild will be set up for the current user.
Running bitcoinoild as a daemon does not require any manual configuration. You may
set the rpcauth setting in the bitcoinoil.conf configuration file to override
the default behaviour of using a special cookie for authentication.
This password does not have to be remembered or typed as it is mostly used as a fixed token that bitcoinoild and client programs read from the configuration file, however it is recommended that a strong and secure password be used as this password is security critical to securing the wallet should the wallet be enabled.
If bitcoinoild is run with the "-server" flag (set by default), and no rpcpassword is set, it will use a special cookie file for authentication. The cookie is generated with random content when the daemon starts, and deleted when it exits. Read access to this file controls who can access it through RPC.
By default the cookie is stored in the data directory, but it's location can be overridden with the option '-rpccookiefile'.
This allows for running bitcoinoild without having to do any manual configuration.
conf, pid, and wallet accept relative paths which are interpreted as
relative to the data directory. wallet only supports relative paths.
For an example configuration file that describes the configuration settings,
see share/examples/bitcoinoil.conf.
All three configurations assume several paths that might need to be adjusted.
Binary: /usr/bin/bitcoinoild
Configuration file: /etc/bitcoinoil/bitcoinoil.conf
Data directory: /var/lib/bitcoinoild
PID file: /var/run/bitcoinoild/bitcoinoild.pid (OpenRC and Upstart) or
/run/bitcoinoild/bitcoinoild.pid (systemd)
Lock file: /var/lock/subsys/bitcoinoild (CentOS)
The PID directory (if applicable) and data directory should both be owned by the bitcoinoil user and group. It is advised for security reasons to make the configuration file and data directory only readable by the bitcoinoil user and group. Access to bitcoinoil-cli and other bitcoinoild rpc clients can then be controlled by group membership.
NOTE: When using the systemd .service file, the creation of the aforementioned directories and the setting of their permissions is automatically handled by systemd. Directories are given a permission of 710, giving the bitcoinoil group access to files under it if the files themselves give permission to the bitcoinoil group to do so. This does not allow for the listing of files under the directory.
NOTE: It is not currently possible to override datadir in
/etc/bitcoinoil/bitcoinoil.conf with the current systemd, OpenRC, and Upstart init
files out-of-the-box. This is because the command line options specified in the
init files take precedence over the configurations in
/etc/bitcoinoil/bitcoinoil.conf. However, some init systems have their own
configuration mechanisms that would allow for overriding the command line
options specified in the init files (e.g. setting BITCOINOILD_DATADIR for
OpenRC).
Binary: /usr/local/bin/bitcoinoild
Configuration file: ~/Library/Application Support/BitcoinOil/bitcoinoil.conf
Data directory: ~/Library/Application Support/BitcoinOil
Lock file: ~/Library/Application Support/BitcoinOil/.lock
Installing this .service file consists of just copying it to
/usr/lib/systemd/system directory, followed by the command
systemctl daemon-reload in order to update running systemd configuration.
To test, run systemctl start bitcoinoild and to enable for system startup run
systemctl enable bitcoinoild
NOTE: When installing for systemd in Debian/Ubuntu the .service file needs to be copied to the /lib/systemd/system directory instead.
Rename bitcoinoild.openrc to bitcoinoild and drop it in /etc/init.d. Double
check ownership and permissions and make it executable. Test it with
/etc/init.d/bitcoinoild start and configure it to run on startup with
rc-update add bitcoinoild
Upstart is the default init system for Debian/Ubuntu versions older than 15.04. If you are using version 15.04 or newer and haven't manually configured upstart you should follow the systemd instructions instead.
Drop bitcoinoild.conf in /etc/init. Test by running service bitcoinoild start
it will automatically start on reboot.
NOTE: This script is incompatible with CentOS 5 and Amazon Linux 2014 as they use old versions of Upstart and do not supply the start-stop-daemon utility.
Copy bitcoinoild.init to /etc/init.d/bitcoinoild. Test by running service bitcoinoild start.
Using this script, you can adjust the path and flags to the bitcoinoild program by setting the BITCOINOILD and FLAGS environment variables in the file /etc/sysconfig/bitcoinoild. You can also use the DAEMONOPTS environment variable here.
Copy org.bitcoinoil.bitcoinoild.plist into ~/Library/LaunchAgents. Load the launch agent by
running launchctl load ~/Library/LaunchAgents/org.bitcoinoil.bitcoinoild.plist.
This Launch Agent will cause bitcoinoild to start whenever the user logs in.
NOTE: This approach is intended for those wanting to run bitcoinoild as the current user. You will need to modify org.bitcoinoil.bitcoinoild.plist if you intend to use it as a Launch Daemon with a dedicated bitcoinoil user.
Auto respawning is currently only configured for Upstart and systemd. Reasonable defaults have been chosen but YMMV.