You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: GETTING_STARTED.md
+19-19Lines changed: 19 additions & 19 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -5,7 +5,7 @@
5
5
- <ahref="#setup-the-multi-container-applications">Setup the multi-container applications</a>
6
6
- <ahref="#running-services-for-the-first-time">Running services for the first time</a>
7
7
- <ahref="#tor">tor</a>
8
-
- <ahref="#bitcoind">bitcoind</a>
8
+
- <ahref="#bitcoin">bitcoin</a>
9
9
- <ahref="#electrs">electrs</a>
10
10
- <ahref="#btcrpcexplorer">btcrpcexplorer</a>
11
11
- <ahref="#nginx">nginx</a>
@@ -84,7 +84,7 @@ SHARED_GID=1099
84
84
85
85
# The paths where to mount the volumes.
86
86
TOR_DATA=/mnt/hdd/tor
87
-
BITCOIN_DATA=/mnt/hdd/bitcoind
87
+
BITCOIN_DATA=/mnt/hdd/bitcoin
88
88
ELECTRS_DATA=/mnt/hdd/electrs
89
89
BTC_RPC_EXPLORER_DATA=/mnt/hdd/btcrpcexplorer
90
90
NGINX_DATA=/mnt/hdd/nginx
@@ -96,7 +96,7 @@ Optionally, the user id of each service can be adjusted to match the user id of
96
96
97
97
For the first installation, we recommend starting the services one at a time. Take your time to verify by yourself the `Dockerfiles` and validate that the services are being deployed correctly.
98
98
99
-
It is also important because bitcoind will take a long time to synchronize, and if in the meantime, the rest of the containers that depend on it are continuously failing because the service is not available, these are resources that will make the process take even longer.
99
+
It is also important because bitcoin will take a long time to synchronize, and if in the meantime, the rest of the containers that depend on it are continuously failing because the service is not available, these are resources that will make the process take even longer.
The bitcoind configuration file is located in `/mnt/hdd/bitcoind/bitcoin.conf`. The default parameters are enough, except for one that depends on the memory of your local machine and the default password for communication between services, which you should generate yourself for security reasons.
130
+
The bitcoin configuration file is located in `/mnt/hdd/bitcoin/bitcoin.conf`. The default parameters are enough, except for one that depends on the memory of your local machine and the default password for communication between services, which you should generate yourself for security reasons.
131
131
132
-
The more cache bitcoind has, the faster it will be downloading and synchronizing the blocks. As a reference, you can set half of the machine memory expressed in MB. For example, if the node has 4GB of RAM, you can put 2048.
132
+
The more cache bitcoin has, the faster it will be downloading and synchronizing the blocks. As a reference, you can set half of the machine memory expressed in MB. For example, if the node has 4GB of RAM, you can put 2048.
133
133
134
134
```conf
135
135
dbcache=2048
@@ -157,14 +157,14 @@ Replace the two strings in the configuration file and take note of the passwords
157
157
158
158
This is the longest process and until it is finished we cannot continue. Your node will start synchronizing the entire blockchain with the rest of peers. This process can take days or even weeks. It's very difficult to give an estimation, because it depends on the capacity of your hardware, the state of the network, your connection speed... So be patient.
159
159
160
-
Run the following command `docker compose up -d bitcoind` to start the service and check the logs to be sure that the services is running properly.
160
+
Run the following command `docker compose up -d bitcoin` to start the service and check the logs to be sure that the services is running properly.
161
161
162
-
For this example, after a certain time, bitcoind was already synchronizing the 769944 block height (`height=769944`) and almost all the blockchain was already synchronized (`progress=0.999838`). At the time of writing this document, this was the last block mined, so the node was synchronized and we can move the next step.
162
+
For this example, after a certain time, bitcoin was already synchronizing the 769944 block height (`height=769944`) and almost all the blockchain was already synchronized (`progress=0.999838`). At the time of writing this document, this was the last block mined, so the node was synchronized and we can move the next step.
163
163
164
164
```shell
165
-
$ docker compose up bitcoind -d
166
-
$ docker ps | grep bitcoind
167
-
# 7cc89e57effb bitcoind:24.0.1
165
+
$ docker compose up bitcoin -d
166
+
$ docker ps | grep bitcoin
167
+
# 7cc89e57effb bitcoin:30.2
168
168
$ docker logs -f 7cc89e57effb
169
169
# You should see it synchronizing blocks as follows:
The electrs configuration file is located in `/mnt/hdd/electrs/electrs.conf`. The default parameters are enough, except for the password which must be replaced by the one generated earlier when configuring bitcoind.
185
+
The electrs configuration file is located in `/mnt/hdd/electrs/electrs.conf`. The default parameters are enough, except for the password which must be replaced by the one generated earlier when configuring bitcoin.
186
186
187
187
Run the following command `docker compose up -d electrs` to start the service and check the logs to be sure that the service is running properly.
188
188
189
-
For this example, we can see that electrs has already indexed the entire blockchain (`height=769944`, same block height as bitcoind).
189
+
For this example, we can see that electrs has already indexed the entire blockchain (`height=769944`, same block height as bitcoin).
The btc-rpc-explorer configuration file is located in `/mnt/hdd/btcrpcexplorer/btc-rpc-explorer.env`. The default parameters are also enough, except for the password which must be replaced by the one generated earlier when configuring bitcoind.
203
+
The btc-rpc-explorer configuration file is located in `/mnt/hdd/btcrpcexplorer/btc-rpc-explorer.env`. The default parameters are also enough, except for the password which must be replaced by the one generated earlier when configuring bitcoin.
204
204
205
205
Run the following command `docker compose up -d btcrpcexplorer` to start the service and check the logs to be sure that the service is running properly.
206
206
207
-
For this example, we can see that the service has beed started and it's connected to bitcoind (`RPC Connected: ... subversion=/Satoshi:24.0.1`)
207
+
For this example, we can see that the service has beed started and it's connected to bitcoin (`RPC Connected: ... subversion=/Satoshi:24.0.1`)
@@ -245,7 +245,7 @@ Two files `certificate.crt` and `certificate.key` will be generated. It is impor
245
245
246
246
Finally, run the following command `docker compose up -d nginx` to start the service and check the logs to be sure that the service is running properly.
247
247
248
-
For this example, we can see that the service has beed started and it's connected to bitcoind.
248
+
For this example, we can see that the service has beed started and it's connected to bitcoin.
249
249
250
250
```shell
251
251
$ docker ps | grep nginx
@@ -268,9 +268,9 @@ If you have reached this point, you should be able to access btc-rpc-explorer an
268
268
269
269
## Post-installation
270
270
271
-
Once the node has been synchronized, we can change the bitcoind dbcache to the minimum. It is no longer necessary to have so much memory for this purpose.
271
+
Once the node has been synchronized, we can change the bitcoin dbcache to the minimum. It is no longer necessary to have so much memory for this purpose.
272
272
273
-
Edit the bitcoind configuration file and change this parameter.
273
+
Edit the bitcoin configuration file and change this parameter.
0 commit comments