neobytes/doc/init.md

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

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

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

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

All three Linux startup configurations assume the existence of a "neobytes" user
and group.  They must be created before attempting to use these scripts.
The OS X configuration assumes neobytesd will be set up for the current user.

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

At a bare minimum, neobytesd 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, neobytesd 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 neobytesd 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 neobytesd 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 neobytesd 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 `contrib/debian/examples/neobytes.conf`.

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

3a) Linux

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

Binary:              `/usr/bin/neobytesd`  
Configuration file:  `/etc/neobytes/neobytes.conf`  
Data directory:      `/var/lib/neobytesd`  
PID file:            `/var/run/neobytesd/neobytesd.pid` (OpenRC and Upstart) or `/var/lib/neobytesd/neobytesd.pid` (systemd)  
Lock file:           `/var/lock/subsys/neobytesd` (CentOS)  

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

3b) Mac OS X

Binary:              `/usr/local/bin/neobytesd`  
Configuration file:  `~/Library/Application Support/Neobytes/neobytes.conf`  
Data directory:      `~/Library/Application Support/Neobytes`
Lock file:           `~/Library/Application Support/Neobytes/.lock`

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

4a) systemd

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 neobytesd` and to enable for system startup run
`systemctl enable neobytesd`

4b) OpenRC

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

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

Drop neobytesd.conf in /etc/init.  Test by running `service neobytesd 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.

4d) CentOS

Copy neobytesd.init to /etc/init.d/neobytesd. Test by running `service neobytesd start`.

Using this script, you can adjust the path and flags to the neobytesd program by
setting the NEOBYTESD and FLAGS environment variables in the file
/etc/sysconfig/neobytesd. You can also use the DAEMONOPTS environment variable here.

4e) Mac OS X

Copy org.neobytes.neobytesd.plist into ~/Library/LaunchAgents. Load the launch agent by
running `launchctl load ~/Library/LaunchAgents/org.neobytes.neobytesd.plist`.

This Launch Agent will cause neobytesd to start whenever the user logs in.

NOTE: This approach is intended for those wanting to run neobytesd as the current user.
You will need to modify org.neobytes.neobytesd.plist if you intend to use it as a
Launch Daemon with a dedicated neobytes user.

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

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