mirror of
https://github.com/bitcoin/bitcoin.git
synced 2024-11-19 18:09:47 +01:00
dbc5ee821e
e04b0b6added OS X documentation to doc/init.md (Kevin Cooper)d4aa54cadded org.bitcoin.bitcoind.plist for launchd (OS X) (Kevin Cooper)
126 lines
5.1 KiB
Markdown
126 lines
5.1 KiB
Markdown
Sample init scripts and service configuration for bitcoind
|
|
==========================================================
|
|
|
|
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
|
|
|
|
1. Service User
|
|
---------------------------------
|
|
|
|
All three Linux startup configurations assume the existence of a "bitcoin" 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.
|
|
|
|
2. Configuration
|
|
---------------------------------
|
|
|
|
At a bare minimum, bitcoind 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.
|
|
|
|
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
|
|
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,
|
|
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.
|
|
|
|
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.
|
|
|
|
`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`.
|
|
|
|
3. Paths
|
|
---------------------------------
|
|
|
|
3a) Linux
|
|
|
|
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)
|
|
|
|
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
|
|
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
|
|
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`
|
|
|
|
4. Installing Service Configuration
|
|
-----------------------------------
|
|
|
|
4a) systemd
|
|
|
|
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`
|
|
|
|
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`
|
|
|
|
4c) Upstart (for Debian/Ubuntu based distributions)
|
|
|
|
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
|
|
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`.
|
|
|
|
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.
|
|
|
|
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`.
|
|
|
|
This Launch Agent will cause bitcoind 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.
|
|
|
|
5. Auto-respawn
|
|
-----------------------------------
|
|
|
|
Auto respawning is currently only configured for Upstart and systemd.
|
|
Reasonable defaults have been chosen but YMMV.
|