Skip to content

Commit b4d0a81

Browse files
authored
Harmonize navigation and file structure
# Menu navigation The guide navigation now uses generic descriptions instead of specific software names. The chapter explaining the installation of the Bitcoin client is now called "Bitcoin client" instead of "Bitcoin Core". See discussion in raspibolt#930 Pull-request: raspibolt#938 # File structure With the guide accumulating more technical support files, the guide content itself got buried. Storing all core guide files in the root directory became confusing with increasing scope. Moving all markdown files into the /guide directory makes it human-readable again. Images are kept in /images to keep it tidy. Pull-request: raspibolt#941
1 parent 01d8f21 commit b4d0a81

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

53 files changed

+433
-349
lines changed
File renamed without changes.

backstory.md renamed to guide/backstory.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ title: Backstory
44
nav_order: 10
55
---
66
<!-- markdownlint-disable MD014 MD022 MD025 MD040 -->
7-
{% include_relative include_metatags.md %}
7+
{% include include_metatags.md %}
88

99
# Backstory
1010
{: .no_toc }
@@ -47,7 +47,7 @@ This was the original goal of the RaspiBolt guide back in 2017: simply buying a
4747
I used the [Eclair](https://github.com/ACINQ/eclair){:target="_blank"} Lighting implementation back then, on Lightning testnet, as mainnet was not even running yet.
4848
Oh, how time flies...
4949

50-
[![Buying a Blockaccino](images/backstory_blockaccino.png)](https://vimeo.com/252693058){:target="_blank"}
50+
[![Buying a Blockaccino](../images/backstory_blockaccino.png)](https://vimeo.com/252693058){:target="_blank"}
5151

5252
Watch the [original screencast](https://vimeo.com/252693058){:target="_blank"} from back then.
5353

@@ -64,4 +64,4 @@ Thanks to everyone who cares about Bitcoin and feels that running your own Bitco
6464

6565
---
6666

67-
Next: [Rasperry Pi >>](raspberry-pi.md)
67+
Next: [Rasperry Pi >>](raspberry-pi/index.md)

bitcoin-core.md renamed to guide/bitcoin/bitcoin-client.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,11 @@
11
---
22
layout: default
3-
title: Bitcoin Core
3+
title: Bitcoin client
44
nav_order: 10
55
parent: Bitcoin
66
---
77
<!-- markdownlint-disable MD014 MD022 MD025 MD033 MD040 -->
8-
# Bitcoin Core
8+
# Bitcoin client
99
{: .no_toc }
1010

1111
We install [Bitcoin Core](https://bitcoin.org/en/bitcoin-core/){:target="_blank"}, the reference client implementation of the Bitcoin network.
@@ -412,7 +412,7 @@ If everything is running smoothly, this is the perfect time to familiarize yours
412412
* you definitely need to have a [real copy](https://bitcoinbook.info/){:target="_blank"} of this book!
413413
* read it online on [Github](https://github.com/bitcoinbook/bitcoinbook){:target="_blank"}
414414
415-
![Mastering Bitcoin](images/30_mastering_bitcoin_book.jpg){:target="_blank"}
415+
![Mastering Bitcoin](../../images/30_mastering_bitcoin_book.jpg){:target="_blank"}
416416
417417
* [**Learning Bitcoin from the Command Line**](https://github.com/ChristopherA/Learning-Bitcoin-from-the-Command-Line/blob/master/README.md){:target="_blank"} by Christopher Allen gives a thorough deep dive into understanding the technical aspects of Bitcoin.
418418
@@ -457,7 +457,7 @@ When upgrading, there might be breaking changes, or changes in the data structur
457457
* There's no need to stop the application.
458458
Simply install the new version and restart the service.
459459

460-
* Download, verify, extract and install the Bitcoin Core binaries as described in the [Bitcoin section](bitcoin-core.md) of this guide.
460+
* Download, verify, extract and install the Bitcoin Core binaries as described in the [Bitcoin section](bitcoin-client.md#installation) of this guide.
461461

462462
* Restart the Bitcoin Core systemd unit
463463

@@ -469,4 +469,4 @@ When upgrading, there might be breaking changes, or changes in the data structur
469469

470470
---
471471

472-
Next: [Electrum >>](electrs.md)
472+
Next: [Electrum server >>](electrum-server.md)

btcrpcexplorer.md renamed to guide/bitcoin/blockchain-explorer.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,17 @@
11
---
22
layout: default
3-
title: Blockchain Explorer
3+
title: Blockchain explorer
44
nav_order: 30
55
parent: Bitcoin
66
---
77
<!-- markdownlint-disable MD014 MD022 MD025 MD033 MD036 MD040 -->
88

9-
# Blockchain Explorer
9+
# Blockchain explorer
1010
{: .no_toc }
1111

1212
Run your own private blockchain explorer with [BTC RPC Explorer](https://github.com/janoside/btc-rpc-explorer){:target="_blank"}. Trust your node, not some external services.
1313

14-
![BTC RPC Explorer home screen with dark theme](images/btcrpcexplorer-homepage.png)
14+
![BTC RPC Explorer home screen with dark theme](../../images/btcrpcexplorer-homepage.png)
1515

1616
---
1717

@@ -42,7 +42,7 @@ For the BTC RPC Explorer to work, you need your full node to index all transacti
4242

4343
* If you followed this guide, the transaction index parameter is already enabled (`txindex=1`), and you can skip to the next section.
4444

45-
* If this is not the case, you need to set the `txindex=1` parameter in your Bitcoin Core configuration file (`bitcoin.conf`): [Bitcoin node configuration](bitcoin-core.md#configuration).
45+
* If this is not the case, you need to set the `txindex=1` parameter in your Bitcoin Core configuration file (`bitcoin.conf`): [Bitcoin node configuration](bitcoin-client.md#configuration).
4646

4747
* After adding the parameter, restart Bitcoin Core, which will now index the whole blockchain
4848

@@ -70,7 +70,7 @@ You can follow the progress using `tail -f ~/.bitcoin/debug.log`.
7070

7171
### Firewall & reverse proxy
7272

73-
In the [Security section](security.md), we set up NGINX as a reverse proxy.
73+
In the [Security section](../raspberry-pi/security.md#prepare-nginx-reverse-proxy), we set up NGINX as a reverse proxy.
7474
Now we can add the BTC RPC Explorer configuration.
7575

7676
* Enable NGINX reverse proxy to route external encrypted HTTPS traffic internally to the BTC RPC Explorer
@@ -344,5 +344,5 @@ Updating to a [new release](https://github.com/janoside/btc-rpc-explorer/release
344344

345345
---
346346

347-
Next: [Lightning >>](lightning.md)
347+
Next: [Lightning >>](../lightning/index.md)
348348

electrs.md renamed to guide/bitcoin/electrum-server.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,7 @@ Wallets like the [BitBoxApp](https://shiftcrypto.ch/app/){:target="_blank"}, [El
3636

3737
## Preparations
3838

39-
Make sure that you have [reduced the database cache of Bitcoin Core](bitcoin-core.html#reduce-dbcache-after-full-sync) after full sync.
39+
Make sure that you have [reduced the database cache of Bitcoin Core](bitcoin-client.md#reduce-dbcache-after-full-sync)#prepare-nginx-reverse-proxy after full sync.
4040

4141
### Install dependencies
4242

@@ -48,7 +48,7 @@ Make sure that you have [reduced the database cache of Bitcoin Core](bitcoin-cor
4848

4949
### Firewall & reverse proxy
5050

51-
In the [Security section](security.md), we already set up NGINX as a reverse proxy.
51+
In the [Security section](../raspberry-pi/security.md), we already set up NGINX as a reverse proxy.
5252
Now we can add the Electrs configuration.
5353

5454
* Enable NGINX reverse proxy to add SSL/TLS encryption to the Electrs communication.
@@ -311,7 +311,7 @@ Only proceed with the next section once Electrs is ready.
311311
312312
[Electrum wallet](https://electrum.org){:target="_blank"} is a well-established, feature-rich Bitcoin wallet for power-users that supports most hardware wallets.
313313
314-
![Electrum Wallet local](images/electrum-wallet-tor.png){:target="_blank"}
314+
![Electrum Wallet local](../../images/electrum-wallet-tor.png){:target="_blank"}
315315
316316
### Force single server connection
317317
@@ -346,14 +346,14 @@ If you start Electrum, the green LED in the bottom right indicates an active con
346346
If you connect over Tor, make sure that Tor is installed on your regular computer.
347347
There are two options:
348348
349-
* Easy: download, install and run [Tor Browser](https://www.torproject.org).
349+
* Easy: download, install and run [Tor Browser](https://www.torproject.org){:target="_blank"}.
350350
* The application must be started manually and run in the background whe you want to connect over Tor.
351351
* Tor proxy available on port `9150`
352352
353353
* Expert: install Tor as a background service
354354
* The background service must be installed, and is always active in the background.
355355
* Tor proxy available on port `9050`
356-
* See further installation instructions for [Windows](https://bitstobytes.org/tor), [macOS](https://deepdarkweb.github.io/how-to-install-tor-on-macos-tutorial/), and Linux (`sudo apt install tor`).
356+
* See further installation instructions for [Windows](https://bitstobytes.org/tor){:target="_blank"}, [macOS](https://deepdarkweb.github.io/how-to-install-tor-on-macos-tutorial/){:target="_blank"}, and Linux (`sudo apt install tor`).
357357
358358
Now we need to specifiy the Tor address for Electrs and the local Tor proxy port in the Electrum configuration.
359359
@@ -403,7 +403,7 @@ If you have Tor installed on your computer, you can access your RaspiBolt remote
403403
* Enable it and confirm the proxy address (usually the default `127.0.0.1:9050`)
404404
* When adding your RaspiBolt full node as described above, use your Tor address (e.g. `gwdllz5g7vky2q4gr45zGuvopjzf33czreca3a3exosftx72ekppkuqd.onion:50002`)
405405
406-
![BitBoxApp](images/electrum_BitBoxApp.png)
406+
![BitBoxApp](../../images/electrum_BitBoxApp.png)
407407
408408
---
409409
@@ -459,4 +459,4 @@ Make sure to check the [release notes](https://github.com/romanz/electrs/blob/ma
459459
460460
---
461461
462-
Next: [Blockchain Explorer >>](btcrpcexplorer.md)
462+
Next: [Blockchain explorer >>](blockchain-explorer.md)

bitcoin.md renamed to guide/bitcoin/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ nav_order: 30
55
has_children: true
66
---
77
<!-- markdownlint-disable MD014 MD022 MD025 MD040 -->
8-
{% include_relative include_metatags.md %}
8+
{% include include_metatags.md %}
99

1010
# Bitcoin
1111

bonus-section-separator.md renamed to guide/bonus-section-separator.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,4 +3,4 @@ layout: default
33
title: __________________________
44
nav_order: 99
55
---
6-
<meta http-equiv="refresh" content="0; URL=bonus-section.html">
6+
<meta http-equiv="refresh" content="0; URL=bonus/">

bonus/bitcoin/electrum-personal-server.md.md renamed to guide/bonus/bitcoin/electrum-personal-server.md

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -28,15 +28,15 @@ Status: Not tested v3
2828

2929
### Introduction
3030

31-
The best way to safekeep your bitcoin (meaning the best combination of security and usability) is to use a hardware wallet (like [Ledger](https://www.ledgerwallet.com/) or [Trezor](https://trezor.io/)) in combination with your own Bitcoin node. This gives you security, privacy and eliminates the need to trust a third party to verify transactions.
31+
The best way to safekeep your bitcoin (meaning the best combination of security and usability) is to use a hardware wallet (like [Ledger](https://www.ledgerwallet.com/){:target="_blank"} or [Trezor](https://trezor.io/)){:target="_blank"} in combination with your own Bitcoin node. This gives you security, privacy and eliminates the need to trust a third party to verify transactions.
3232

3333
With the RaspiBolt setup, the Bitcoin Core wallet on the node can only be used from the command line as no graphical user interface is installed. As Bitcoin Core does not offer support for hardware wallets, only a "hot wallet" (exposed to the internet) can be realized.
3434

35-
One possibility to use Bitcoin Core with more functionality is to set up an additional [ElectrumX](https://github.com/kyuupichan/electrumx) server and then use the great [Electrum wallet](https://electrum.org/) (on your regular computer) that integrates with hardware wallets. But this setup is not easy, and the overhead is more than a Raspberry Pi can handle.
35+
One possibility to use Bitcoin Core with more functionality is to set up an additional [ElectrumX](https://github.com/kyuupichan/electrumx){:target="_blank"} server and then use the great [Electrum wallet](https://electrum.org/){:target="_blank"} (on your regular computer) that integrates with hardware wallets. But this setup is not easy, and the overhead is more than a Raspberry Pi can handle.
3636

37-
The new [Electrum Personal Server](https://github.com/chris-belcher/electrum-personal-server) makes it possible to connect Electrum (using your hardware wallet) directly to your RaspiBolt. In contrast to ElectrumX, this is not a full server that serves multiple users, but your own dedicated backend.
37+
The new [Electrum Personal Server](https://github.com/chris-belcher/electrum-personal-server){:target="_blank"} makes it possible to connect Electrum (using your hardware wallet) directly to your RaspiBolt. In contrast to ElectrumX, this is not a full server that serves multiple users, but your own dedicated backend.
3838

39-
Before using this setup, please familiarize yourself with all components by setting up your own Electrum wallet, visiting the linked project websites and reading [The Electrum Personal Server Will Give Users the Full Node Security They Need](https://bitcoinmagazine.com/articles/electrum-personal-server-will-give-users-full-node-security-they-need/) in Bitcoin Magazine.
39+
Before using this setup, please familiarize yourself with all components by setting up your own Electrum wallet, visiting the linked project websites and reading [The Electrum Personal Server Will Give Users the Full Node Security They Need](https://bitcoinmagazine.com/articles/electrum-personal-server-will-give-users-full-node-security-they-need/){:target="_blank"} in Bitcoin Magazine.
4040

4141
### Preparations
4242

@@ -46,7 +46,7 @@ Before using this setup, please familiarize yourself with all components by sett
4646
$ sudo pip3 install setuptools
4747
```
4848

49-
* Configure firewall to allow incoming requests (please check if you need to adjust the subnet mask as [described in original setup](raspibolt_20_pi.md#enabling-the-uncomplicated-firewall))
49+
* Configure firewall to allow incoming requests (please check if you need to adjust the subnet mask as [described in original setup](../../raspberry-pi/security.md#enabling-the-uncomplicated-firewall))
5050
```sh
5151
$ sudo ufw allow from 192.168.0.0/24 to any port 50002 comment 'allow EPS from local network'
5252
$ sudo ufw enable
@@ -66,7 +66,7 @@ Electrum Personal Server uses the Bitcoin Core wallet with "watch-only" addresse
6666
* Open a "bitcoin" user session and change into the home directory
6767
`$ sudo su - bitcoin`
6868

69-
* Download, verify and extract the latest release (check the [Releases page](https://github.com/chris-belcher/electrum-personal-server/releases) on Github for the correct links)
69+
* Download, verify and extract the latest release (check the [Releases page](https://github.com/chris-belcher/electrum-personal-server/releases){:target="_blank"} on Github for the correct links)
7070

7171
```sh
7272
# create new directory on external hdd
@@ -118,10 +118,10 @@ Electrum Personal Server uses the Bitcoin Core wallet with "watch-only" addresse
118118
$ pip3 install --user .
119119
```
120120
121-
![Install Electrum Personal Server with Python Pip](./images/60_eps_pip_install.png)
121+
![Install Electrum Personal Server with Python Pip](../../../images/60_eps_pip_install.png)
122122
123123
### First start
124-
The Electrum Personal Server scripts are installed in the directory `/home/bitcoin/.local/bin/`. Unfortunately, in Raspberry Pi OS this directory is not in the system path, so the full path needs to be specified when calling these scripts. Alternatively, just [add this directory to your $PATH environment variable](https://unix.stackexchange.com/questions/26047/how-to-correctly-add-a-path-to-path), but it's not necessary in this guide.
124+
The Electrum Personal Server scripts are installed in the directory `/home/bitcoin/.local/bin/`. Unfortunately, in Raspberry Pi OS this directory is not in the system path, so the full path needs to be specified when calling these scripts. Alternatively, just [add this directory to your $PATH environment variable](https://unix.stackexchange.com/questions/26047/how-to-correctly-add-a-path-to-path){:target="_blank"}, but it's not necessary in this guide.
125125
126126
* The first time the server is run it will import all configured addresses as watch-only into the Bitcoin node. This can take up to 10 minutes, after that the program will exit.
127127
```sh
@@ -143,7 +143,7 @@ The Electrum Personal Server scripts are installed in the directory `/home/bitco
143143
$ /home/bitcoin/.local/bin/electrum-personal-server /home/bitcoin/electrum-personal-server/config.cfg
144144
```
145145
146-
[![Run Electrum Personal Server manually](images/60_eps_first-start.png)](images/60_eps_first-start.png)
146+
[![Run Electrum Personal Server manually](../../../images/60_eps_first-start.png)
147147
148148
### Connect Electrum
149149
@@ -153,11 +153,11 @@ On your regular computer, configure Electrum to use your RaspiBolt:
153153
* Uncheck "Select server automatically"
154154
* Enter the IP of your RaspiBolt (eg. 192.168.0.20) in the address field
155155
156-
[![Connect Electrum to RaspiBolt](images/60_eps_electrum-connect.png)](images/60_eps_electrum-connect.png)
156+
[![Connect Electrum to RaspiBolt](../../../images/60_eps_electrum-connect.png)
157157
158158
* `Close` and check connection in tab "Console"
159159
160-
[![Check Electrum console](images/60_eps_electrumwallet.png)](images/60_eps_electrumwallet.png)
160+
[![Check Electrum console](../../../images/60_eps_electrumwallet.png)
161161
162162
* This can also be achived by starting the Electrum wallet with the following command line arguments:
163163
`--oneserver --server 192.168.0.20:50002:s`
File renamed without changes.

bonus/bitcoin/mempool.md renamed to guide/bonus/bitcoin/mempool.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ Difficulty: Medium
2121
Status: Tested v3
2222
{: .label .label-green }
2323

24-
![Mempool](../../images/mempool.png)
24+
![Mempool](../../../images/mempool.png)
2525

2626
---
2727

@@ -56,7 +56,7 @@ To run Mempool, we need to run Node.js v16 or above.
5656
> v16.13.1
5757
```
5858

59-
* If Node.js is not installed, follow [this guide](https://raspibolt.org/btcrpcexplorer.html#install-nodejs) to install it. If the version is v14 or older, update it following [this tutorial](https://phoenixnap.com/kb/update-node-js-version){:target="_blank"}.
59+
* If Node.js is not installed, follow [this guide](../../bitcoin/blockchain-explorer.md#install-nodejs) to install it. If the version is v14 or older, update it following [this tutorial](https://phoenixnap.com/kb/update-node-js-version){:target="_blank"}.
6060

6161
### Firewall
6262

0 commit comments

Comments
 (0)