Umbrel Compose System

Abstract

This is a basic framework for orchestration of the services required to run an Umbrel bitcoin and lightning node.

How to use

Ideally, you should create a user for this and then run it within the root of that user. There are some root privilege needed stuff, however LND doesn't support tor passwords yet so we will need to wait.

Step 1

Ensure you have the latest docker installed, python3 (for docker-compose), and docker-compose (installed from python3 pip).

Ensure that you have the latest tor (currently working with 0.3.5.8), and you are using system default paths.

For the install script, you should also have git installed.

For the configuration script you should also have wget.

These scripts all are able to run as non-interactive sessions.

Step 2

Ensure that your account is permissioned for docker.

Step 3

Run this from your home directory. This clones this repo into your home directory, as well as preserving the existing structure.

# Ideally you should run this in $HOME as the docker-compose presets are in home
# This will not overwrite any other files but you should segment this in its 
# own account
curl "https://raw.githubusercontent.com/getumbrel/umbrel-compose/master/install-box.sh" | sh
# OR wget (if this works better)
wget -qO- "https://raw.githubusercontent.com/getumbrel/umbrel-compose/master/install-box.sh" | sh

Configuring

# If you want to use testnet, otherwise we will use mainnet by default and be #reckless
export TESTNET=true
# testnet mode not supported as config is completely different

# Run this in the $HOME directory
wget -qO- "https://raw.githubusercontent.com/getumbrel/umbrel-compose/master/configure-box.sh" | sh
# or (should be in the $HOME directory after install)
./configure-box.sh

Running

# Build containers in build/ always
docker-compose up -d --build
# verify the containers
docker ps -a

TODO List

Please see the following tasks which are on this list.