Skip to content

Latest commit

 

History

History
143 lines (100 loc) · 5.02 KB

DOCKER.md

File metadata and controls

143 lines (100 loc) · 5.02 KB
Raw

Docker Instructions

There are two flavors of Dockerfiles available:

  • Dockerfile: Used for production builds. Checks out the source code from GitHub during build. The build argument --build-arg checkout=v0.x.x-beta can be used to specify what git tag or commit to check out before building.
  • dev.Dockerfile Used for development or testing builds. Uses the local code when building and allows local changes to be tested more easily.

Development/testing

To build a standalone development image from the local source directory, use the following command:

$  docker build --tag=myrepository/lnd-dev -f dev.Dockerfile .

There is also a docker-compose setup available for development or testing that spins up a btcd backend alongside lnd. Check out the documentation at docker/README.md to learn more about how to use that setup to create a small local Lightning Network.

Production (manual build)

To use Docker in a production environment, you can run lnd by creating a Docker container, adding the appropriate command-line options as parameters.

You first need to build the lnd docker image:

$  docker build --tag=myrepository/lnd --build-arg checkout=v0.14.1-beta .

It is recommended that you checkout the latest released tag.

You can continue by creating and running the container:

$  docker run myrepository/lnd [command-line options]

Production (official images)

Starting with lnd v0.12.0-beta, there are official, automatically built docker images of lnd available in the lightninglabs/lnd repository on Docker Hub.

You can just pull those images by specifying a release tag:

$  docker pull lightninglabs/lnd:v0.14.1-beta
$  docker run lightninglabs/lnd [command-line options]

Note that daily-* tags are unstable and not for production use. They are only suitable for development and pre-release testing.

Verifying docker images

To verify the lnd and lncli binaries inside the docker images against the signed, reproducible release binaries, there is a verification script in the image that can be called (before starting the container for example):

$  docker run --rm --entrypoint="" lightninglabs/lnd:v0.14.1-beta /verify-install.sh v0.14.1-beta
$  OK=$?
$  if [ "$OK" -ne "0" ]; then echo "Verification failed!"; exit 1; done
$  docker run lightninglabs/lnd:v0.14.1-beta [command-line options]

Volumes

A Docker volume will be created with your .lnd directory automatically, and will persist through container restarts.

You can also optionally manually specify a local folder to be used as a volume:

$  docker create --name=mylndcontainer -v /media/lnd-docker/:/root/.lnd myrepository/lnd [command-line options]

Example

Here is an example testnet lnd that uses Neutrino:

$  docker run --name lnd-testnet myrepository/lnd --bitcoin.active --bitcoin.testnet --bitcoin.node=neutrino --neutrino.connect=faucet.lightning.community

Create a wallet (and write down the seed):

$  docker exec -it lnd-testnet lncli create

Confirm lnd has begun to synchronize:

$  docker logs lnd-testnet
[snipped]
2018-05-01 02:28:01.201 [INF] RPCS: RPC server listening on 127.0.0.1:10009
2018-05-01 02:28:01.201 [INF] LTND: Waiting for chain backend to finish sync, start_height=2546
2018-05-01 02:28:01.201 [INF] RPCS: gRPC proxy started at 127.0.0.1:8080
2018-05-01 02:28:08.999 [INF] LNWL: Caught up to height 10000
2018-05-01 02:28:09.872 [INF] BTCN: Processed 10547 blocks in the last 10.23s (height 10547, 2012-05-28 05:02:32 +0000 UTC)

This is a simple example, it is possible to use any command-line options necessary to expose RPC ports, use btcd or bitcoind, or add additional chains.

LND Development and Testing

To test the Docker production image locally, run the following from the project root:

$  docker build . -t myrepository/lnd:master

To choose a specific branch or tag instead, use the checkout build-arg. For example, to build the latest tagged commit:

$  docker build . --build-arg checkout=v0.14.1-beta -t myrepository/lnd:v0.14.1-beta

To build the image using the most current tag:

$  docker build . --build-arg checkout=$(git describe --tags `git rev-list --tags --max-count=1`) -t myrepository/lnd:latest-tag

You can also specify a different repo than the default (https://github.com/lightningnetwork/lnd) using the git_url build-arg:

$  docker build . --build-arg git_url=https://git.example.com/lnd.git --build-arg checkout=mybranch -t myrepository/lnd:v0.13.0-beta

Once the image has been built and tagged locally, start the container:

$  docker run --name=lnd-testnet -it myrepository/lnd:latest-tag --bitcoin.active --bitcoin.testnet --bitcoin.node=neutrino --neutrino.connect=faucet.lightning.community