This repository has a
Dockerfile in the root which builds an image with the
lighthouse binary installed. A pre-built image is available on Docker Hub.
There are two ways to obtain the docker image, either via Docker Hub or building the image from source. Once you have obtained the docker image via one of these methods, proceed to Using the Docker image.
Lighthouse maintains the sigp/lighthouse Docker Hub repository which provides an easy way to run Lighthouse without building the image yourself.
Obtain the latest image with:
$ docker pull sigp/lighthouse
Download and test the image with:
$ docker run sigp/lighthouse lighthouse --version
If you can see the latest Lighthouse release version (see example below), then you've successfully installed Lighthouse via Docker.
Lighthouse vx.x.xx-xxxxxxxxx BLS Library: xxxx-xxxxxxx
Note: when you're running the Docker Hub image you're relying upon a pre-built binary instead of building from source.
Note: due to the Docker Hub image being compiled to work on arbitrary machines, it isn't as highly optimized as an image built from source. We're working to improve this, but for now if you want the absolute best performance, please build the image yourself.
To build the image from source, navigate to the root of the repository and run:
$ docker build . -t lighthouse:local
The build will likely take several minutes. Once it's built, test it with:
$ docker run lighthouse:local lighthouse --help
You can run a Docker beacon node with the following command:
$ docker run -p 9000:9000 -p 127.0.0.1:5052:5052 -v $HOME/.lighthouse:/root/.lighthouse sigp/lighthouse lighthouse --network mainnet beacon --http --http-address 0.0.0.0
To join the Pyrmont testnet, use
-vand values are described below.
Lighthouse uses the
/root/.lighthouse directory inside the Docker image to
store the configuration, database and validator keys. Users will generally want
to create a bind-mount volume to ensure this directory persists between
docker run commands.
The following example runs a beacon node with the data directory mapped to the users home directory:
$ docker run -v $HOME/.lighthouse:/root/.lighthouse sigp/lighthouse lighthouse beacon
In order to be a good peer and serve other peers you should expose port
-p flag to do this:
$ docker run -p 9000:9000 sigp/lighthouse lighthouse beacon
If you use the
--http flag you may also want to expose the HTTP port with
$ docker run -p 9000:9000 -p 127.0.0.1:5052:5052 sigp/lighthouse lighthouse beacon --http --http-address 0.0.0.0