aboutsummaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorunsystemizer <something@gmail.com>2015-08-04 14:10:51 +0800
committerunsystemizer <something@gmail.com>2015-08-04 14:10:51 +0800
commitfc25a8748eefe3cb62be93d9804ef3f9e17b78cc (patch)
tree50afbba23028b51a59d21c04d7759faa3a2534c6 /doc
parentb6fee6b7c71cb339b3249860464d0a066b9a3147 (diff)
Add note on relative paths, improve formatting
Added "conf, pid, and wallet accept relative paths which are interpreted as relative to the data directory. wallet only supports relative paths."
Diffstat (limited to 'doc')
-rw-r--r--doc/init.md35
1 files changed, 18 insertions, 17 deletions
diff --git a/doc/init.md b/doc/init.md
index 1f206a6c02..7dee450c29 100644
--- a/doc/init.md
+++ b/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
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,
-see contrib/debian/examples/bitcoin.conf.
+see `contrib/debian/examples/bitcoin.conf`.
3. Paths
---------------------------------
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)
- /var/lib/bitcoind/bitcoind.pid (systemd)
-Lock file: /var/lock/subsys/bitcoind (CentOS)
+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)
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
@@ -65,21 +67,21 @@ can then be controlled by group membership.
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 bitcoind" and to enable for system startup run
-"systemctl enable bitcoind"
+To test, run `systemctl start bitcoind` and to enable for system startup run
+`systemctl enable bitcoind`
4b) OpenRC
Rename bitcoind.openrc to bitcoind 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/bitcoind start` and configure it to run on startup with
+`rc-update add bitcoind`
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.
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
-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
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.
Reasonable defaults have been chosen but YMMV.
-