diff options
| author | Ross Nicoll <[email protected]> | 2018-01-20 18:35:31 +0000 |
|---|---|---|
| committer | Ross Nicoll <[email protected]> | 2019-03-25 05:36:12 +0000 |
| commit | 731b7a75c2bba4d4ba5a213ca5235ac334a998b0 (patch) | |
| tree | 99ab6f8e5a3bc0efa17b14fb6d69d623dd2edf12 /doc/init.md | |
| parent | Rename and update man pages (#1451) (diff) | |
| download | discoin-731b7a75c2bba4d4ba5a213ca5235ac334a998b0.tar.xz discoin-731b7a75c2bba4d4ba5a213ca5235ac334a998b0.zip | |
Update documentation to match 1.10 (#1436)
Diffstat (limited to 'doc/init.md')
| -rw-r--r-- | doc/init.md | 82 |
1 files changed, 41 insertions, 41 deletions
diff --git a/doc/init.md b/doc/init.md index e3db5b05e..aa7102996 100644 --- a/doc/init.md +++ b/doc/init.md @@ -1,36 +1,36 @@ -Sample init scripts and service configuration for bitcoind +Sample init scripts and service configuration for dogecoind ========================================================== Sample scripts and configuration files for systemd, Upstart and OpenRC can be found in the contrib/init folder. - contrib/init/bitcoind.service: systemd service unit configuration - contrib/init/bitcoind.openrc: OpenRC compatible SysV style init script - contrib/init/bitcoind.openrcconf: OpenRC conf.d file - contrib/init/bitcoind.conf: Upstart service configuration file - contrib/init/bitcoind.init: CentOS compatible SysV style init script + 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 1. Service User --------------------------------- -All three Linux startup configurations assume the existence of a "bitcoin" user +All three Linux startup configurations assume the existence of a "dogecoin" user and group. They must be created before attempting to use these scripts. -The OS X configuration assumes bitcoind will be set up for the current user. +The OS X configuration assumes dogecoind will be set up for the current user. 2. Configuration --------------------------------- -At a bare minimum, bitcoind requires that the rpcpassword setting be set +At a bare minimum, dogecoind 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, bitcoind will shutdown promptly after startup. +setting is not set, dogecoind 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 bitcoind and client programs read from the configuration +as a fixed token that dogecoind 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 bitcoind is run with the "-server" flag (set by default), and no rpcpassword is set, +If dogecoind 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 bitcoind without having to do any manual configuration. +This allows for running dogecoind 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/bitcoin.conf`. +see `contrib/debian/examples/dogecoin.conf`. 3. Paths --------------------------------- @@ -53,24 +53,24 @@ see `contrib/debian/examples/bitcoin.conf`. All three configurations assume several paths that might need to be adjusted. -Binary: `/usr/bin/bitcoind` -Configuration file: `/etc/bitcoin/bitcoin.conf` -Data directory: `/var/lib/bitcoind` -PID file: `/var/run/bitcoind/bitcoind.pid` (OpenRC and Upstart) or `/var/lib/bitcoind/bitcoind.pid` (systemd) -Lock file: `/var/lock/subsys/bitcoind` (CentOS) +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) The configuration file, PID directory (if applicable) and data directory -should all be owned by the bitcoin user and group. It is advised for security +should all be owned by the dogecoin user and group. It is advised for security reasons to make the configuration file and data directory only readable by the -bitcoin user and group. Access to bitcoin-cli and other bitcoind rpc clients +dogecoin user and group. Access to dogecoin-cli and other dogecoind rpc clients can then be controlled by group membership. 3b) Mac OS X -Binary: `/usr/local/bin/bitcoind` -Configuration file: `~/Library/Application Support/Bitcoin/bitcoin.conf` -Data directory: `~/Library/Application Support/Bitcoin` -Lock file: `~/Library/Application Support/Bitcoin/.lock` +Binary: `/usr/local/bin/dogecoind` +Configuration file: `~/Library/Application Support/Dogecoin/dogecoin.conf` +Data directory: `~/Library/Application Support/Dogecoin` +Lock file: `~/Library/Application Support/Dogecoin/.lock` 4. Installing Service Configuration ----------------------------------- @@ -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 bitcoind` and to enable for system startup run -`systemctl enable bitcoind` +To test, run `systemctl start dogecoind` and to enable for system startup run +`systemctl enable dogecoind` 4b) OpenRC -Rename bitcoind.openrc to bitcoind and drop it in /etc/init.d. Double +Rename dogecoind.openrc to dogecoind and drop it in /etc/init.d. Double check ownership and permissions and make it executable. Test it with -`/etc/init.d/bitcoind start` and configure it to run on startup with -`rc-update add bitcoind` +`/etc/init.d/dogecoind start` and configure it to run on startup with +`rc-update add dogecoind` 4c) Upstart (for Debian/Ubuntu based distributions) -Drop bitcoind.conf in /etc/init. Test by running `service bitcoind start` +Drop dogecoind.conf in /etc/init. Test by running `service dogecoind 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 bitcoind.init to /etc/init.d/bitcoind. Test by running `service bitcoind start`. +Copy dogecoind.init to /etc/init.d/dogecoind. Test by running `service dogecoind start`. -Using this script, you can adjust the path and flags to the bitcoind program by -setting the BITCOIND and FLAGS environment variables in the file -/etc/sysconfig/bitcoind. You can also use the DAEMONOPTS environment variable here. +Using this script, you can adjust the path and flags to the dogecoind program by +setting the DOGECOIND and FLAGS environment variables in the file +/etc/sysconfig/dogecoind. You can also use the DAEMONOPTS environment variable here. 4e) Mac OS X -Copy org.bitcoin.bitcoind.plist into ~/Library/LaunchAgents. Load the launch agent by -running `launchctl load ~/Library/LaunchAgents/org.bitcoin.bitcoind.plist`. +Copy org.dogecoin.dogecoind.plist into ~/Library/LaunchAgents. Load the launch agent by +running `launchctl load ~/Library/LaunchAgents/org.dogecoin.dogecoind.plist`. -This Launch Agent will cause bitcoind to start whenever the user logs in. +This Launch Agent will cause dogecoind to start whenever the user logs in. -NOTE: This approach is intended for those wanting to run bitcoind as the current user. -You will need to modify org.bitcoin.bitcoind.plist if you intend to use it as a -Launch Daemon with a dedicated bitcoin user. +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. 5. Auto-respawn ----------------------------------- |