https://github.com/mu373/docker-lnd
Run LND with bitcoind running in a separate Docker container
https://github.com/mu373/docker-lnd
bitcoin docker lightning-network lnd
Last synced: 8 months ago
JSON representation
Run LND with bitcoind running in a separate Docker container
- Host: GitHub
- URL: https://github.com/mu373/docker-lnd
- Owner: mu373
- License: mit
- Created: 2023-11-24T10:31:39.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2023-11-24T12:27:59.000Z (almost 2 years ago)
- Last Synced: 2023-11-27T13:45:28.428Z (almost 2 years ago)
- Topics: bitcoin, docker, lightning-network, lnd
- Language: Shell
- Homepage:
- Size: 13.7 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# docker-lnd
Run [LND](https://github.com/lightningnetwork/lnd) independently as a container on Docker.
- We use a custom LND image that has tor preinstalled alongside the base image from [lightninglabs/lnd](https://hub.docker.com/r/lightninglabs/lnd/tags).
- See [Dockerfile](https://github.com/mu373/docker-lnd/blob/main/Dockerfile) for details.
## Prerequisites
- `bitcoind` running on a separate container
- Use [mu373/docker-bitcoind](https://github.com/mu373/docker-bitcoind)
- Container name: `bitcoind` (we access RPC using this hostname)
- Docker network: `bitcoin-nw`
- [traefik proxy](https://doc.traefik.io/traefik/) running on a separate container
- Use [mu373/traefik](https://github.com/mu373/traefik)
- Docker network: `traefik-nw`
## Setup
Prepare configuration for `lnd`
```sh
cp docker-compose-template.yml docker-compose.yml
cp lnd/lnd.sample.conf lnd/lnd.conf
vim lnd/lnd.conf # Edit the configuration to fit your needs
# If you want to customize tor configs
cp torrc.d/custom-config torrc.d/my-custom-config
vim torrc.d/my-custom-config
```
Start the container
```sh
docker compose up -d
```
Access the shell inside the container
```sh
# In host
docker ps # Check container id
docker exec -it container_id bash
# In the container
$ lncli getinfo
$ lncli create
$ lncli unlock
```
See logs
```sh
docker logs --tail 100 container_id
```
## Accessing the node
- When the traefik is properly setup, you can access the LND REST API at `https://yourlndnode.example.com` at port 443.
- Some practical hints
- Setup [Tailscale](https://tailscale.com/) in the host machine
- Create `A` and `AAAA` record at `yourserver.example.com`, pointing to the host Tailscale IP
- Create `CNAME` record at `yourlndnode.example.com`, pointing to `yourserver.example.com`
- Tweak traefik proxy configs in `docker-compose.yml`
- This way, you don't have to configure https and certificates within the LND container yourself. Traefik works as a reverse proxy and does all the complicated stuffs for you.
## References
- Options for `lnd.conf` is listed [here](https://github.com/lightningnetwork/lnd/blob/master/sample-lnd.conf).
- `start-lnd.sh` comes from the [original repository](https://github.com/lightningnetwork/lnd/blob/master/docker/lnd/start-lnd.sh).
- Basic commands for `lncli`: [(link)](https://github.com/nayutaco/lightning-memo/blob/master/lnd.md#lncli)
## License
[MIT](https://github.com/mu373/docker-lnd/blob/main/LICENSE)