diff options
| author | Tomo Ueda <[email protected]> | 2021-09-02 12:54:43 -0700 |
|---|---|---|
| committer | Tomo Ueda <[email protected]> | 2021-09-02 12:54:43 -0700 |
| commit | f5c716526aaafb318a98e974c8b2fbe02870646b (patch) | |
| tree | e14145656fcff86ec2c7a1ecf4ad28e0b40f36aa /doc/init.md | |
| parent | s/DOGE/DIS/g (diff) | |
| download | discoin-f5c716526aaafb318a98e974c8b2fbe02870646b.tar.xz discoin-f5c716526aaafb318a98e974c8b2fbe02870646b.zip | |
really s/doge/dis/g this time
Diffstat (limited to 'doc/init.md')
| -rw-r--r-- | doc/init.md | 76 |
1 files changed, 38 insertions, 38 deletions
diff --git a/doc/init.md b/doc/init.md index aa7102996..b5be33860 100644 --- a/doc/init.md +++ b/doc/init.md @@ -1,36 +1,36 @@ -Sample init scripts and service configuration for dogecoind +Sample init scripts and service configuration for discoind ========================================================== Sample scripts and configuration files for systemd, Upstart and OpenRC can be found in the contrib/init folder. - contrib/init/dogecoind.service: systemd service unit configuration - contrib/init/dogecoind.openrc: OpenRC compatible SysV style init script - contrib/init/dogecoind.openrcconf: OpenRC conf.d file - contrib/init/dogecoind.conf: Upstart service configuration file - contrib/init/dogecoind.init: CentOS compatible SysV style init script + contrib/init/discoind.service: systemd service unit configuration + contrib/init/discoind.openrc: OpenRC compatible SysV style init script + contrib/init/discoind.openrcconf: OpenRC conf.d file + contrib/init/discoind.conf: Upstart service configuration file + contrib/init/discoind.init: CentOS compatible SysV style init script 1. Service User --------------------------------- -All three Linux startup configurations assume the existence of a "dogecoin" user +All three Linux startup configurations assume the existence of a "discoin" user and group. They must be created before attempting to use these scripts. -The OS X configuration assumes dogecoind will be set up for the current user. +The OS X configuration assumes discoind will be set up for the current user. 2. Configuration --------------------------------- -At a bare minimum, dogecoind requires that the rpcpassword setting be set +At a bare minimum, discoind 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, dogecoind will shutdown promptly after startup. +setting is not set, discoind 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 dogecoind and client programs read from the configuration +as a fixed token that discoind 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 dogecoind is run with the "-server" flag (set by default), and no rpcpassword is set, +If discoind 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. @@ -38,13 +38,13 @@ 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 dogecoind without having to do any manual configuration. +This allows for running discoind 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/dogecoin.conf`. +see `contrib/debian/examples/discoin.conf`. 3. Paths --------------------------------- @@ -53,22 +53,22 @@ see `contrib/debian/examples/dogecoin.conf`. All three configurations assume several paths that might need to be adjusted. -Binary: `/usr/bin/dogecoind` -Configuration file: `/etc/dogecoin/dogecoin.conf` -Data directory: `/var/lib/dogecoind` -PID file: `/var/run/dogecoind/dogecoind.pid` (OpenRC and Upstart) or `/var/lib/dogecoind/dogecoind.pid` (systemd) -Lock file: `/var/lock/subsys/dogecoind` (CentOS) +Binary: `/usr/bin/discoind` +Configuration file: `/etc/discoin/discoin.conf` +Data directory: `/var/lib/discoind` +PID file: `/var/run/discoind/discoind.pid` (OpenRC and Upstart) or `/var/lib/discoind/discoind.pid` (systemd) +Lock file: `/var/lock/subsys/discoind` (CentOS) The configuration file, PID directory (if applicable) and data directory -should all be owned by the dogecoin user and group. It is advised for security +should all be owned by the discoin user and group. It is advised for security reasons to make the configuration file and data directory only readable by the -dogecoin user and group. Access to dogecoin-cli and other dogecoind rpc clients +discoin user and group. Access to discoin-cli and other discoind rpc clients can then be controlled by group membership. 3b) Mac OS X -Binary: `/usr/local/bin/dogecoind` -Configuration file: `~/Library/Application Support/Dogecoin/dogecoin.conf` +Binary: `/usr/local/bin/discoind` +Configuration file: `~/Library/Application Support/Dogecoin/discoin.conf` Data directory: `~/Library/Application Support/Dogecoin` Lock file: `~/Library/Application Support/Dogecoin/.lock` @@ -81,19 +81,19 @@ 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 dogecoind` and to enable for system startup run -`systemctl enable dogecoind` +To test, run `systemctl start discoind` and to enable for system startup run +`systemctl enable discoind` 4b) OpenRC -Rename dogecoind.openrc to dogecoind and drop it in /etc/init.d. Double +Rename discoind.openrc to discoind and drop it in /etc/init.d. Double check ownership and permissions and make it executable. Test it with -`/etc/init.d/dogecoind start` and configure it to run on startup with -`rc-update add dogecoind` +`/etc/init.d/discoind start` and configure it to run on startup with +`rc-update add discoind` 4c) Upstart (for Debian/Ubuntu based distributions) -Drop dogecoind.conf in /etc/init. Test by running `service dogecoind start` +Drop discoind.conf in /etc/init. Test by running `service discoind start` it will automatically start on reboot. NOTE: This script is incompatible with CentOS 5 and Amazon Linux 2014 as they @@ -101,22 +101,22 @@ use old versions of Upstart and do not supply the start-stop-daemon utility. 4d) CentOS -Copy dogecoind.init to /etc/init.d/dogecoind. Test by running `service dogecoind start`. +Copy discoind.init to /etc/init.d/discoind. Test by running `service discoind start`. -Using this script, you can adjust the path and flags to the dogecoind program by +Using this script, you can adjust the path and flags to the discoind program by setting the DOGECOIND and FLAGS environment variables in the file -/etc/sysconfig/dogecoind. You can also use the DAEMONOPTS environment variable here. +/etc/sysconfig/discoind. You can also use the DAEMONOPTS environment variable here. 4e) Mac OS X -Copy org.dogecoin.dogecoind.plist into ~/Library/LaunchAgents. Load the launch agent by -running `launchctl load ~/Library/LaunchAgents/org.dogecoin.dogecoind.plist`. +Copy org.discoin.discoind.plist into ~/Library/LaunchAgents. Load the launch agent by +running `launchctl load ~/Library/LaunchAgents/org.discoin.discoind.plist`. -This Launch Agent will cause dogecoind to start whenever the user logs in. +This Launch Agent will cause discoind to start whenever the user logs in. -NOTE: This approach is intended for those wanting to run dogecoind as the current user. -You will need to modify org.dogecoin.dogecoind.plist if you intend to use it as a -Launch Daemon with a dedicated dogecoin user. +NOTE: This approach is intended for those wanting to run discoind as the current user. +You will need to modify org.discoin.discoind.plist if you intend to use it as a +Launch Daemon with a dedicated discoin user. 5. Auto-respawn ----------------------------------- |