Update and reformat init.md

doc/init.md

@@ -10,13 +10,14 @@ can be found in the contrib/init folder.
     contrib/init/pivxd.conf:       Upstart service configuration file
     contrib/init/pivxd.init:       CentOS compatible SysV style init script
 
-1. Service User
+Service User
 ---------------------------------
 
-All three startup configurations assume the existence of a "pivx" user
+All three Linux startup configurations assume the existence of a "pivx" user
 and group.  They must be created before attempting to use these scripts.
+The macOS configuration assumes pivxd will be set up for the current user.
 
-2. Configuration
+Configuration
 ---------------------------------
 
 At a bare minimum, pivxd requires that the rpcpassword setting be set
@@ -29,70 +30,115 @@ 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 pivxd 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:
+If pivxd 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.
 
-bash -c 'tr -dc a-zA-Z0-9 < /dev/urandom | head -c32 && echo'
+By default the cookie is stored in the data directory, but it's location can be overridden
+with the option '-rpccookiefile'.
 
-Once you have a password in hand, set rpcpassword= in /etc/pivx/pivx.conf
+This allows for running pivxd 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/pivx.conf.
 
-3. Paths
+Paths
 ---------------------------------
 
+### Linux
+
 All three configurations assume several paths that might need to be adjusted.
 
 Binary:              /usr/bin/pivxd
 Configuration file:  /etc/pivx/pivx.conf
 Data directory:      /var/lib/pivxd
-PID file:            /var/run/pivxd/pivxd.pid (OpenRC and Upstart)
-                     /var/lib/pivxd/pivxd.pid (systemd)
+PID file:            `/var/run/pivxd/pivxd.pid` (OpenRC and Upstart) or `/run/pivxd/pivxd.pid` (systemd)
+Lock file:           `/var/lock/subsys/pivxd` (CentOS)
 
 The configuration file, PID directory (if applicable) and data directory
 should all be owned by the pivx user and group.  It is advised for security
 reasons to make the configuration file and data directory only readable by the
 pivx user and group.  Access to pivx-cli and other pivxd rpc clients
 can then be controlled by group membership.
 
-4. Installing Service Configuration
+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 pivx group
+access to files under it _if_ the files themselves give permission to the
+pivx group to do so (e.g. when `-sysperms` is specified). This does not allow
+for the listing of files under the directory.
+
+NOTE: It is not currently possible to override `datadir` in
+`/etc/pivx/pivx.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/pivx/pivx.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 `BITCOIND_DATADIR` for
+OpenRC).
+
+### macOS
+
+Binary:              `/usr/local/bin/pivxd`
+Configuration file:  `~/Library/Application Support/PIVX/pivx.conf`
+Data directory:      `~/Library/Application Support/PIVX`
+Lock file:           `~/Library/Application Support/PIVX/.lock`
+
+Installing Service Configuration
 -----------------------------------
 
-4a) systemd
+### systemd
 
-Installing this .service file consists on just copying it to
+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.
+`systemctl daemon-reload` in order to update running systemd configuration.
 
-To test, run "systemctl start pivxd" and to enable for system startup run
-"systemctl enable pivxd"
+To test, run `systemctl start pivxd` and to enable for system startup run
+`systemctl enable pivxd`
 
-4b) OpenRC
+NOTE: When installing for systemd in Debian/Ubuntu the .service file needs to be copied to the /lib/systemd/system directory instead.
+
+### OpenRC
 
 Rename pivxd.openrc to pivxd and drop it in /etc/init.d.  Double
 check ownership and permissions and make it executable.  Test it with
-"/etc/init.d/pivxd start" and configure it to run on startup with
-"rc-update add pivxd"
+`/etc/init.d/pivxd start` and configure it to run on startup with
+`rc-update add pivxd`
+
+### Upstart (for Debian/Ubuntu based distributions)
 
-4c) Upstart (for Debian/Ubuntu based distributions)
+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 pivxd.conf in /etc/init.  Test by running "service pivxd start"
+Drop pivxd.conf in /etc/init.  Test by running `service pivxd 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.
+use old versions of Upstart and do not supply the start-stop-daemon utility.
 
-4d) CentOS
+### CentOS
 
-Copy pivxd.init to /etc/init.d/pivxd. Test by running "service pivxd start".
+Copy pivxd.init to /etc/init.d/pivxd. Test by running `service pivxd start`.
 
 Using this script, you can adjust the path and flags to the pivxd program by
 setting the PIVXD and FLAGS environment variables in the file
 /etc/sysconfig/pivxd. You can also use the DAEMONOPTS environment variable here.
 
-5. Auto-respawn
+### macOS
+
+Copy org.pivx.pivxd.plist into ~/Library/LaunchAgents. Load the launch agent by
+running `launchctl load ~/Library/LaunchAgents/org.pivx.pivxd.plist`.
+
+This Launch Agent will cause pivxd to start whenever the user logs in.
+
+NOTE: This approach is intended for those wanting to run pivxd as the current user.
+You will need to modify org.pivx.pivxd.plist if you intend to use it as a
+Launch Daemon with a dedicated pivx user.
+
+Auto-respawn
 -----------------------------------
 
 Auto respawning is currently only configured for Upstart and systemd.