Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[NEW BONUS GUIDE + REESTRUCTURE] PostgreSQL + other related #93

Merged
merged 17 commits into from
Jun 5, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Binary file added .gitbook/assets/PostgreSQL-Logo-white.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added .gitbook/assets/bonus-logo.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added .gitbook/assets/core_logo.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added .gitbook/assets/golang.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
49 changes: 17 additions & 32 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ Build your own "do-everything-yourself" Bitcoin full node on a personal computer

No need to trust anyone else. Don't trust, verify!

### What is the MiniBolt?
## What is the MiniBolt?

With this guide, you can set up a Bitcoin and Lightning node on a personal computer from scratch, doing everything yourself. You will learn about Linux, Bitcoin, and Lightning. As a result, you'll have your very own Bitcoin node, built by you and no one else.

Expand All @@ -28,11 +28,11 @@ There are many reasons why you should run your own Bitcoin node:

⚡️ **Be part of Lightning.** Run your Lightning node for everyday payments and help build a robust, decentralized Bitcoin Lightning network.

### MiniBolt overview
## MiniBolt overview

This guide explains how to set up your own Bitcoin node on a Personal Computer. But it works on most hardware platforms because it only uses standard Debian Linux commands.

#### Features
### Features

Your Bitcoin node will offer the following functionality:

Expand All @@ -48,52 +48,37 @@ Your Bitcoin node will offer the following functionality:

🌐 **Reachable from anywhere**: connect to all your services through the Tor network and Wireguard VPN

#### Target audience
### Target audience

We strive to give foolproof instructions. But the goal is also to do everything ourselves.
* [x] We strive to give foolproof instructions. But the goal is also to do everything ourselves.
* [x] Shortcuts that involve trusting someone else are not allowed. This makes this guide quite technical, but we try to make it as straightforward as possible.
* [x] You'll gain a basic understanding of the how and why.
* [x] If you like to learn about Linux, Bitcoin, and Lightning, then this guide is for you.

Shortcuts that involve trusting someone else are not allowed. This makes this guide quite technical, but we try to make it as straightforward as possible.

You'll gain a basic understanding of the how and why.

If you like to learn about Linux, Bitcoin, and Lightning, then this guide is for you.

#### Structure
### Structure

We aim to keep the core of this guide well-maintained and up-to-date:

1. [System](system/): prepare the hardware and set up the operating system
2. [Bitcoin](bitcoin/): sync your own Bitcoin full node, Electrum server, Blockchain Explorer, and connect a desktop wallet to the Electrum server
3. [Lightning](lightning/): run your Lightning client with web-based node management, connect a mobile app, and save safely your SCB backup

➕ Bonus guides: the bonus section contains more specific guides that build on top of the main section. More fun, lots of knowledge, but with lesser maintenance guarantees. Everything is optional.
<table data-view="cards" data-full-width="false"><thead><tr><th></th><th align="center"></th><th align="center"></th><th data-type="content-ref"></th><th data-type="content-ref"></th><th data-type="content-ref"></th><th data-hidden data-card-target data-type="content-ref"></th><th data-hidden data-card-cover data-type="files"></th></tr></thead><tbody><tr><td><ol><li><a href="system/">System</a> <strong>🖥️</strong></li></ol></td><td align="center">Prepare the hardware and set up the operating system</td><td align="center"></td><td><a href="index-1/preparations.md">preparations.md</a></td><td><a href="index-1/operating-system.md">operating-system.md</a></td><td><a href="index-1/remote-access.md">remote-access.md</a></td><td><a href="system/">system</a></td><td><a href=".gitbook/assets/operating-system.gif">operating-system.gif</a></td></tr><tr><td><ol start="2"><li><a href="bonus/bitcoin/"><strong>₿</strong></a><a href="bonus/bitcoin/"><strong>itcoin</strong></a> <strong>🟠</strong></li></ol></td><td align="center">Sync your own Bitcoin full node, Electrum server, Blockchain Explorer, and connect a desktop wallet to the Electrum server</td><td align="center"></td><td><a href="itcoin/bitcoin/bitcoin-client.md">bitcoin-client.md</a></td><td><a href="itcoin/bitcoin/electrum-server.md">electrum-server.md</a></td><td><a href="itcoin/bitcoin/blockchain-explorer.md">blockchain-explorer.md</a></td><td><a href="itcoin/bitcoin/">bitcoin</a></td><td><a href=".gitbook/assets/core_logo.png">core_logo.png</a></td></tr><tr><td><ol start="3"><li><a href="lightning/">Lightning</a> <strong>⚡</strong></li></ol></td><td align="center">Run your Lightning client with web-based node management, connect a mobile app, and save safely your SCB backup</td><td align="center"></td><td><a href="lightning/lightning-client.md">lightning-client.md</a></td><td><a href="lightning/channel-backup.md">channel-backup.md</a></td><td><a href="lightning/web-app.md">web-app.md</a></td><td><a href="lightning/">lightning</a></td><td><a href="images/lightning-network-daemon-logo.png">lightning-network-daemon-logo.png</a></td></tr><tr><td><br><strong>➕</strong> <a href="broken-reference"><strong>Bonus guides</strong></a><br></td><td align="center">The bonus section contains more specific guides that build on top of the main section. More fun, lots of knowledge, but with lesser maintenance guarantees. Everything is optional.</td><td align="center"></td><td></td><td><a href="bonus/system/">system</a></td><td><a href="bonus/bitcoin/">bitcoin</a></td><td><a href="broken-reference">Broken link</a></td><td><a href=".gitbook/assets/bonus-logo.png">bonus-logo.png</a></td></tr></tbody></table>

### How to build
## How to build

* **YouTube list** building MiniBolt in live with [Alberto](https://twitter.com/Albercoin) of Laboratorio Virtual Bitcoin (Spanish)

{% embed url="https://youtube.com/playlist?list=PL7-Q40ihLbmP9vXZGdQgEozQnFISzT8ms" %}

### Community
## Community

* [GitHub Pull Requests](https://github.com/minibolt-guide/minibolt/pulls)
* [GitHub Issues / Knowledge Base](https://github.com/minibolt-guide/minibolt/issues)
* [GitHub discussions](https://github.com/orgs/minibolt-guide/discussions)
* Reddit sub: [r/minibolt](https://www.reddit.com/r/minibolt/)
* Telegram Groups:
* [English](https://t.me/minibolt)
* [Spanish](https://t.me/minibolt\_es)
* Nostr channels:
* [English](https://www.nostrchat.io/channel/aa64f2ead929ce8417f85bde7d22ebde13cc01ceb4e00145572437eb1ad46249)
* [Spanish](https://www.nostrchat.io/channel/3bd633eaad12242572bfc5ba10d3e52b2c0e152f4207383858993c373d314015)
<table data-card-size="large" data-view="cards" data-full-width="false"><thead><tr><th align="center"></th><th></th><th></th></tr></thead><tbody><tr><td align="center"><strong>🛠️</strong> <a href="https://github.com/minibolt-guide/minibolt"><strong>GitHub</strong></a> <strong>🛠️</strong></td><td></td><td><ul><li><a href="https://github.com/minibolt-guide/minibolt/pulls">Pull requests</a></li><li><a href="https://github.com/minibolt-guide/minibolt/issues">Issues / Knowledge base</a></li><li><a href="https://github.com/orgs/minibolt-guide/discussions">Discussions</a></li></ul></td></tr><tr><td align="center"><strong>👥 RRSS 👥</strong></td><td></td><td><ul><li>Reddit sub: <a href="https://www.reddit.com/r/minibolt/">r/minibolt</a></li><li><a href="https://satellite.earth/n/MiniBolt/npub1k9luehc8hg3c0upckdzzvusv66x3zt0eyw7290kclrpsndepz92sfcpp63">Nostr community</a></li><li><p>Telegram Groups:</p><ul><li><a href="https://t.me/minibolt">English</a></li><li><a href="https://t.me/minibolt_es">Spanish</a></li></ul></li><li><p>Nostr channels:</p><ul><li><a href="https://www.nostrchat.io/channel/aa64f2ead929ce8417f85bde7d22ebde13cc01ceb4e00145572437eb1ad46249">English</a></li><li><a href="https://www.nostrchat.io/channel/3bd633eaad12242572bfc5ba10d3e52b2c0e152f4207383858993c373d314015">Spanish</a></li></ul></li></ul></td></tr></tbody></table>

\
Feel free to join the many other contributors if you see something that can be improved!

### Rating
## Rating

All guides are rated with labels to help you assess the difficulty of each guide, and if it is tested against the most recent version of the main guide.

* Difficulty: indicates how difficult the bonus guide is in terms of installation procedure or usage.
* **Difficulty:** indicates how difficult the bonus guide is in terms of installation procedure or usage

{% hint style="success" %}
Difficulty: Easy
Expand All @@ -107,7 +92,7 @@ Difficulty: Medium
Difficulty: Hard
{% endhint %}

* Paid service: indicates if the service used in the guide is free or paid.
* **Paid service:** indicates if the service used in the guide is free or paid

{% hint style="warning" %}
Cost: Paid service
Expand Down
24 changes: 13 additions & 11 deletions SUMMARY.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@

* [MiniBolt](README.md)

## System
## 🖥️ System

* [1. System](system/README.md)
* [1.1 Preparations](index-1/preparations.md)
Expand All @@ -14,37 +14,39 @@
* [1.5 Security](index-1/security.md)
* [1.6 Privacy](index-1/privacy.md)

## Bitcoin
## 🟠 ₿itcoin

* [2. Bitcoin](bitcoin/README.md)
* [2.1 Bitcoin client: Bitcoin Core](index-2/bitcoin-client.md)
* [2.2 Electrum Server: Fulcrum](bitcoin/electrum-server.md)
* [2.3 Blockchain explorer: BTC RPC Explorer](bitcoin/blockchain-explorer.md)
* [2.4 Desktop wallet: Sparrow wallet](bitcoin/desktop-wallet.md)
* [2. ₿itcoin](itcoin/bitcoin/README.md)
* [2.1 Bitcoin client: Bitcoin Core](itcoin/bitcoin/bitcoin-client.md)
* [2.2 Electrum Server: Fulcrum](itcoin/bitcoin/electrum-server.md)
* [2.3 Blockchain explorer: BTC RPC Explorer](itcoin/bitcoin/blockchain-explorer.md)
* [2.4 Desktop wallet: Sparrow wallet](itcoin/bitcoin/desktop-wallet.md)

## Lightning
## Lightning

* [3. Lightning](lightning/README.md)
* [3.1 Lightning client: LND](lightning/lightning-client.md)
* [3.2 Channel backup for LND](lightning/channel-backup.md)
* [3.3 Web app: ThunderHub](lightning/web-app.md)
* [3.4 Mobile app: Zeus](lightning/mobile-app.md)

## Bonus guides
## Bonus guides

* [System](bonus/system/README.md)
* [🖥️ System](bonus/system/README.md)
* [Pimp the command line](bonus/system/command-line.md)
* [Aliases](bonus/system/aliases.md)
* [Static IP & custom DNS servers](bonus-guides/system/static-ip-and-custom-dns-servers.md)
* [Node + NPM](bonus/system/nodejs-npm.md)
* [Rustup + Cargo](bonus-guides/system/rustup-+-cargo.md)
* [Go!](bonus-guides/system/go.md)
* [PostgreSQL](bonus-guides/system/postgresql.md)
* [Login with SSH keys](bonus/system/ssh-keys.md)
* [WireGuard: a simple yet fast VPN](bonus/system/wireguard-vpn.md)
* [Cloudflare tunnel](bonus-guides/system/cloudflare-tunnel.md)
* [Tor obfs4 bridge](index-4/index/tor-bridge.md)
* [NYM mixnet](bonus-guides/system/nym-mixnet.md)
* [Store data in a secondary disk](bonus/system/store-data-secondary-disk.md)
* [Bitcoin](bonus/bitcoin/README.md)
* [🟠 ₿itcoin](bonus/bitcoin/README.md)
* [Electrs](bonus/bitcoin/electrs.md)
* [Electrum Wallet Desktop](bonus/bitcoin/electrum-wallet-desktop.md)
* [Sparrow Server](bonus/bitcoin/sparrow-server.md)
Expand Down
26 changes: 0 additions & 26 deletions bitcoin/README.md

This file was deleted.

Loading