From b837b52cb804af68dfdf1a63061aee14424bd821 Mon Sep 17 00:00:00 2001 From: Josh Wong Date: Sun, 19 May 2024 17:53:25 +0900 Subject: [PATCH 1/4] Change syntax from Material for MkDocs to Docusaurus --- docs/index.md | 8 +-- docs/installation-and-setup/01_preparation.md | 16 +++--- docs/installation-and-setup/02_bchn-setup.md | 28 +++++----- .../installation-and-setup/03_wallet-setup.md | 24 +++++---- docs/installation-and-setup/index.md | 12 +++-- docs/upgrade/01_preparation.md | 8 +-- docs/upgrade/02_bchn-upgrade.md | 54 ++++++++++--------- docs/upgrade/03_cleanup.md | 14 ++--- 8 files changed, 95 insertions(+), 69 deletions(-) diff --git a/docs/index.md b/docs/index.md index c4976925..252dfe2a 100644 --- a/docs/index.md +++ b/docs/index.md @@ -7,9 +7,11 @@ The set of Bitcoin Cash Node tutorials in this section includes instructions for These tutorials are intended for those who are familiar with the Ubuntu environment and Linux commands. -!!! note - - I'm using a Raspberry Pi 4 simply to minimize carbon footprint while still contributing to the health and decentralization of Bitcoin Cash. However, these instructions should work on other types of devices running Ubuntu Desktop. +:::note + +I'm using a Raspberry Pi 4 simply to minimize carbon footprint while still contributing to the health and decentralization of Bitcoin Cash. However, these instructions should work on other types of devices running Ubuntu Desktop. + +::: ## Introduction to Bitcoin Cash Node diff --git a/docs/installation-and-setup/01_preparation.md b/docs/installation-and-setup/01_preparation.md index d226ff5d..838db443 100644 --- a/docs/installation-and-setup/01_preparation.md +++ b/docs/installation-and-setup/01_preparation.md @@ -37,9 +37,11 @@ In our router, we need to allow connections to port 8333. This is the port that 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. -!!! warning - - If you don't configure a static IP address, you may encounter connection issues when you restart or reboot your Raspberry Pi. By setting a static IP address, you can make sure the same IP address is still allowing communication from port 8333. +:::warning + +If you don't configure a static IP address, you may encounter connection issues when you restart or reboot your Raspberry Pi. By setting a static IP address, you can make sure the same IP address is still allowing communication from port 8333. + +::: ## Turn on swap @@ -47,6 +49,8 @@ We need our Bitcoin Cash Node to continue running if the RAM on our Raspberry Pi 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/). -!!! note - - You can experiment with this as necessary, but the Raspberry Pi might become unresponsive if swap is turned off or does not have enough RAM allocated. +:::note + +You can experiment with this as necessary, but the Raspberry Pi might become unresponsive if swap is turned off or does not have enough RAM allocated. + +::: diff --git a/docs/installation-and-setup/02_bchn-setup.md b/docs/installation-and-setup/02_bchn-setup.md index 9aa9278a..a637469d 100644 --- a/docs/installation-and-setup/02_bchn-setup.md +++ b/docs/installation-and-setup/02_bchn-setup.md @@ -10,16 +10,16 @@ Make sure the latest version of BCHN is selected. Under **Linux**, download the After the compressed package finishes downloading, let's 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 `` in the command below with the directory where we saved the compressed package to. +To do so, let's open **Terminal** and go to the directory where you downloaded the package to. Be sure to replace `` in the command below with the directory where we saved the compressed package to. ```console -cd / +cd / ``` -Next, let's extract the compressed package. When running the following command in **Terminal**, be sure to replace `` with the version number that matches the package we downloaded. +Next, let's extract the compressed package. When running the following command in **Terminal**, be sure to replace `` with the version number that matches the package we downloaded. ```console -sudo tar -xvzf bitcoin-cash-node--aarch64-linux-gnu.tar.gz +sudo tar -xvzf bitcoin-cash-node--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. @@ -32,14 +32,16 @@ mkdir blockchain-data Now that we've extracted the Bitcoin Cash Node package, let's run the software and start downloading the blockchain transactions to our 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. +:::note -To start the Bitcoin Cash Node software, run the following command in **Terminal**. Be sure to replace `` with the version number that matches the package we downloaded. +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 `` with the version number that matches the package we downloaded. ```console -sudo bitcoin-cash-node-/bin/bitcoin-qt +sudo bitcoin-cash-node-/bin/bitcoin-qt ``` The Bitcoin Cash Node software then prompts us to specify where to download the blockchain transactions to. @@ -60,8 +62,10 @@ After all the Bitcoin Cash transactions have finished downloading to your SSD, y To monitor inbound and outbound traffic on your node, click **Window** in the menu bar and choose **Network Traffic**. From here, you can see how much data is being transferred to and from your node. -!!! note - - The "Received" and "Sent" under "Totals" will reset if you restart the Bitcoin Cash Node software. Additionally, the network traffic will reset if you move the slider below the graph. +:::note + +The "Received" and "Sent" under "Totals" will reset if you restart the Bitcoin Cash Node software. Additionally, the network traffic will reset if you move the slider below the graph. + +::: ![Bitcoin Cash Node network traffic 30 minutes](https://github.com/josh-wong/bitcoin-cash-node-on-raspberry-pi/blob/main/docs/assets/screenshots/bitcoin_cash_node_network_traffic_30_minutes.png?raw=true) diff --git a/docs/installation-and-setup/03_wallet-setup.md b/docs/installation-and-setup/03_wallet-setup.md index c0a13734..e7868b32 100644 --- a/docs/installation-and-setup/03_wallet-setup.md +++ b/docs/installation-and-setup/03_wallet-setup.md @@ -2,9 +2,11 @@ Your Bitcoin Cash wallet has already been created at this point, so let's secure it with a password and back it up. -!!! warning - - The instructions in this section are very important. Neglecting to secure your wallet with a password and backing it up could result in you losing the Bitcoin Cash that you receive from others. +:::warning + +The instructions in this section are very important. Neglecting to secure your wallet with a password and backing it up could result in you losing the Bitcoin Cash that you receive from others. + +::: ## Create a password for your wallet @@ -12,9 +14,11 @@ Let's secure your wallet with a password. You will need this password to restore 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. -!!! warning - - Be sure to remember this password. Write it down and put it in a safe, for example. +:::warning + +Be sure to remember this password. Write it down and put it in a safe, for example. + +::: After you have successfully encrypted your wallet with a password, the following confirmation screen will appear. Please carefully read the notice, then click **OK**. @@ -30,9 +34,11 @@ In the menu bar, click **File** and select **Backup Wallet**. When the directory window appears, choose a directory to save the wallet data (.dat) file to. If you don't have your Raspberry Pi set up to communicate with other computers on your network, save the wallet file (.dat) to your Raspberry Pi first and then immediately save it to another device for safe-keeping. -!!! warning - - Do not keep your wallet backup on the same device that hosts your node and wallet. If your device encounters a catastrophic failure, you will not be able to restore the wallet from the backup. Instead, save the wallet backup to a secure, reliable device or devices. +:::warning + +Do not keep your wallet backup on the same device that hosts your node and wallet. If your device encounters a catastrophic failure, you will not be able to restore the wallet from the backup. Instead, save the wallet backup to a secure, reliable device or devices. + +::: Once you have chosen a location, click **OK**. diff --git a/docs/installation-and-setup/index.md b/docs/installation-and-setup/index.md index fb2759ae..42530293 100644 --- a/docs/installation-and-setup/index.md +++ b/docs/installation-and-setup/index.md @@ -16,9 +16,11 @@ These instructions are intended for those who have basic knowledge of the Ubuntu - USB mouse (USB or Bluetooth) - External SSD (500 GB or more) -!!! note - - For the data associated with the Bitcoin Cash blockchain, you should reserve at least 200 GB. Be sure your SSD is large enough to accommodate the growing blockchain if you want to keep verifying transactions for the foreseeable future on your Raspberry Pi. +:::note + +For the data associated with the Bitcoin Cash blockchain, you should reserve at least 200 GB. Be sure your SSD is large enough to accommodate the growing blockchain if you want to keep verifying transactions for the foreseeable future on your Raspberry Pi. - - Raspberry Pi case with a GPIO fan and heat sinks (recommended) - - Reliable Internet connection +- Raspberry Pi case with a GPIO fan and heat sinks (recommended) +- Reliable Internet connection + +::: diff --git a/docs/upgrade/01_preparation.md b/docs/upgrade/01_preparation.md index 46401e7f..8fedf60e 100644 --- a/docs/upgrade/01_preparation.md +++ b/docs/upgrade/01_preparation.md @@ -4,9 +4,11 @@ Before upgrading Bitcoin Cash Node, we should back up our wallet (in the .dat fi ## Optional: Back up your Bitcoin Cash wallet -!!! warning - - This step is optional since you will be moving your blockchain data, which includes your wallet, from the old Bitcoin Cash Node directory into a new directory. However, temporarily backing up your wallet is still recommended just in case you encounter an issue during the upgrade. +:::warning + +This step is optional since you will be moving your blockchain data, which includes your wallet, from the old Bitcoin Cash Node directory into a new directory. However, temporarily backing up your wallet is still recommended just in case you encounter an issue during the upgrade. + +::: 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) diff --git a/docs/upgrade/02_bchn-upgrade.md b/docs/upgrade/02_bchn-upgrade.md index 87d08685..9bf43002 100644 --- a/docs/upgrade/02_bchn-upgrade.md +++ b/docs/upgrade/02_bchn-upgrade.md @@ -10,29 +10,29 @@ Make sure the latest version of BCHN is selected. Under **Linux**, download the After the compressed package finishes downloading, let's move the compressed file to the SSD. To do so, open **Terminal** and run the following command. Be sure to: -- Replace `` with the version number that matches the package we just downloaded. -- Replace `` with the name of our SSD drive where the current Bitcoin Cash Node lives. +- Replace `` with the version number that matches the package we just downloaded. +- Replace `` with the name of our SSD drive where the current Bitcoin Cash Node lives. ```console -sudo mv Downloads/bitcoin-cash-node--aarch64-linux-gnu.tar.gz / +sudo mv Downloads/bitcoin-cash-node--aarch64-linux-gnu.tar.gz / ``` -Next, let's go to the SSD directory by running the following command. Be sure to replace `` in the command below with the directory where we saved the compressed package to. +Next, let's go to the SSD directory by running the following command. Be sure to replace `` in the command below with the directory where we saved the compressed package to. ```console - cd / + cd / ``` -Now, let's extract the compressed package. Let's open **Terminal** and run the following command. Be sure to replace ` with the version number that matches the package we downloaded. +Now, let's extract the compressed package. Let's open **Terminal** and run the following command. Be sure to replace ` with the version number that matches the package we downloaded. ```console -sudo tar -xvzf bitcoin-cash-node--aarch64-linux-gnu.tar.gz +sudo tar -xvzf bitcoin-cash-node--aarch64-linux-gnu.tar.gz ``` -The files from the newer version of Bitcoin Cash Node will be extracted to the SSD. We don't need the compressed package anymore, so let's remove it by running the following command in **Terminal**. Be sure to replace `` with the version number that matches the package we downloaded. +The files from the newer version of Bitcoin Cash Node will be extracted to the SSD. We don't need the compressed package anymore, so let's remove it by running the following command in **Terminal**. Be sure to replace `` with the version number that matches the package we downloaded. ```console -sudo rm bitcoin-cash-node--aarch64-linux-gnu.tar.gz +sudo rm bitcoin-cash-node--aarch64-linux-gnu.tar.gz ``` Now that we have our new Bitcoin Cash Node files extracted, let's move the blockchain data to the upgraded version of the Bitcoin Cash Node. @@ -43,40 +43,42 @@ Since we've already been running Bitcoin Cash Node on an earlier version, we don Let's move the blockchain data from our previous installation to the newer version of Bitcoin Cash Node by running the following command. Be sure to: -- Replace `` with the version number of our previous Bitcoin Cash Node installation. -- Replace `` with the name of our directory containing the downloaded blockchain data in our previous Bitcoin Cash Node installation. For example, I had previously named my directory "blockchain-data". -- Replace `` with the version number that matches the package we downloaded earlier. +- Replace `` with the version number of our previous Bitcoin Cash Node installation. +- Replace `` with the name of our directory containing the downloaded blockchain data in our previous Bitcoin Cash Node installation. For example, I had previously named my directory "blockchain-data". +- Replace `` with the version number that matches the package we downloaded earlier. ```console -sudo mv bitcoin-cash-node-/ bitcoin-cash-node- +sudo mv bitcoin-cash-node-/ bitcoin-cash-node- ``` ## Optional: If your wallet does not appear in your blockchain data directory -!!! note - - This step is only necessary if you cannot find your wallet (.dat) in your blockchain data directory. In this case, you can add your wallet, which you previously backed up in [Optional: Back up our Bitcoin Cash wallet](../01_preparation/#optional-back-up-our-bitcoin-cash-wallet). +:::note + +This step is only necessary if you cannot find your wallet (.dat) in your blockchain data directory. In this case, you can add your wallet, which you previously backed up in [Optional: Back up our Bitcoin Cash wallet](../01_preparation/#optional-back-up-our-bitcoin-cash-wallet). + +::: Let's move the wallet file (.dat) that we backed up earlier into the directory of the newer version of Bitcoin Cash Node. In **Terminal**, run the following command. Be sure to: -- Replace `` with the name of the directory where we saved the wallet backup file to earlier. -- Replace `` with the version number of our new Bitcoin Cash Node installation. -- Replace `` with the name of our directory containing the downloaded blockchain data in our previous Bitcoin Cash Node installation. +- Replace `` with the name of the directory where we saved the wallet backup file to earlier. +- Replace `` with the version number of our new Bitcoin Cash Node installation. +- Replace `` with the name of our directory containing the downloaded blockchain data in our previous Bitcoin Cash Node installation. ```console -sudo mv bitcoin-cash-node-/ +sudo mv bitcoin-cash-node-/ ``` ## Run the newer version of Bitcoin Cash Node Now that we've moved the blockchain data to the newer version of Bitcoin Cash Node, let's run the software. -To start the Bitcoin Cash Node software, run the following command in **Terminal**. Be sure to replace `` with the version number that matches the package you downloaded. +To start the Bitcoin Cash Node software, run the following command in **Terminal**. Be sure to replace `` with the version number that matches the package you downloaded. ```console -sudo bitcoin-cash-node-/bin/bitcoin-qt +sudo bitcoin-cash-node-/bin/bitcoin-qt ``` You will be greeted with a **Welcome** window. The directory shown here will likely be pointing to the previous directory, which we've moved to the newer Bitcoin Cash Node directory. @@ -91,9 +93,11 @@ On the **Welcome** window, click **OK**. Since our node was down for a while, our device will start downloading the Bitcoin Cash transactions that we have missed. -!!! note - - The time necessary for downloading the missing transactions will vary depending on how long the node was not running. +:::note + +The time necessary for downloading the missing transactions will vary depending on how long the node was not running. + +::: After the device has finished downloading transactions, the main window of the Bitcoin Cash Node GUI will be displayed. diff --git a/docs/upgrade/03_cleanup.md b/docs/upgrade/03_cleanup.md index d8e8d322..a7061531 100644 --- a/docs/upgrade/03_cleanup.md +++ b/docs/upgrade/03_cleanup.md @@ -2,17 +2,19 @@ Let's clean up our SSD since we no longer need the files from our previous Bitcoin Cash Node installation. -!!! note - - This part is optional but recommended. +:::note + +This part is optional but recommended. + +::: To remove those old files, open a new **Terminal** window and run the following command. Be sure to: -- Replace `` with the name of the SSD directory. -- Replace `` with the version number of the previous Bitcoin Cash Node installation. +- Replace `` with the name of the SSD directory. +- Replace `` with the version number of the previous Bitcoin Cash Node installation. ```console -sudo rm -R //bitcoin-cash-node- +sudo rm -R //bitcoin-cash-node- ``` With the SSD organized, we can avoid confusion when updating Bitcoin Cash Node in the future. From 533ba01a412cd12456c517e815307ce4b68876eb Mon Sep 17 00:00:00 2001 From: Josh Wong Date: Sun, 19 May 2024 17:55:31 +0900 Subject: [PATCH 2/4] Change file extension from `.md` to `.mdx` File extensions in Docusaurus need to be `.mdx` to take advantage of React components. --- docs/{contributions.md => contributions.mdx} | 0 docs/{index.md => index.mdx} | 0 .../{01_preparation.md => 01_preparation.mdx} | 0 .../{02_bchn-setup.md => 02_bchn-setup.mdx} | 0 .../{03_wallet-setup.md => 03_wallet-setup.mdx} | 0 .../{04_conclusion.md => 04_conclusion.mdx} | 0 docs/installation-and-setup/{index.md => index.mdx} | 0 docs/{references.md => references.mdx} | 0 docs/upgrade/{01_preparation.md => 01_preparation.mdx} | 0 docs/upgrade/{02_bchn-upgrade.md => 02_bchn-upgrade.mdx} | 0 docs/upgrade/{03_cleanup.md => 03_cleanup.mdx} | 0 docs/upgrade/{04_conclusion.md => 04_conclusion.mdx} | 0 docs/upgrade/{index.md => index.mdx} | 0 13 files changed, 0 insertions(+), 0 deletions(-) rename docs/{contributions.md => contributions.mdx} (100%) rename docs/{index.md => index.mdx} (100%) rename docs/installation-and-setup/{01_preparation.md => 01_preparation.mdx} (100%) rename docs/installation-and-setup/{02_bchn-setup.md => 02_bchn-setup.mdx} (100%) rename docs/installation-and-setup/{03_wallet-setup.md => 03_wallet-setup.mdx} (100%) rename docs/installation-and-setup/{04_conclusion.md => 04_conclusion.mdx} (100%) rename docs/installation-and-setup/{index.md => index.mdx} (100%) rename docs/{references.md => references.mdx} (100%) rename docs/upgrade/{01_preparation.md => 01_preparation.mdx} (100%) rename docs/upgrade/{02_bchn-upgrade.md => 02_bchn-upgrade.mdx} (100%) rename docs/upgrade/{03_cleanup.md => 03_cleanup.mdx} (100%) rename docs/upgrade/{04_conclusion.md => 04_conclusion.mdx} (100%) rename docs/upgrade/{index.md => index.mdx} (100%) diff --git a/docs/contributions.md b/docs/contributions.mdx similarity index 100% rename from docs/contributions.md rename to docs/contributions.mdx diff --git a/docs/index.md b/docs/index.mdx similarity index 100% rename from docs/index.md rename to docs/index.mdx diff --git a/docs/installation-and-setup/01_preparation.md b/docs/installation-and-setup/01_preparation.mdx similarity index 100% rename from docs/installation-and-setup/01_preparation.md rename to docs/installation-and-setup/01_preparation.mdx diff --git a/docs/installation-and-setup/02_bchn-setup.md b/docs/installation-and-setup/02_bchn-setup.mdx similarity index 100% rename from docs/installation-and-setup/02_bchn-setup.md rename to docs/installation-and-setup/02_bchn-setup.mdx diff --git a/docs/installation-and-setup/03_wallet-setup.md b/docs/installation-and-setup/03_wallet-setup.mdx similarity index 100% rename from docs/installation-and-setup/03_wallet-setup.md rename to docs/installation-and-setup/03_wallet-setup.mdx diff --git a/docs/installation-and-setup/04_conclusion.md b/docs/installation-and-setup/04_conclusion.mdx similarity index 100% rename from docs/installation-and-setup/04_conclusion.md rename to docs/installation-and-setup/04_conclusion.mdx diff --git a/docs/installation-and-setup/index.md b/docs/installation-and-setup/index.mdx similarity index 100% rename from docs/installation-and-setup/index.md rename to docs/installation-and-setup/index.mdx diff --git a/docs/references.md b/docs/references.mdx similarity index 100% rename from docs/references.md rename to docs/references.mdx diff --git a/docs/upgrade/01_preparation.md b/docs/upgrade/01_preparation.mdx similarity index 100% rename from docs/upgrade/01_preparation.md rename to docs/upgrade/01_preparation.mdx diff --git a/docs/upgrade/02_bchn-upgrade.md b/docs/upgrade/02_bchn-upgrade.mdx similarity index 100% rename from docs/upgrade/02_bchn-upgrade.md rename to docs/upgrade/02_bchn-upgrade.mdx diff --git a/docs/upgrade/03_cleanup.md b/docs/upgrade/03_cleanup.mdx similarity index 100% rename from docs/upgrade/03_cleanup.md rename to docs/upgrade/03_cleanup.mdx diff --git a/docs/upgrade/04_conclusion.md b/docs/upgrade/04_conclusion.mdx similarity index 100% rename from docs/upgrade/04_conclusion.md rename to docs/upgrade/04_conclusion.mdx diff --git a/docs/upgrade/index.md b/docs/upgrade/index.mdx similarity index 100% rename from docs/upgrade/index.md rename to docs/upgrade/index.mdx From 3c7c7607b5ccdd46366ee72ac65a3f8b2c91044b Mon Sep 17 00:00:00 2001 From: Josh Wong Date: Sun, 19 May 2024 17:55:38 +0900 Subject: [PATCH 3/4] Delete test.md --- docs/test.md | 52 ---------------------------------------------------- 1 file changed, 52 deletions(-) delete mode 100644 docs/test.md diff --git a/docs/test.md b/docs/test.md deleted file mode 100644 index dec3e34d..00000000 --- a/docs/test.md +++ /dev/null @@ -1,52 +0,0 @@ -# Mermaid - -## MERMAID TEST - -### Gannt diagram - -```mermaid -gantt -dateFormat YYYY-MM-DD -title Adding GANTT diagram to mermaid -excludes weekdays 2014-01-10 - -section A section -Completed task :done, des1, 2014-01-06,2014-01-08 -Active task :active, des2, 2014-01-09, 3d -Future task : des3, after des2, 5d -Future task2 : des4, after des3, 5d -``` - -### Class diagram - -```mermaid -classDiagram -Class01 <|-- AveryLongClass : Cool -Class03 *-- Class04 -Class05 o-- Class06 -Class07 .. Class08 -Class09 --> C2 : Where am i? -Class09 --* C3 -Class09 --|> Class07 -Class07 : equals() -Class07 : Object[] elementData -Class01 : size() -Class01 : int chimp -Class01 : int gorilla -Class08 <--> C2: Cool label -``` - -### Git graph - -```mermaid -gitGraph - commit - commit - branch develop - commit - commit - commit - checkout main - commit - commit -``` From 095ba93f159e6a9ff5e7bb686106db06e6411ba2 Mon Sep 17 00:00:00 2001 From: Josh Wong Date: Sun, 19 May 2024 18:47:55 +0900 Subject: [PATCH 4/4] Revise title; remove first-person voice --- docs/index.mdx | 2 +- .../installation-and-setup/01_preparation.mdx | 16 +++--- docs/installation-and-setup/02_bchn-setup.mdx | 18 +++---- .../03_wallet-setup.mdx | 12 ++--- docs/installation-and-setup/index.mdx | 4 +- docs/upgrade/01_preparation.mdx | 16 +++--- docs/upgrade/02_bchn-upgrade.mdx | 54 +++++++++---------- docs/upgrade/03_cleanup.mdx | 6 +-- docs/upgrade/index.mdx | 4 +- 9 files changed, 67 insertions(+), 65 deletions(-) diff --git a/docs/index.mdx b/docs/index.mdx index 252dfe2a..c8d87acd 100644 --- a/docs/index.mdx +++ b/docs/index.mdx @@ -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: diff --git a/docs/installation-and-setup/01_preparation.mdx b/docs/installation-and-setup/01_preparation.mdx index 838db443..f3fe458f 100644 --- a/docs/installation-and-setup/01_preparation.mdx +++ b/docs/installation-and-setup/01_preparation.mdx @@ -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 @@ -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 @@ -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. @@ -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/). diff --git a/docs/installation-and-setup/02_bchn-setup.mdx b/docs/installation-and-setup/02_bchn-setup.mdx index a637469d..9e6b7217 100644 --- a/docs/installation-and-setup/02_bchn-setup.mdx +++ b/docs/installation-and-setup/02_bchn-setup.mdx @@ -1,28 +1,28 @@ -# 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 `` 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 `` in the command below with the directory where you saved the compressed package to. ```console cd / ``` -Next, let's extract the compressed package. When running the following command in **Terminal**, be sure to replace `` with the version number that matches the package we downloaded. +Next, extract the compressed package. When running the following command in **Terminal**, replacing `` with the version number that matches the package you downloaded. ```console sudo tar -xvzf bitcoin-cash-node--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 @@ -30,7 +30,7 @@ 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 @@ -38,13 +38,13 @@ Downloading all the transactions in the blockchain will take a while. You may wa ::: -To start the Bitcoin Cash Node software, run the following command in **Terminal**. Be sure to replace `` with the version number that matches the package we downloaded. +To start the Bitcoin Cash Node software, run the following command in **Terminal**, replacing `` with the version number that matches the package you downloaded. ```console sudo bitcoin-cash-node-/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. diff --git a/docs/installation-and-setup/03_wallet-setup.mdx b/docs/installation-and-setup/03_wallet-setup.mdx index e7868b32..45d5da19 100644 --- a/docs/installation-and-setup/03_wallet-setup.mdx +++ b/docs/installation-and-setup/03_wallet-setup.mdx @@ -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 @@ -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. @@ -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**. @@ -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. diff --git a/docs/installation-and-setup/index.mdx b/docs/installation-and-setup/index.mdx index 42530293..8a40ae23 100644 --- a/docs/installation-and-setup/index.mdx +++ b/docs/installation-and-setup/index.mdx @@ -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. diff --git a/docs/upgrade/01_preparation.mdx b/docs/upgrade/01_preparation.mdx index 8fedf60e..d0b9cdbb 100644 --- a/docs/upgrade/01_preparation.mdx +++ b/docs/upgrade/01_preparation.mdx @@ -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 @@ -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: @@ -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 diff --git a/docs/upgrade/02_bchn-upgrade.mdx b/docs/upgrade/02_bchn-upgrade.mdx index 9bf43002..df8c88c3 100644 --- a/docs/upgrade/02_bchn-upgrade.mdx +++ b/docs/upgrade/02_bchn-upgrade.mdx @@ -1,51 +1,51 @@ -# Upgrading Bitcoin Cash Node +# Upgrade 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 move the compressed file to the SSD. To do so, open **Terminal** and run the following command. Be sure to: +After the compressed package finishes downloading, you should move the compressed file to the SSD. To do so, open **Terminal** and run the following command. Be sure to: -- Replace `` with the version number that matches the package we just downloaded. -- Replace `` with the name of our SSD drive where the current Bitcoin Cash Node lives. +- Replace `` with the version number that matches the package you just downloaded. +- Replace `` with the name of your SSD drive where the current Bitcoin Cash Node lives. ```console sudo mv Downloads/bitcoin-cash-node--aarch64-linux-gnu.tar.gz / ``` -Next, let's go to the SSD directory by running the following command. Be sure to replace `` in the command below with the directory where we saved the compressed package to. +Next, go to the SSD directory by running the following command, replacing `` in the command below with the directory where you saved the compressed package to. ```console cd / ``` -Now, let's extract the compressed package. Let's open **Terminal** and run the following command. Be sure to replace ` with the version number that matches the package we downloaded. +To extract the compressed package, open **Terminal** and run the following command, replacing ` with the version number that matches the package you downloaded. ```console sudo tar -xvzf bitcoin-cash-node--aarch64-linux-gnu.tar.gz ``` -The files from the newer version of Bitcoin Cash Node will be extracted to the SSD. We don't need the compressed package anymore, so let's remove it by running the following command in **Terminal**. Be sure to replace `` with the version number that matches the package we downloaded. +The files from the newer version of Bitcoin Cash Node will be extracted to the SSD. You don't need the compressed package anymore, so you can remove it by running the following command in **Terminal**, replacing `` with the version number that matches the package you downloaded. ```console sudo rm bitcoin-cash-node--aarch64-linux-gnu.tar.gz ``` -Now that we have our new Bitcoin Cash Node files extracted, let's move the blockchain data to the upgraded version of the Bitcoin Cash Node. +Now that you have your new Bitcoin Cash Node files extracted, you should move the blockchain data to the upgraded version of the Bitcoin Cash Node. -## Move our previously downloaded blockchain data +## Move your previously downloaded blockchain data -Since we've already been running Bitcoin Cash Node on an earlier version, we don't need to completely download the blockchain data again. Instead, we can move the blockchain data we previously downloaded to the directory of the newer version of Bitcoin Cash. +Since you've already been running Bitcoin Cash Node on an earlier version, you don't need to completely download the blockchain data again. Instead, you can move the blockchain data you previously downloaded to the directory of the newer version of Bitcoin Cash. -Let's move the blockchain data from our previous installation to the newer version of Bitcoin Cash Node by running the following command. Be sure to: +Now, you need to move the blockchain data from your previous installation to the newer version of Bitcoin Cash Node by running the following command. Be sure to: -- Replace `` with the version number of our previous Bitcoin Cash Node installation. -- Replace `` with the name of our directory containing the downloaded blockchain data in our previous Bitcoin Cash Node installation. For example, I had previously named my directory "blockchain-data". -- Replace `` with the version number that matches the package we downloaded earlier. +- Replace `` with the version number of your previous Bitcoin Cash Node installation. +- Replace `` with the name of your directory containing the downloaded blockchain data in your previous Bitcoin Cash Node installation. For example, I had previously named my directory "blockchain-data". +- Replace `` with the version number that matches the package you downloaded earlier. ```console sudo mv bitcoin-cash-node-/ bitcoin-cash-node- @@ -55,17 +55,17 @@ sudo mv bitcoin-cash-node-/ bitco :::note -This step is only necessary if you cannot find your wallet (.dat) in your blockchain data directory. In this case, you can add your wallet, which you previously backed up in [Optional: Back up our Bitcoin Cash wallet](../01_preparation/#optional-back-up-our-bitcoin-cash-wallet). +This step is only necessary if you cannot find your wallet (.dat) in your blockchain data directory. In this case, you can add your wallet, which you previously backed up in [Optional: Back up your Bitcoin Cash wallet](../01_preparation/#optional-back-up-our-bitcoin-cash-wallet). ::: -Let's move the wallet file (.dat) that we backed up earlier into the directory of the newer version of Bitcoin Cash Node. +You should move the wallet file (.dat) that you backed up earlier into the directory of the newer version of Bitcoin Cash Node. In **Terminal**, run the following command. Be sure to: -- Replace `` with the name of the directory where we saved the wallet backup file to earlier. -- Replace `` with the version number of our new Bitcoin Cash Node installation. -- Replace `` with the name of our directory containing the downloaded blockchain data in our previous Bitcoin Cash Node installation. +- Replace `` with the name of the directory where you saved the wallet backup file to earlier. +- Replace `` with the version number of your new Bitcoin Cash Node installation. +- Replace `` with the name of your directory containing the downloaded blockchain data in your previous Bitcoin Cash Node installation. ```console sudo mv bitcoin-cash-node-/ @@ -73,25 +73,25 @@ sudo mv bitcoin-cash-node-/` with the version number that matches the package you downloaded. +To start the Bitcoin Cash Node software, run the following command in **Terminal**, replacing `` with the version number that matches the package you downloaded. ```console sudo bitcoin-cash-node-/bin/bitcoin-qt ``` -You will be greeted with a **Welcome** window. The directory shown here will likely be pointing to the previous directory, which we've moved to the newer Bitcoin Cash Node directory. +You'll be greeted with a **Welcome** window. The directory shown here will likely be pointing to the previous directory, which you've moved to the newer Bitcoin Cash Node directory. ![Bitcoin Cash Node welcome screen](https://github.com/josh-wong/bitcoin-cash-node-on-raspberry-pi/blob/main/docs/assets/screenshots/upgrade_bitcoin_cash_node_welcome.png?raw=true) Under **Use a custom data directory**, click the **three dots** to choose a different directory. The **Choose data directory** window will be displayed. -Go to the newer Bitcoin Cash Node directory, select the directory that contains the blockchain data that we moved earlier, and click **Choose**. As mentioned earlier, you can see my directory name is "blockchain-data". +Go to the newer Bitcoin Cash Node directory, select the directory that contains the blockchain data that you moved earlier, and click **Choose**. As mentioned earlier, you can see my directory name is "blockchain-data". ![Change Bitcoin Cash Node blockchain directory](https://github.com/josh-wong/bitcoin-cash-node-on-raspberry-pi/blob/main/docs/assets/screenshots/upgrade_bitcoin_cash_node_welcome_change_directory.png?raw=true) On the **Welcome** window, click **OK**. -Since our node was down for a while, our device will start downloading the Bitcoin Cash transactions that we have missed. +Since your node was down for a while, your device will start downloading the Bitcoin Cash transactions that you've missed. :::note @@ -103,8 +103,8 @@ After the device has finished downloading transactions, the main window of the B ## Confirm Bitcoin Cash Node version -To confirm which version of Bitcoin Cash Node we are running, click **Help** and select **About Bitcoin Cash Node**. +To confirm which version of Bitcoin Cash Node you're running, click **Help** and select **About Bitcoin Cash Node**. ![About Bitcoin Cash Node](https://github.com/josh-wong/bitcoin-cash-node-on-raspberry-pi/blob/main/docs/assets/screenshots/upgrade_bitcoin_cash_node_help_about.png?raw=true) -Our version will be displayed on the window that appears. +Your version will be displayed on the window that appears. ![About Bitcoin Cash Node](https://github.com/josh-wong/bitcoin-cash-node-on-raspberry-pi/blob/main/docs/assets/screenshots/upgrade_bitcoin_cash_node_about.png?raw=true) diff --git a/docs/upgrade/03_cleanup.mdx b/docs/upgrade/03_cleanup.mdx index a7061531..a6b73c78 100644 --- a/docs/upgrade/03_cleanup.mdx +++ b/docs/upgrade/03_cleanup.mdx @@ -1,6 +1,6 @@ -# Cleaning up old files +# Clean up old files -Let's clean up our SSD since we no longer need the files from our previous Bitcoin Cash Node installation. +You should clean up your SSD since you no longer need the files from your previous Bitcoin Cash Node installation. :::note @@ -17,4 +17,4 @@ To remove those old files, open a new **Terminal** window and run the following sudo rm -R //bitcoin-cash-node- ``` -With the SSD organized, we can avoid confusion when updating Bitcoin Cash Node in the future. +With the SSD organized, you can avoid confusion when updating Bitcoin Cash Node in the future. diff --git a/docs/upgrade/index.mdx b/docs/upgrade/index.mdx index f8ab2b76..f808ca50 100644 --- a/docs/upgrade/index.mdx +++ b/docs/upgrade/index.mdx @@ -1,10 +1,10 @@ -# How to upgrade Bitcoin Cash Node on a Raspberry Pi 4 running Ubuntu Desktop +# Overview This tutorial describes how to upgrade [Bitcoin Cash Node](https://bitcoincashnode.org/) on a Raspberry Pi 4 running Ubuntu Desktop (64-bit). You will occasionally need to upgrade your Bitcoin Cash Node to meet certain protocol requirements and feature updates. -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. +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.