Merge pull request #6512
fc25a87
Add note on relative paths, improve formatting (unsystemizer)
This commit is contained in:
commit
0201a79299
1 changed files with 18 additions and 17 deletions
35
doc/init.md
35
doc/init.md
|
@ -33,24 +33,26 @@ If bitcoind is run with "-daemon" flag, and no rpcpassword is set, it will
|
||||||
print a randomly generated suitable password to stderr. You can also
|
print a randomly generated suitable password to stderr. You can also
|
||||||
generate one from the shell yourself like this:
|
generate one from the shell yourself like this:
|
||||||
|
|
||||||
bash -c 'tr -dc a-zA-Z0-9 < /dev/urandom | head -c32 && echo'
|
`bash -c 'tr -dc a-zA-Z0-9 < /dev/urandom | head -c32 && echo'`
|
||||||
|
|
||||||
Once you have a password in hand, set rpcpassword= in /etc/bitcoin/bitcoin.conf
|
Once you have a password in hand, set `rpcpassword=` in `/etc/bitcoin/bitcoin.conf`
|
||||||
|
|
||||||
|
`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,
|
For an example configuration file that describes the configuration settings,
|
||||||
see contrib/debian/examples/bitcoin.conf.
|
see `contrib/debian/examples/bitcoin.conf`.
|
||||||
|
|
||||||
3. Paths
|
3. Paths
|
||||||
---------------------------------
|
---------------------------------
|
||||||
|
|
||||||
All three configurations assume several paths that might need to be adjusted.
|
All three configurations assume several paths that might need to be adjusted.
|
||||||
|
|
||||||
Binary: /usr/bin/bitcoind
|
Binary: `/usr/bin/bitcoind`
|
||||||
Configuration file: /etc/bitcoin/bitcoin.conf
|
Configuration file: `/etc/bitcoin/bitcoin.conf`
|
||||||
Data directory: /var/lib/bitcoind
|
Data directory: `/var/lib/bitcoind`
|
||||||
PID file: /var/run/bitcoind/bitcoind.pid (OpenRC and Upstart)
|
PID file: `/var/run/bitcoind/bitcoind.pid` (OpenRC and Upstart) or `/var/lib/bitcoind/bitcoind.pid` (systemd)
|
||||||
/var/lib/bitcoind/bitcoind.pid (systemd)
|
Lock file: `/var/lock/subsys/bitcoind` (CentOS)
|
||||||
Lock file: /var/lock/subsys/bitcoind (CentOS)
|
|
||||||
|
|
||||||
The configuration file, PID directory (if applicable) and data directory
|
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 bitcoin user and group. It is advised for security
|
||||||
|
@ -65,21 +67,21 @@ can then be controlled by group membership.
|
||||||
|
|
||||||
Installing this .service file consists of just copying it to
|
Installing this .service file consists of just copying it to
|
||||||
/usr/lib/systemd/system directory, followed by the command
|
/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 bitcoind" and to enable for system startup run
|
To test, run `systemctl start bitcoind` and to enable for system startup run
|
||||||
"systemctl enable bitcoind"
|
`systemctl enable bitcoind`
|
||||||
|
|
||||||
4b) OpenRC
|
4b) OpenRC
|
||||||
|
|
||||||
Rename bitcoind.openrc to bitcoind and drop it in /etc/init.d. Double
|
Rename bitcoind.openrc to bitcoind and drop it in /etc/init.d. Double
|
||||||
check ownership and permissions and make it executable. Test it with
|
check ownership and permissions and make it executable. Test it with
|
||||||
"/etc/init.d/bitcoind start" and configure it to run on startup with
|
`/etc/init.d/bitcoind start` and configure it to run on startup with
|
||||||
"rc-update add bitcoind"
|
`rc-update add bitcoind`
|
||||||
|
|
||||||
4c) Upstart (for Debian/Ubuntu based distributions)
|
4c) Upstart (for Debian/Ubuntu based distributions)
|
||||||
|
|
||||||
Drop bitcoind.conf in /etc/init. Test by running "service bitcoind start"
|
Drop bitcoind.conf in /etc/init. Test by running `service bitcoind start`
|
||||||
it will automatically start on reboot.
|
it will automatically start on reboot.
|
||||||
|
|
||||||
NOTE: This script is incompatible with CentOS 5 and Amazon Linux 2014 as they
|
NOTE: This script is incompatible with CentOS 5 and Amazon Linux 2014 as they
|
||||||
|
@ -87,7 +89,7 @@ use old versions of Upstart and do not supply the start-stop-daemon utility.
|
||||||
|
|
||||||
4d) CentOS
|
4d) CentOS
|
||||||
|
|
||||||
Copy bitcoind.init to /etc/init.d/bitcoind. Test by running "service bitcoind start".
|
Copy bitcoind.init to /etc/init.d/bitcoind. Test by running `service bitcoind start`.
|
||||||
|
|
||||||
Using this script, you can adjust the path and flags to the bitcoind program by
|
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
|
setting the BITCOIND and FLAGS environment variables in the file
|
||||||
|
@ -99,4 +101,3 @@ setting the BITCOIND and FLAGS environment variables in the file
|
||||||
Auto respawning is currently only configured for Upstart and systemd.
|
Auto respawning is currently only configured for Upstart and systemd.
|
||||||
Reasonable defaults have been chosen but YMMV.
|
Reasonable defaults have been chosen but YMMV.
|
||||||
|
|
||||||
|
|
||||||
|
|
Loading…
Reference in a new issue