You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

49 lines
1.5 KiB

5 years ago
# The Box Compose System
## Abstract
This is a basic framework for orchestration of the box services for running a full lightning and bitcoin node.
## How to use
### Step 1
Ensure you have the [latest docker](https://docs.docker.com/install/linux/docker-ce/ubuntu/) installed, python3, and docker-compose (installed from python3 pip).
5 years ago
Ensure that you have the latest tor (currently working with 0.3.5.8), and you are using system default paths.
### 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.
```bash
# 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/lncm/thebox-compose-system/master/install-box.sh" | sh
5 years ago
# OR wget (if this works better)
wget -qO- "https://raw.githubusercontent.com/lncm/thebox-compose-system/master/install-box.sh" | sh
```
### Running
```bash
# Build containers in build/ always
docker-compose up -d --build
# verify the containers
docker ps -a
# Additional node: You should have a way of creating a wallet. Currently this container does not have a create wallet container.
# For the unlock script to work, put the unlock password in secrets/lnd-password.txt
```
5 years ago
5 years ago
## TODO List
5 years ago
5 years ago
Please see the [following tasks](https://github.com/lncm/thebox-compose-system/issues?q=is%3Aissue+is%3Aopen+label%3ATODO) which are on this list.