A dockerized Bitcoin + LND + BTCPay node

Something like Umbrel but lighter and portable. Something like RaspiBolt but easier and automated. Bitcoin/Lightning-Network oriented with no frills.

Awning doesn't install anything on your PC, making it lightweight, customizable and portable. It is a plain/vanilla Docker setup. No script is ever run in your host.

Run your BTC/LN node in 6 steps:

Clone this repository
Create a Github repository for storing the LND Static Channel Backups (SCB)
Edit and customize the .env file
Start the Docker containers
Authorize SCB to be uploaded on Github
Create o restore a LND wallet

You can also add your BTCPay Server eventually.

Prerequisites

git
docker
docker-compose (or docker compose plugin)

$ sudo apt-get install -y docker.io docker-compose git

Please follow this guide if you don't want to preface the docker and the docker-compose commands with sudo. In this guide sudo will be always omitted.

Before you begin

Clone or download this repository and enter the project directory.

$ git clone https://github.com/giovantenne/awning.git
$ cd awning

LND channel backups preparation

The Static Channels Backup (SCB) is a feature of LND that allows for the on-chain recovery of lightning channel balances in the case of a bricked node. Despite its name, it does not allow the recovery of your LN channels but increases the chance that you'll recover all (or most) of your off-chain (local) balances.

Awning will automatically upload a copy of your channel.backup every time it changes on a Github repository you own, so you will need to create one and provide upload credential (see here)

Create a GitHub repository

Go to GitHub, sign up for a new user account, or log in with an existing one.
Create a new repository: https://github.com/new
- Choose a repository name (eg. remote-lnd-backup)
- Select "Private" (rather than the default "Public")
- Click on "Create repository"
- Annotate your SSH repository address. You will need this later.

Edit and understand the .env file

The .env file contains some Awning setup parameters that you can/need to customize:

Parameter	Description
`BITCOIN_ARCH`	Here you need to choose your computer CPU architecture. Write `aarch64` for ARM (Raspberry Pi, etc) or `x86_64` for Intel or AMD.
`LND_ARCH`	Write `arm64` for ARM (Raspberry Pi, etc) or `amd64` for Intel or AMD.
`RTL_PASSWORD`	Choose the password for accessing the "Ride The Lightning" web interface. You can change it any time but don't forget to restart the RTL container afterwards with `docker-compose restart rtl`.
`LND_PASSWORD`	Choose the password to automatically protected and unlock the LND wallet (write `moneyprintergobrrr` if you are migrating from Umbrel). You will need to use this password again here. Changing this after the first setup will have no effect.
`SCB_REPO`	Paste here the address of your new created Github repository. It should be something like `[email protected]:giovantenne/remote-lnd-backup.git`.
`UID`	The uid (user id) of your current user. Use this command to retrieve it: `id -u`.
`GID`	The gid (group id) of your current user. Use this command to retrieve it: `id -g`.

How to begin

Run the following command:

$ docker-compose up -d

This will spin-up the following services/containers in background:

Bitcoin Core
Electrs
LND
RTL (Ride The Lightning)
TOR
Nginx (used as reverse-proxy)
SCB (Automatic static channel backups)

The first time it will take some time to build all the images from scratch (especially compiling the Electrs binary can take up to one hour).

After all the images are built, “bitcoind” should start, begin to sync and validate the Bitcoin blockchain. If you already downloaded the blockchain somewhere else, you can just copy the data to the ./data/bitcoin directory.

Check the status of the bitcoin daemon that was started with the following command. Exit with Ctrl-C

$ docker logs -f bitcoin

Those services open the following TCP ports on your host:

Parameter	Service	Description
`50002`	Electrs	Electrs with SSL
`8080`	LND	Rest API for LND with SSL
`8081`	RTL	RTL web interface with SSL
`8082`	RTL	RTL web interface without SSL
`8083`	BTCPay Server (optional)	BTCPay server web interface with SSL
`8084`	BTCPay Server (optional)	BTCPay server web interface without SSL

Finish the setup

Once you first start the containers there is still a couple of steps to complete:

Authorize SCB to be uploaded on Github

Run this command:

$ docker logs scb 2> /dev/null | grep -o 'ssh-rsa.*' | head -1

Go back to the GitHub repository webpage
Click on "Settings", then "Deploy keys", then "Add deploy key"
Type a title (e.g., "SCB")
In the "Key" box, copy/paste the string generated above starting (e.g. ssh-rsa 5678efgh... scb@28ba58e278da)
Tick the box "Allow write access" to enable this key to push changes to the repository
Click "Add key"

Create or restore the LND wallet

If you are migrating from Umbrel or from an existing LND node just copy your data to the ./data/lnd directory and skip the rest of this step, otherwise run this command:

$ docker exec -it lnd lncli create

Enter your password as wallet password (it must be exactly the same you stored in .env as LND_PASSWORD).

To create a a new wallet, select n when asked if you have an existing cipher seed. Just press enter if asked about an additional seed passphrase, unless you know what you’re doing. A new cipher seed consisting of 24 words is created.

These 24 words is all that you need to restore the Bitcoin on-chain wallet. The current state of your channels, however, cannot be recreated from this seed.

🚨 This information must be kept secret at all times.

Write these 24 words down manually on a piece of paper and store it in a safe place.

Accessing RTL web interface

Ride The Lightining is accessible on both http and https with a self signed SSL certificate (so expect a warning message from your browser) using the password choosen on the .env file.

If you are running Awning on your PC you can access the web interface through these URLs:

Replace localhost with the IP of your node if you are runnin Awning on a different PC.

Useful comands

Command	Description
`docker ps`	Lists the containers that are running on your host
`docker logs -f bitcoin`	Stream the logs for the bitcoin/lnd/electrs container
`docker exec -it lnd bash`	Connect to the lnd container so that you can use the `lncli` command (eg. `lncli getinfo`)
`docker-compose restart bitcoin`	Restart the bitcoin/lnd/electrs container
`docker-compose build --no-cache`	Rebuild all the containers from scratch
`docker-compose down`	Stop all the containers
`docker-compose up -d`	Start all the containers

Directories structure

├── configs
│   ├── bitcoin.conf
│   ├── electrs.toml
│   ├── lnd.conf
│   ├── nginx-reverse-proxy.conf
│   ├── rtl.json
│   └── torrc
├── data
│   ├── bitcoin
│   ├── btcpay
│   ├── electrs
│   ├── lnd
│   ├── nbx
│   ├── postgres
│   ├── rtl
│   ├── scb
│   └── tor
├── docker-compose.yml
├── Dockerfiles
│   ├── Dockerfile.bitcoin
│   ├── Dockerfile.electrs
│   ├── Dockerfile.lnd
│   ├── Dockerfile.nbx
│   ├── Dockerfile.nginx
│   ├── Dockerfile.rtl
│   ├── Dockerfile.scb
│   ├── Dockerfile.tor
│   ├── entrypoints
│   │   ├── lnd.sh
│   │   └── scb.sh
│   └── files
│       └── nginx.conf
├── LICENSE
└── README.md

Directory	Description
`configs`	Here you can find all the configuration files. Feel free to edit them as you like, but please be carefull to not mess-up with authentication method: Awning currently uses cookies authentication between services instead of RPC.
`data`	Here is where the data are persisted. The Bitcoin Blockchain, the Electrs indexes, the LND channels, etc. are all stored here.
`Dockerfiles`	Here you can find and inspect all the files used to build the images. Don't trust, verify!

BTCPAY Server (optional)

You can easily run your own self-hosted instance of BTCPay Server with Awning with just a few slight modification to a couple of files provided with this reposiroty:

File	Modification
`docker-compose.yml`	Replace the `depends_on` directive under the `nginx` section with the one provided. Uncomment the `ports` 8083 and 8084 under the `nginx` section. Uncomment the `btcpay`, `nbx` and `postgres` services blocks.
`configs/nginx-reverse-proxy.conf`	Uncomment the `upstream` btcpay and 8083, 8084 `server` blocks.

Run docker-compose down and then docker-compose up -d again.

BTCPay server will run 3 additionals containers (requred files and directories are already present on this repository):

Donations/Project contributions

If you would like to contribute and help dev team with this project you can send a donation to the following LN address ⚡[email protected]⚡ or on-chain bc1qg2t8vnahzv5yy7e885l0a59ggagne9nxdvts4t

Enjoy!

darkneedle / awning Goto Github PK

awning's Introduction