Skip to content

Commit

Permalink
Revise title; remove first-person voice
Browse files Browse the repository at this point in the history
  • Loading branch information
josh-wong committed May 19, 2024
1 parent 3c7c760 commit 095ba93
Show file tree
Hide file tree
Showing 9 changed files with 67 additions and 65 deletions.
2 changes: 1 addition & 1 deletion docs/index.mdx
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# How to install, configure, and upgrade Bitcoin Cash Node on a Raspberry Pi 4 running Ubuntu Desktop
# Overview

The set of Bitcoin Cash Node tutorials in this section includes instructions for the following:

Expand Down
16 changes: 8 additions & 8 deletions docs/installation-and-setup/01_preparation.mdx
Original file line number Diff line number Diff line change
@@ -1,13 +1,13 @@
# Preparing our device
# Prepare your device

This tutorial assumes that we have already installed and configured Ubuntu Desktop on our Raspberry Pi to our liking and have mounted the SSD to our Raspberry Pi.
This tutorial assumes that you've already installed and configured Ubuntu Desktop on your Raspberry Pi to your liking and have mounted the SSD to your Raspberry Pi.

1. **For details on installing Ubuntu Desktop (64-bit) on your Raspberry Pi**, please see [How to install Ubuntu Desktop on Raspberry Pi 4](https://ubuntu.com/tutorials/how-to-install-ubuntu-desktop-on-raspberry-pi-4#1-overview).
2. **For details on automounting your SSD in Ubuntu**, please see [How to properly automount a drive in Ubuntu Linux](https://www.techrepublic.com/article/how-to-properly-automount-a-drive-in-ubuntu-linux/).

## Check our Ubuntu architecture
## Check your Ubuntu architecture

Before we proceed, let's make sure we're running the aarch64 version of Ubuntu on our Raspberry Pi. Run the following command in **Terminal**.
Before you proceed, make sure you're running the aarch64 version of Ubuntu on your Raspberry Pi. Run the following command in **Terminal**.

```console
uname -m
Expand All @@ -17,7 +17,7 @@ If `aarch64` is not output, please follow the instructions in [How to install Ub

## Update and upgrade your Raspberry Pi and Ubuntu

After setting up Ubuntu Desktop and automounting your SSD, let's update and upgrade your Raspberry Pi and Ubuntu by running the following commands in **Terminal**.
After setting up Ubuntu Desktop and automounting your SSD, update and upgrade your Raspberry Pi and Ubuntu by running the following commands in **Terminal**.

```console
sudo apt update && sudo apt upgrade -y
Expand All @@ -27,13 +27,13 @@ Wait for updates and upgrades to install. If prompted, reboot your device and th

## Set a static IP address

We need to configure a static IP address and then set up port forwarding so that our Raspberry Pi can continue to communicate with other nodes even if we reboot the device.
You need to configure a static IP address and then set up port forwarding so that your Raspberry Pi can continue to communicate with other nodes even if you reboot the device.

For instructions on how to set a static IP address in Ubuntu, see Method 1 (command line) or Method 2 (GUI) in [How to Assign Static IP Address on Ubuntu Linux](https://itsfoss.com/static-ip-ubuntu/).

## Allow connections to port 8333

In our router, we need to allow connections to port 8333. This is the port that allows the node to sync properly.
In your router, you need to allow connections to port 8333. This is the port that allows the node to sync properly.

For details on how to allow port forwarding, please consult your router's manual. You typically need to include your device's static IP address and the port number (8333) in the Port Forwarding or NAT Forwarding setting, depending on your router.

Expand All @@ -45,7 +45,7 @@ If you don't configure a static IP address, you may encounter connection issues

## Turn on swap

We need our Bitcoin Cash Node to continue running if the RAM on our Raspberry Pi gets full. To address this, we need to enable swap on our device.
You need your Bitcoin Cash Node to continue running if the RAM on your Raspberry Pi gets full. To address this, you need to enable swap on your device.

For instructions on how to check if swap is enabled and configure swap appropriately, see [How to Add Swap Space on Ubuntu 20.04](https://www.cloudbooklet.com/how-to-add-swap-space-on-ubuntu-20-04/).

Expand Down
18 changes: 9 additions & 9 deletions docs/installation-and-setup/02_bchn-setup.mdx
Original file line number Diff line number Diff line change
@@ -1,50 +1,50 @@
# Setting up Bitcoin Cash Node
# Set up Bitcoin Cash Node

## Download and extract the Bitcoin Cash Node package

Open a web browser on the Raspberry Pi, and go to the **[Download](https://bitcoincashnode.org/en/download.html)** page on the Bitcoin Cash Node website.

Make sure the latest version of BCHN is selected. Under **Linux**, download the **AARCH 64 (tar)** package to the home directory on our mounted SSD. Downloading this compressed package should take about 1 minute.
Make sure the latest version of BCHN is selected. Under **Linux**, download the **AARCH 64 (tar)** package to the home directory on your mounted SSD. Downloading this compressed package should take about 1 minute.

![Bitcoin Cash Node download screen](https://github.com/josh-wong/bitcoin-cash-node-on-raspberry-pi/blob/main/docs/assets/screenshots/bitcoin_cash_node_download.png?raw=true)

After the compressed package finishes downloading, let's extract the compressed package.
After the compressed package finishes downloading, you'll need to extract the compressed package.

To do so, let's open **Terminal** and go to the directory where you downloaded the package to. Be sure to replace `<SSD_DIRECTORY_CONTAINING_DOWNLOADED_PACKAGE>` in the command below with the directory where we saved the compressed package to.
To do so, open **Terminal** and go to the directory where you downloaded the package to, replacing `<SSD_DIRECTORY_CONTAINING_DOWNLOADED_PACKAGE>` in the command below with the directory where you saved the compressed package to.

```console
cd /<SSD_DIRECTORY_CONTAINING_DOWNLOADED_PACKAGE>
```

Next, let's extract the compressed package. When running the following command in **Terminal**, be sure to replace `<VERSION_NUMBER_DOWNLOADED>` with the version number that matches the package we downloaded.
Next, extract the compressed package. When running the following command in **Terminal**, replacing `<VERSION_NUMBER_DOWNLOADED>` with the version number that matches the package you downloaded.

```console
sudo tar -xvzf bitcoin-cash-node-<VERSION_NUMBER_DOWNLOADED>-aarch64-linux-gnu.tar.gz
```

While we're in this directory, let's create a new directory to store the blockchain data and keep things tidy. In **Terminal**, run the following command.
While you're in this directory, create a new directory to store the blockchain data and keep things tidy. In **Terminal**, run the following command.

```console
mkdir blockchain-data
```

## Run Bitcoin Cash Node

Now that we've extracted the Bitcoin Cash Node package, let's run the software and start downloading the blockchain transactions to our node.
Now that you've extracted the Bitcoin Cash Node package, you need to run the software and start downloading the blockchain transactions to your node.

:::note

Downloading all the transactions in the blockchain will take a while. You may want to start the Bitcoin Cash Node software a couple hours before going to bed, as you may experience a slow Internet connection.

:::

To start the Bitcoin Cash Node software, run the following command in **Terminal**. Be sure to replace `<VERSION_NUMBER_DOWNLOADED>` with the version number that matches the package we downloaded.
To start the Bitcoin Cash Node software, run the following command in **Terminal**, replacing `<VERSION_NUMBER_DOWNLOADED>` with the version number that matches the package you downloaded.

```console
sudo bitcoin-cash-node-<VERSION_NUMBER_DOWNLOADED>/bin/bitcoin-qt
```

The Bitcoin Cash Node software then prompts us to specify where to download the blockchain transactions to.
The Bitcoin Cash Node software then prompts you to specify where to download the blockchain transactions to.

Under **Use a custom data directory**, click the **three dots** to choose a directory.

Expand Down
12 changes: 6 additions & 6 deletions docs/installation-and-setup/03_wallet-setup.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Setting up your Bitcoin Cash wallet
# Set up your Bitcoin Cash wallet

Your Bitcoin Cash wallet has already been created at this point, so let's secure it with a password and back it up.
Your Bitcoin Cash wallet has already been created at this point, so you should secure it with a password and back it up.

:::warning

Expand All @@ -10,7 +10,7 @@ The instructions in this section are very important. Neglecting to secure your w

## Create a password for your wallet

Let's secure your wallet with a password. You will need this password to restore it from the backup, which you will create after setting a password.
You should secure your wallet with a password. You will need this password to restore it from the backup, which you will create after setting a password.

In the menu bar, click **Settings**, then select **Encrypt Wallet**. When the password setup window appears, enter a secure password. Enter the same password again to confirm it.

Expand All @@ -26,9 +26,9 @@ After you have successfully encrypted your wallet with a password, the following

## Back up your wallet

Now, let's back up your wallet.
Now, you should back up your wallet.

Backing up your wallet let's you restore it if the device hosting your node and wallet encounters a catastrophic failure.
Backing up your wallet lets you restore it if the device hosting your node and wallet encounters a catastrophic failure.

In the menu bar, click **File** and select **Backup Wallet**.

Expand All @@ -44,7 +44,7 @@ Once you have chosen a location, click **OK**.

## Optional: Receive Bitcoin Cash in your wallet

Finally, let's test your wallet.
Finally, you should test your wallet.

Click the **Receive** icon. Fill out the information that you consider necessary for your records. All fields are optional and are for your reference.

Expand Down
4 changes: 2 additions & 2 deletions docs/installation-and-setup/index.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# How to install and configure Bitcoin Cash Node on a Raspberry Pi 4 running Ubuntu Desktop
# Overview

This tutorial describes how to install and set up [Bitcoin Cash Node](https://bitcoincashnode.org/) on a Raspberry Pi 4 running Ubuntu Desktop (64-bit). We will focus on using the Bitcoin Cash Node graphical user interface (GUI) so that you can visualize processes on the blockchain and your Bitcoin Cash wallet transactions.
This tutorial describes how to install and set up [Bitcoin Cash Node](https://bitcoincashnode.org/) on a Raspberry Pi 4 running Ubuntu Desktop (64-bit). You'll focus on using the Bitcoin Cash Node graphical user interface (GUI) so that you can visualize processes on the blockchain and your Bitcoin Cash wallet transactions.

These instructions are intended for those who have basic knowledge of the Ubuntu environment and Linux commands.

Expand Down
16 changes: 9 additions & 7 deletions docs/upgrade/01_preparation.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Preparing our device
# Prepare your device

Before upgrading Bitcoin Cash Node, we should back up our wallet (in the .dat file format) and update our device. This will help ensure a smooth upgrade process.
Before upgrading Bitcoin Cash Node, you should back up your wallet (in the .dat file format) and update your device. This will help ensure a smooth upgrade process.

## Optional: Back up your Bitcoin Cash wallet

Expand All @@ -11,16 +11,18 @@ This step is optional since you will be moving your blockchain data, which inclu
:::

In the **Bitcoin Cash Node application**, click **File** and choose **Back up wallet**.

![Back up Bitcoin Cash wallet](https://github.com/josh-wong/bitcoin-cash-node-on-raspberry-pi/blob/main/docs/assets/screenshots/upgrade_bitcoin_cash_node_wallet_backup.png?raw=true)

Then, let's choose a directory to save our wallet backup.
Then, choose a directory to save your wallet backup.

![Save Bitcoin Cash wallet backup](https://github.com/josh-wong/bitcoin-cash-node-on-raspberry-pi/blob/main/docs/assets/screenshots/upgrade_bitcoin_cash_node_wallet_backup_save.png?raw=true)

Our wallet will be saved in the directory we chose. We will be moving this wallet file to the newer version of Bitcoin Cash Node later, so remember where we saved this wallet backup file.
Your wallet will be saved in the directory you chose. You'll be moving this wallet file to the newer version of Bitcoin Cash Node later, so remember where you saved this wallet backup file.

## Update and upgrade Ubuntu Desktop

Before we start the upgrade process, let's exit from Bitcoin Cash Node and install any updates and upgrades to Ubuntu Desktop.
Before you start the upgrade process, you should exit from Bitcoin Cash Node and install any updates and upgrades to Ubuntu Desktop.

To close Bitcoin Cash Node, do one of the following:

Expand All @@ -30,13 +32,13 @@ To close Bitcoin Cash Node, do one of the following:
- **To close the application from Terminal (if that is where you ran Bitcoin Cash Node):** Press **Ctrl + C** on the keyboard.
![Terminal - Close Bitcoin Cash Node](https://github.com/josh-wong/bitcoin-cash-node-on-raspberry-pi/blob/main/docs/assets/screenshots/upgrade_bitcoin_cash_node_close_terminal.png?raw=true)

Now, let's update and upgrade Ubuntu Desktop by running the following command in Terminal.
Now, update and upgrade Ubuntu Desktop by running the following command in Terminal.

```console
sudo apt update && sudo apt upgrade -y
```

Since we might have installed major updates and upgrades, let's reboot the device by running the following command in Terminal.
Since you might have installed major updates and upgrades, reboot the device by running the following command in Terminal.

```console
sudo reboot
Expand Down
Loading

0 comments on commit 095ba93

Please sign in to comment.