add testnet file
This commit is contained in:
floreslorca
parent
286612662c
commit
2038420e47
106
doc/testnet.md
106
doc/testnet.md
|
|
@ -1,102 +1,36 @@
|
|||
*** Warning: This document has not been updated for Zcash and may be inaccurate. ***
|
||||
|
||||
Sample init scripts and service configuration for bitcoind
|
||||
Connecting to testnet
|
||||
==========================================================
|
||||
|
||||
Sample scripts and configuration files for systemd, Upstart and OpenRC
|
||||
can be found in the contrib/init folder.
|
||||
After building Bitcoin private, you should have two binaries (btcpd, and btcp-cli) on your build target directory, but before running the btcp, you need to configure it:
|
||||
|
||||
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
|
||||
### Linux
|
||||
|
||||
1. Service User
|
||||
1. Create a btcprivate.conf file
|
||||
---------------------------------
|
||||
|
||||
All three startup configurations assume the existence of a "bitcoin" user
|
||||
and group. They must be created before attempting to use these scripts.
|
||||
```
|
||||
vi ~/.btcprivate/btcprivate.conf
|
||||
```
|
||||
|
||||
2. Configuration
|
||||
2. Add the following to the conf file
|
||||
---------------------------------
|
||||
|
||||
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.
|
||||
```
|
||||
testnet=1
|
||||
addnode=testnet1.btcprivate.org:17933
|
||||
|
||||
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.
|
||||
rpcuser=test
|
||||
rpcpassword=test
|
||||
rpcport=17932
|
||||
rpcallowip=127.0.0.1
|
||||
|
||||
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'
|
||||
The rpc parameters are required for the daemon to run. the `testnet=1` tells the daemon to connect to testnet, and `addnode=...` is to connect to a reliable node. This is a temporal until we add dns seeds.
|
||||
|
||||
3. Execute the btcd binary
|
||||
|
||||
For an example configuration file that describes the configuration settings,
|
||||
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)
|
||||
|
||||
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.
|
||||
|
||||
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.
|
||||
|
||||
5. Auto-respawn
|
||||
-----------------------------------
|
||||
|
||||
Auto respawning is currently only configured for Upstart and systemd.
|
||||
Reasonable defaults have been chosen but YMMV.
|
||||
Once you run the daemon, you should first wait to sync the chain before mining. Once you are synced you can add `gen=1` to the conf file, and restart the btcp daemon.
|
||||
|
||||
Now that you have your node up you can use `btcp-cli` to make RPC calls to your node (i.e `btcp-cli getinfo`).
|
||||
Loading…
Reference in New Issue