Skip to content

BoostCLI Dockerized: A ssimple container for running and accessing BoostCLI over SSH. Includes Docker and Podman configurations.

License

Notifications You must be signed in to change notification settings

guiand888/BoostCLI-container

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

7 Commits
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

BoostCLI Docker Container

This project is a Docker container configuration for running BoostCLI, a Python CLI program to send Boosts oer Lightning. This container also includes a secure SSH server for remote access. The project uses Docker for containerization.

Thanks to BoostCLI by valcanobacon for creating such a helpful tool!

Requirements

  • Docker or Podman
  • docker-compose or podman-compose (for using with compose files)
  • An SSH key

How to Use

First, clone this repository:

git clone https://github.com/guiand888/BoostCLI-container
cd BoostCLI-container

Next, copy your SSH public key to the config.env file and set the other variables as necessary. You also need to set the path for your lnd cert and macaroon. IF using Umbrel, this should be under:

app-data/lightning/data/lnd/tls.cert
app-data/lightning/data/lnd/data/chain/bitcoin/mainnet/readonly.macaroon

Run the build script:

chmod +x build-docker.sh
./build.sh

You can then run the container using docker compose:

docker compose up --build

To run the BoostCLI command directly from the client, you can SSH into the container using the following command:

ssh -p <host SSH port> <user>@<container IP or hostname> boostcli

Remember to replace <host SSH port>, <user>, and <container IP or hostname> with your actual host's SSH port, the username you have chosen, and the IP or hostname of your container. After logging in, you can execute the BoostCLI command as needed.

About

BoostCLI Dockerized: A ssimple container for running and accessing BoostCLI over SSH. Includes Docker and Podman configurations.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published