GITBOOK-2: No subject

minibolt-guide · Jun 6, 2024 · ab94b1e · ab94b1e
1 parent d467010
commit ab94b1e
Show file tree

Hide file tree

Showing 5 changed files with 222 additions and 11 deletions.
diff --git a/.gitbook/assets/system_overview.png b/.gitbook/assets/system_overview.png
diff --git a/bonus-guides/bitcoin/btcpay-server.md b/bonus-guides/bitcoin/btcpay-server.md
@@ -238,7 +238,7 @@ mkdir src && cd src
 * Set the environment variable version
 
 ```bash
-VERSION=2.5.2
+VERSION=2.5.5
 ```
 
 * Download the NBXplorer source code and enter the folder
@@ -560,7 +560,7 @@ cd src
 * Set variable environment version
 
 ```bash
-VERSION=1.13.1
+VERSION=1.13.2
 ```
 
 * Clone the BTCPay Server official GitHub repository
@@ -1091,7 +1091,7 @@ cd src/NBXplorer
 * Set the environment variable version
 
 ```bash
-VERSION=2.5.2
+VERSION=2.5.5
 ```
 
 * Fetch the changes of the wish latest tag
@@ -1157,6 +1157,27 @@ git config pull.rebase false
 ./build.sh
 ```
 
+<details>
+
+<summary>Example of expected output ⬇️</summary>
+
+```
+MSBuild version 17.8.3+195e7f5a3 for .NET
+  Determining projects to restore...
+  Restored /home/btcpay/src/NBXplorer/NBXplorer.Client/NBXplorer.Client.csproj (in 2.43 sec).
+  Restored /home/btcpay/src/NBXplorer/NBXplorer/NBXplorer.csproj (in 2.47 sec).
+  NBXplorer.Client -> /home/btcpay/src/NBXplorer/NBXplorer.Client/bin/Release/netstandard2.1/NBXplorer.Client.dll
+  NBXplorer -> /home/btcpay/src/NBXplorer/NBXplorer/bin/Release/net8.0/NBXplorer.dll
+
+Build succeeded.
+    0 Warning(s)
+    0 Error(s)
+
+Time Elapsed 00:00:19.80
+```
+
+</details>
+
 * Check the correct installation update
 
 ```bash
@@ -1204,7 +1225,7 @@ cd src/btcpayserver
 * Set the environment variable version
 
 ```bash
-VERSION=1.13.1
+VERSION=1.13.2
 ```
 
 * Fetch the changes of the wish latest tag

diff --git a/bonus-guides/system/system-overview.md b/bonus-guides/system/system-overview.md
@@ -14,8 +14,200 @@ layout:
 
 # System Overview
 
+To get a quick overview of the system status, you can use [a shell script](https://github.com/minibolt-guide/system\_overview) that gathers the most relevant data about the service on the main guide.
+
 {% hint style="success" %}
 Difficulty: Easy
 {% endhint %}
 
 <figure><img src="../../.gitbook/assets/system_overview.png" alt=""><figcaption></figcaption></figure>
+
+### &#x20;Acknowledgments <a href="#acknowledgments" id="acknowledgments"></a>
+
+This is a fork of the [minibolt\_info](https://github.com/rmnscb/minibolt\_info) repository, the main developer of this project is [rmnscb](https://github.com/rmnscb), a member of the MiniBolt community, all the merits go to him. Thank you for your contribution 🧡🫂
+
+## Installation
+
+### Install dependencies
+
+* With user `admin`, install the necessary dependencies using the apt package manager&#x20;
+
+```bash
+sudo apt install jq net-tools netcat
+```
+
+### Install
+
+* Go to the temporary folder
+
+```bash
+cd /tmp
+```
+
+* Clone the GitHub repository and enter it
+
+{% code overflow="wrap" %}
+```bash
+git clone https://github.com/minibolt-guide/system_overview && cd system_overview
+```
+{% endcode %}
+
+* Install it to the system
+
+```bash
+sudo install -m 0755 -o root -g root -t /usr/local/bin *.sh
+```
+
+**(Optional)** Delete the folder of the temporary folder to be ready for the upgrade
+
+```bash
+sudo rm -r /tmp/system_overview
+```
+
+## Run
+
+* Exec the script by typing the next command
+
+```bash
+minibolt.sh
+```
+
+{% hint style="info" %}
+> You should see a loading process, and if you have an `admin` user password set, the prompt should ask you for this. Enter the `password [A]` and enter
+
+> To avoid the prompt asking you to enter the user admin password before the script load, follow [this section](../../bonus/system/ssh-keys.md#disable-admin-password-request-optional-caution). ⚠️**Taking into account that it carries a security risk** ⚠️
+
+> ✅ Finally, the terminal shows you something like the cover photo of this bonus guide 🎨
+{% endhint %}
+
+## Extras (optional)
+
+### Show on login <a href="#show-on-login-optional" id="show-on-login-optional"></a>
+
+You can run the welcome script automatically every time you log in
+
+* With user `admin`, add `minibolt.sh` to the end of your `.bashrc` file
+
+```bash
+echo "minibolt.sh" >> ~/.bashrc
+```
+
+{% hint style="info" %}
+Now log in again as a user `admin` [opening a new SSH session](../../index-1/remote-access.md#access-with-secure-shell) you can see the process of exec script before the prompt shows you.&#x20;
+
+> To avoid the prompt asking you to enter the user admin password before the script load, follow [this section](../../bonus/system/ssh-keys.md#disable-admin-password-request-optional-caution). ⚠️**Taking into account that it carries a security risk** ⚠️
+
+> If you’re in a hurry, you can always press `Ctrl`-`C` to skip the script
+{% endhint %}
+
+{% hint style="info" %}
+To uninstall the show on login feature, type the next command:
+
+```bash
+sed -i '/minibolt.sh/d' ~/.bashrc
+```
+
+Now log in again as a user `admin` [opening a new SSH session](../../index-1/remote-access.md#access-with-secure-shell) to see that it doesn't appear anymore
+{% endhint %}
+
+### Get the `channel.db` size of an old LND bbolt database backend
+
+* With user `admin`, go to the temporary folder
+
+```bash
+cd /tmp
+```
+
+* Clone the dedicated branch of the GitHub repository and enter it
+
+{% code overflow="wrap" %}
+```bash
+git clone --branch LND_bboltdb https://github.com/minibolt-guide/system_overview && cd system_overview
+```
+{% endcode %}
+
+* Check out again the correct branch
+
+```bash
+git checkout LND_bboltdb
+```
+
+Expected output:
+
+```
+Already on 'LND_bboltdb'
+Your branch is up to date with 'origin/LND_bboltdb'.
+```
+
+* Install it to the system
+
+```bash
+sudo install -m 0755 -o root -g root -t /usr/local/bin *.sh
+```
+
+* Run following the properly [Run section](system-overview.md#run)
+
+**(Optional)** Delete the folder of the temporary folder to be ready for the upgrade
+
+```bash
+sudo rm -r /tmp/system_overview
+```
+
+### Use the MobaXterm compatibility version
+
+MobaXterm is not compatible with special characters like "₿", by default. So we should replace it with the simple character "B".
+
+* With user `admin`, go to the temporary folder
+
+```bash
+cd /tmp
+```
+
+* Clone the dedicated branch of the GitHub repository and enter it
+
+{% code overflow="wrap" %}
+```bash
+git clone --branch LND_postgres_mobaX https://github.com/minibolt-guide/system_overview && cd system_overview
+```
+{% endcode %}
+
+* Check out again the correct branch
+
+```bash
+git checkout LND_postgres_mobaX
+```
+
+Expected output:
+
+```
+Already on 'LND_postgres_mobaX'
+Your branch is up to date with 'origin/LND_postgres_mobaX'.
+```
+
+* Install it to the system
+
+```bash
+sudo install -m 0755 -o root -g root -t /usr/local/bin *.sh
+```
+
+* Run following the properly [Run section](system-overview.md#run)
+
+**(Optional)** Delete the folder of the temporary folder to be ready for the upgrade
+
+```bash
+sudo rm -r /tmp/system_overview
+```
+
+## Upgrade
+
+To upgrade, follow the complete [Installation process](system-overview.md#install) and [Run](system-overview.md#run) again
+
+## Uninstall
+
+* With user `admin`, type the next command to uninstall
+
+{% code overflow="wrap" %}
+```bash
+sudo rm /usr/local/bin/minibolt.sh && sudo rm /usr/local/bin/get_LND_data.sh && sudo rm /usr/local/bin/get_CLN_data.sh
+```
+{% endcode %}
diff --git a/bonus/system/aliases.md b/bonus/system/aliases.md
@@ -31,7 +31,7 @@ Difficulty: Easy
 
 The following list of aliases was derived from contributions by [RobClark56](https://github.com/robclark56) and [2FakTor](https://github.com/twofaktor).
 
-## Configuration
+## Installation
 
 * With user `admin`, ensure you are on `home` folder and download the aliases list provided for a MiniBolt environment
 
@@ -47,7 +47,7 @@ wget https://raw.githubusercontent.com/minibolt-guide/minibolt/main/resources/.b
 ```
 {% endcode %}
 
-If you want, inspect the list of aliases to make sure it does not do bad things, and modify it with your personal aliases if you want. Exit with Ctrl-X
+If you want, inspect the list of aliases to make sure it does not do bad things, and modify it with your personal aliases. Exit with `Ctrl-X`
 
 ```sh
 nano .bash_aliases

diff --git a/itcoin/bitcoin/bitcoin-client.md b/itcoin/bitcoin/bitcoin-client.md
@@ -170,8 +170,6 @@ sudo rm -r bitcoin-$VERSION && sudo rm bitcoin-$VERSION-x86_64-linux-gnu.tar.gz
 ```
 {% endcode %}
 
-
-
 ### Create the bitcoin user & group
 
 The Bitcoin Core application will run in the background as a daemon and use the separate user “bitcoin” for security reasons. This user does not have admin rights and cannot change the system configuration.
@@ -463,7 +461,7 @@ sudo systemctl start bitcoind
 
 <details>
 
-<summary><strong>Example</strong> of expected output on the first terminal with <code>sudo journalctl -fu bitcoind</code> ⬇️</summary>
+<summary><strong>Example</strong> of expected output on the first terminal with <code>journalctl -fu bitcoind</code> ⬇️</summary>
 
 ```
 > 2022-11-24T18:08:04Z Bitcoin Core version v24.0.1.0 (release build)
@@ -790,7 +788,7 @@ [email protected]/16
 sudo systemctl stop bitcoind
 ```
 
-* Delete&#x20;
+* Delete
 
 ```bash
 sudo rm /data/bitcoin/onion_v3_private_key && 
@@ -848,7 +846,7 @@ man bitcoin-cli
 
 ### Generate a full bitcoin.conf example file
 
-* Follow the [Installation progress before](bitcoin-client.md#installation)&#x20;
+* Follow the [Installation progress before](bitcoin-client.md#installation)
 * With user `admin`, clone the source code from GitHub
 
 ```bash