Sample init scripts and service configuration for bitworldd
==========================================================

Sample scripts and configuration files for systemd, Upstart and OpenRC
can be found in the contrib/init folder.

    contrib/init/bitworldd.service:    systemd service unit configuration
    contrib/init/bitworldd.openrc:     OpenRC compatible SysV style init script
    contrib/init/bitworldd.openrcconf: OpenRC conf.d file
    contrib/init/bitworldd.conf:       Upstart service configuration file

1. Service User
---------------------------------

All three startup configurations assume the existence of a "bitworld" user
and group.  They must be created before attempting to use these scripts.

2. Configuration
---------------------------------

At a bare minimum, bitworldd requires that the rpcpassword setting be set
when running as a daemon.  If the configuration file does not exist or this
setting is not set, bitworldd will shutdown promptly after startup.

This password does not have to be remembered or typed as it is mostly used
as a fixed token that bitworldd 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 bitworldd is run with "-daemon" flag, and no rpcpassword is set, it will
print a randomly generated suitable password to stderr.  You can also
generate one from the shell yourself like this:

bash -c 'tr -dc a-zA-Z0-9 < /dev/urandom | head -c32 && echo'

Once you have a password in hand, set rpcpassword= in /etc/bitworld/bitworld.conf

For an example configuration file that describes the configuration settings, 
see contrib/debian/examples/bitworld.conf.

3. Paths
---------------------------------

All three configurations assume several paths that might need to be adjusted.

Binary:              /usr/bin/bitworldd
Configuration file:  /etc/bitworld/bitworld.conf
Data directory:      /var/lib/bitworldd
PID file:            /var/run/bitworldd/bitworldd.pid (OpenRC and Upstart)
                     /var/lib/bitworldd/bitworldd.pid (systemd)

The configuration file, PID directory (if applicable) and data directory
should all be owned by the bitworld user and group.  It is advised for security
reasons to make the configuration file and data directory only readable by the
bitworld user and group.  Access to bitworld-cli and other bitworldd rpc clients
can then be controlled by group membership.

4. Installing Service Configuration
-----------------------------------

4a) systemd

Installing this .service file consists on 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 bitworldd" and to enable for system startup run
"systemctl enable bitworldd"

4b) OpenRC

Rename bitworldd.openrc to bitworldd and drop it in /etc/init.d.  Double
check ownership and permissions and make it executable.  Test it with
"/etc/init.d/bitworldd start" and configure it to run on startup with
"rc-update add bitworldd"

4c) Upstart (for Debian/Ubuntu based distributions)

Drop bitworldd.conf in /etc/init.  Test by running "service bitworldd 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 uitility.

5. Auto-respawn
-----------------------------------

Auto respawning is currently only configured for Upstart and systemd.
Reasonable defaults have been chosen but YMMV.


