Skip to content

Commit

Permalink
Update to v2
Browse files Browse the repository at this point in the history
  • Loading branch information
twofaktor committed Jun 22, 2023
1 parent 837358d commit fc4a86c
Show file tree
Hide file tree
Showing 151 changed files with 15,665 additions and 17,335 deletions.
5 changes: 1 addition & 4 deletions .gitattributes
Original file line number Diff line number Diff line change
@@ -1,4 +1 @@
# Linguist overrides
*.md linguist-detectable=true
README.md linguist-detectable=false
readme.md linguist-detectable=false
*.md linguist-detectable
Binary file added .gitbook/assets/bitcoin-testnet.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/bitcoin_god.jpg
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/configuration.jpg
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/lightning.jpg
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/operating-system.gif
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/preparations.jpg
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/privacy.jpg
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/remote-access.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/security_key.jpg
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/static-ip-dns-gif.gif
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/static-ip-dns.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/system-PC.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
2 changes: 1 addition & 1 deletion .github/ISSUE_TEMPLATE/bug_report.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ A clear and concise description of what the bug is.

### Location in guide

Link to the corresponding page and section on <https://twofaktor.github.io/minibolt/>
Link to the corresponding page and section on <https://minibolt.info>

### Expected behavior

Expand Down
2 changes: 1 addition & 1 deletion .github/ISSUE_TEMPLATE/support.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ A clear and concise description of what the bug is.

### Location in guide

Link to the corresponding page and section on <https://twofaktor.github.io/minibolt/>
Link to the corresponding page and section on <https://minibolt.info>

### Expected behavior

Expand Down
6 changes: 0 additions & 6 deletions .gitignore

This file was deleted.

13 changes: 0 additions & 13 deletions 404.md

This file was deleted.

1 change: 0 additions & 1 deletion CNAME

This file was deleted.

8 changes: 0 additions & 8 deletions Gemfile

This file was deleted.

145 changes: 97 additions & 48 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,81 +1,130 @@
<h1 align="center">MiniBolt</h1>
---
description: >-
Build your own “DIY” Bitcoin & Lightning full node on a personal computer. No
need to trust anyone else.
---

<p align="center">
<a href="https://opensource.org/licenses/MIT" title="License: MIT">
<img src="https://img.shields.io/github/license/twofaktor/minibolt?color=blue">
</a>
<a href="https://github.com/twofaktor/minibolt/releases" title="Lastest release">
<img alt="GitHub release (latest by date)" src="https://img.shields.io/github/v/release/twofaktor/minibolt?label=latest%20release">
</a>
<a href="https://www.reddit.com/r/minibolt/" title="MiniBolt Reddit">
<img alt="Subreddit subscribers" src="https://img.shields.io/reddit/subreddit-subscribers/minibolt?style=social">
</a>
# MiniBolt

<h2 align="center">A complete guide to building a Bitcoin & Lightning full node on a personal computer</h2>
[![](https://img.shields.io/github/license/minibolt-guide/minibolt-gitbook?color=blue) ](LICENSE/)[![GitHub release (latest by date)](https://img.shields.io/github/v/release/minibolt-guide/minibolt?label=latest%20release) ](https://github.com/minibolt-guide/minibolt/releases)[![Subreddit subscribers](https://img.shields.io/reddit/subreddit-subscribers/minibolt?style=social)](https://www.reddit.com/r/minibolt/) ![GitHub contributors](https://img.shields.io/github/contributors/minibolt-guide/minibolt-gitbook) ![GitHub Org's stars](https://img.shields.io/github/stars/minibolt-guide) ![GitHub followers](https://img.shields.io/github/followers/minibolt-guide) ![GitHub forks](https://img.shields.io/github/forks/minibolt-guide/minibolt)

<h4 align="left" style="color:red">⚠️ Attention! This project is a fork under construction, some chapters could not be attached to the reference use case. Pay special attention to the <b>"Status: Not tested MiniBolt"</b> tag at the beginning of the guides. Be careful and act at your own risk.</span>
{% hint style="danger" %}
<mark style="color:red;">**Attention! This project is a fork under construction, some chapters could not be attached to the reference use case. Pay special attention to the "Status: Not tested MiniBolt" tag at the beginning of the guides. Be careful and act at your own risk.**</mark>
{% endhint %}

<p align="center">
<a href="https://twofaktor.github.io/minibolt/">
<img alt="MiniBolt" src="images/minibolt-home-screen.png"/>
</a>
</p>
<figure><img src="images/minibolt-home-screen.png" alt=""><figcaption></figcaption></figure>

---
Build your own "do-everything-yourself" Bitcoin full node on a personal computer, that will make you a sovereign peer in the Bitcoin and Lightning network.

<h3 align="center"> The MiniBolt Guide is available on GitHub Pages
No need to trust anyone else. Don't trust, verify!

https://minibolt.info
### What is the MiniBolt?

</h3>
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.

---
There are many reasons why you should run your own Bitcoin node:

Based on [RaspiBolt guide v3](https://github.com/raspibolt/raspibolt), originally made by Stadicus and now maintained for the community, those are the most relevant changes:
* **Keep Bitcoin decentralized.** Use your node to help enforce your Bitcoin consensus rules.
* **Take back your sovereignty.** Let your node validate your own Bitcoin transactions. No need to ask someone else to tell you what's happening in the Bitcoin network.
* **Improve your privacy.** Connect your wallets to your node so that you no longer need to reveal their whole financial history to external servers.
* **Be part of Lightning.** Run your own Lightning node for everyday payments and help build a robust, decentralized Bitcoin Lightning network.

- Changed OS from Raspberry Pi OS Lite (64-bits) to **Ubuntu Server LTS 64-bit** - PC (AMD64)
- Changed binaries and signatures of the programs to adapt them to **x86/amd64** architecture processors
- Deleted unnecessary tools and steps, and added others according to this case of use
- Added some useful authentication logs monitoring commands in the security section
- Added interesting parameters in the configuration of some services and related commands to activate and take advantage of new features
<div align="center" data-full-width="false">

---
<img src="images/bitcoin-network-small.png" alt="">

### How build
</div>

- YouTube list building MiniBolt in live with Alberto de Laboratorio Virtual Bitcoin (Spanish): [LINK](https://youtube.com/playlist?list=PL7-Q40ihLbmP9vXZGdQgEozQnFISzT8ms)
### 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.

### Roadmap
#### Features

- [ ] Testnet bonus guide
- [ ] BTCpay server bonus guide
- [ ] Mempool bonus guide
- [ ] Cloudflared bonus guide
Your Bitcoin node will offer the following functionality:

[...]
* **Bitcoin**: direct and trustless participation in the Bitcoin peer-to-peer network, full validation of blocks and transactions
* **Electrum server**: connect your compatible wallets (including hardware wallets) to your own node
* **Blockchain Explorer**: web-based Explorer to privately look up transactions, blocks, and more
* **Lightning**: full client with stable long-term channels and web-based and mobile-based management interfaces
* **Always on**: services are constantly synced and available 24/7
* **Reachable from anywhere**: connect to all your services through the Tor network

💡 You can see the extended roadmap by access to the [drawio file](https://github.com/minibolt-guide/extra-resources/blob/main/roadmap.drawio.png)
#### Target audience

---
We strive to give foolproof instructions. But the goal is also to do everything ourselves.

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

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 own Lightning client with web-based node management, connect a mobile app, and save safely your SCB backup

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.

* [Bonus guides](bonus/)

### How build

* YouTube list building MiniBolt in live with Alberto de Laboratorio Virtual Bitcoin (Spanish): [LINK](https://youtube.com/playlist?list=PL7-Q40ihLbmP9vXZGdQgEozQnFISzT8ms)

### Community

* [GitHub Pull Requests](https://github.com/minibolt-guide/minibolt-gitbook/pulls)
* [GitHub Issues / Knowledge Base](https://github.com/minibolt-guide/minibolt-gitbook/issues)
* [GitHub discussions](https://github.com/minibolt-guide/minibolt-gitbook/discussions)
* Reddit sub: [r/minibolt](https://www.reddit.com/r/minibolt/)
* Telegram Groups:
* [Spanish](https://t.me/minibolt_es)
* [Spanish](https://t.me/minibolt\_es)
* [English](https://t.me/minibolt)
* [GitHub discussions](https://github.com/twofaktor/minibolt/discussions)
* [Amboss MiniBolters community](https://amboss.space/es/community/fee5ec65-5b9a-4305-856a-1eb1aff19c34)
* Nostr channels:
* Spanish id: 3bd633eaad12242572bfc5ba10d3e52b2c0e152f4207383858993c373d314015
* English id: aa64f2ead929ce8417f85bde7d22ebde13cc01ceb4e00145572437eb1ad46249

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

Created by [⚡2 FakTor⚡](https://twitter.com/twofaktor) member of the [Bitcoin Barcelona Community](https://bitcoinbarcelona.xyz/)
### 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.

{% hint style="success" %}
Difficulty: Easy
{% endhint %}

{% hint style="warning" %}
Difficulty: Medium
{% endhint %}

{% hint style="danger" %}
Difficulty: Hard
{% endhint %}

* Tested: indicates if the guide has been updated and tested on the MiniBolt. If this is not the case, you might have to modify part of the guide to make it work on MiniBolt.

{% hint style="success" %}
Status: Tested MiniBolt
{% endhint %}

{% hint style="warning" %}
Status: Not tested MiniBolt
{% endhint %}

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

{% hint style="success" %}
Cost: Free service
{% endhint %}

This repository contains all sources and is used for Issue tracking.
{% hint style="warning" %}
Cost: Paid service
{% endhint %}
66 changes: 66 additions & 0 deletions SUMMARY.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,66 @@
# Table of contents

* [MiniBolt](README.md)
* [1. System](system/README.md)
* [1.1 Preparations](system/preparations.md)
* [1.2 Operating system](system/operating-system.md)
* [1.3 Remote access](system/remote-access.md)
* [1.4 Configuration](system/configuration.md)
* [1.5 Security](system/security.md)
* [1.6 Privacy](system/privacy.md)
* [2. Bitcoin](bitcoin/README.md)
* [2.1 Bitcoin client: Bitcoin Core](bitcoin/bitcoin-client.md)
* [2.2 Electrum Server: Fulcrum](bitcoin/electrum-server.md)
* [2.3 Desktop wallet: Sparrow Wallet](bitcoin/desktop-wallet.md)
* [2.4 Blockchain explorer: BTC RPC Explorer](bitcoin/blockchain-explorer.md)
* [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/README.md)
* [System](bonus/system/README.md)
* [System overview](bonus/system/system-overview.md)
* [Pimp the command line](bonus/system/command-line.md)
* [Homer](bonus/system/homer.md)
* [Aliases](bonus/system/aliases.md)
* [Install / Update / Uninstall Go](bonus/system/go.md)
* [Install / Update / Uninstall Node.js + NPM](bonus/system/nodejs-npm.md)
* [Login with SSH keys](bonus/system/ssh-keys.md)
* [Trezor Agent](bonus/system/trezor-agent.md)
* [WireGuard: a simple yet fast VPN](bonus/system/wireguard-vpn.md)
* [Configure NUT to safely shutdown your node](bonus/system/ups-nut.md)
* [Tor Bridge](bonus/system/tor-bridge.md)
* [Store data in a secondary disk](bonus/system/store-data-secondary-disk.md)
* [Bitcoin](bonus/bitcoin/README.md)
* [Electrs](bonus/bitcoin/electrs.md)
* [Electrum Personal Server](bonus/bitcoin/electrum-personal-server.md)
* [BitBoxApp](bonus/bitcoin/bitboxapp.md)
* [Electrum Wallet Desktop](bonus/bitcoin/electrum-wallet-desktop.md)
* [Sparrow Server](bonus/bitcoin/sparrow-server.md)
* [JoinMarket clientserver](bonus/bitcoin/joinmarket.md)
* [Bisq](bonus/bitcoin/bisq.md)
* [Safu Ninja, a DIY steel mnemonic backup](bonus/bitcoin/safu-ninja.md)
* [Ordisrespector spam filter](bonus/bitcoin/ordisrespector.md)
* [Download the bitcoin whitepaper directly from your own blockchain](bonus/bitcoin/white-paper.md)
* [MiniBolt on Testnet](bonus/bitcoin/minibolt-on-testnet.md)
* [Lightning](bonus/lightning/README.md)
* [Core Lightning](bonus/lightning/cln.md)
* [Use lncli on a different computer](bonus/lightning/remote-lncli.md)
* [Circuit Breaker, a lightning 'firewall'](bonus/lightning/circuit-breaker.md)
* [ambossping](bonus/lightning/ambossping.md)
* [LNTOP terminal dashboard](bonus/lightning/lntop.md)
* [lnbalance](bonus/lightning/lnbalance.md)
* [lnchannels](bonus/lightning/lnchannels.md)
* [Zap Desktop](bonus/lightning/zap-desktop.md)
* [Zap iOS Lightning Wallet](bonus/lightning/zap-ios.md)
* [LNBits, a lightning wallet/accounts system](bonus/lightning/lnbits.md)
* [LNDg](bonus/lightning/lndg.md)
* [Ride The Lightning](bonus/lightning/ride-the-lightning.md)
* [Balance of Satoshis](bonus/lightning/balance-of-satoshis.md)
* [Lightning Terminal](bonus/lightning/lightning-terminal.md)
* [rebalance-lnd](bonus/lightning/rebalance-lnd.md)
* [CLBoss](bonus/lightning/clboss.md)
* [regolancer](bonus/lightning/regolancer.md)
* [charge-lnd](bonus/lightning/charge-lnd.md)
* [Tunnel⚡️Sats](bonus/lightning/tunnelsats.md)
41 changes: 0 additions & 41 deletions _config.yml

This file was deleted.

3 changes: 0 additions & 3 deletions _includes/include_metatags.md

This file was deleted.

42 changes: 0 additions & 42 deletions _sass/color_schemes/minibolt-dark.scss

This file was deleted.

Loading

0 comments on commit fc4a86c

Please sign in to comment.