v. 1.0.0.0

2017-12-08 09:40:03 +07:00
parent 1d588bf976
commit 3a6bb4b0ce
1539 changed files with 340734 additions and 0 deletions
--- a/doc/init.md
+++ b/doc/init.md
@@ -0,0 +1,125 @@
+Sample init scripts and service configuration for neodashd
+==========================================================
+
+Sample scripts and configuration files for systemd, Upstart and OpenRC
+can be found in the contrib/init folder.
+
+    contrib/init/neodashd.service:    systemd service unit configuration
+    contrib/init/neodashd.openrc:     OpenRC compatible SysV style init script
+    contrib/init/neodashd.openrcconf: OpenRC conf.d file
+    contrib/init/neodashd.conf:       Upstart service configuration file
+    contrib/init/neodashd.init:       CentOS compatible SysV style init script
+
+1. Service User
+---------------------------------
+
+All three Linux startup configurations assume the existence of a "neodash" user
+and group.  They must be created before attempting to use these scripts.
+The OS X configuration assumes neodashd will be set up for the current user.
+
+2. Configuration
+---------------------------------
+
+At a bare minimum, neodashd 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, neodashd 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 neodashd 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 neodashd 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 neodashd 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/neodash.conf`.
+
+3. Paths
+---------------------------------
+
+3a) Linux
+
+All three configurations assume several paths that might need to be adjusted.
+
+Binary:              `/usr/bin/neodashd`  
+Configuration file:  `/etc/neodash/neodash.conf`  
+Data directory:      `/var/lib/neodashd`  
+PID file:            `/var/run/neodashd/neodashd.pid` (OpenRC and Upstart) or `/var/lib/neodashd/neodashd.pid` (systemd)  
+Lock file:           `/var/lock/subsys/neodashd` (CentOS)  
+
+The configuration file, PID directory (if applicable) and data directory
+should all be owned by the neodash user and group.  It is advised for security
+reasons to make the configuration file and data directory only readable by the
+neodash user and group.  Access to neodash-cli and other neodashd rpc clients
+can then be controlled by group membership.
+
+3b) Mac OS X
+
+Binary:              `/usr/local/bin/neodashd`  
+Configuration file:  `~/Library/Application Support/Neodash/neodash.conf`  
+Data directory:      `~/Library/Application Support/Neodash`
+Lock file:           `~/Library/Application Support/Neodash/.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 neodashd` and to enable for system startup run
+`systemctl enable neodashd`
+
+4b) OpenRC
+
+Rename neodashd.openrc to neodashd and drop it in /etc/init.d.  Double
+check ownership and permissions and make it executable.  Test it with
+`/etc/init.d/neodashd start` and configure it to run on startup with
+`rc-update add neodashd`
+
+4c) Upstart (for Debian/Ubuntu based distributions)
+
+Drop neodashd.conf in /etc/init.  Test by running `service neodashd 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 neodashd.init to /etc/init.d/neodashd. Test by running `service neodashd start`.
+
+Using this script, you can adjust the path and flags to the neodashd program by
+setting the NDASHD and FLAGS environment variables in the file
+/etc/sysconfig/neodashd. You can also use the DAEMONOPTS environment variable here.
+
+4e) Mac OS X
+
+Copy org.neodash.neodashd.plist into ~/Library/LaunchAgents. Load the launch agent by
+running `launchctl load ~/Library/LaunchAgents/org.neodash.neodashd.plist`.
+
+This Launch Agent will cause neodashd to start whenever the user logs in.
+
+NOTE: This approach is intended for those wanting to run neodashd as the current user.
+You will need to modify org.neodash.neodashd.plist if you intend to use it as a
+Launch Daemon with a dedicated neodash user.
+
+5. Auto-respawn
+-----------------------------------
+
+Auto respawning is currently only configured for Upstart and systemd.
+Reasonable defaults have been chosen but YMMV.