status-im
/
nimbus-eth2
mirror of https://github.com/status-im/nimbus-eth2.git
2
0
Fork 0
Code Issues Projects Releases Wiki Activity
nimbus-eth2/docs/the_nimbus_book/src/docker.md

39 lines
2.1 KiB
Markdown
Raw Normal View History

CI: build and publish a Docker image for end-users Also disable the log file and log colours for distribution binaries, to avoid duplicate logs.
2021-01-20 18:58:58 +00:00
# Docker images
update docker page
2021-05-19 09:58:48 +00:00
Docker images for end-users are generated and published automatically to [Docker Hub](https://hub.docker.com/r/statusim/nimbus-eth2) from the Nimbus-eth2 CI, by a GitHub action, whenever a new release is tagged in Git.
CI: build and publish a Docker image for end-users Also disable the log file and log colours for distribution binaries, to avoid duplicate logs.
2021-01-20 18:58:58 +00:00
We have version-specific Docker tags (`statusim/nimbus-eth2:amd64-v1.2.3`) and a tag for the latest image (`statusim/nimbus-eth2:amd64-latest`).
update docker page
2021-05-19 09:58:48 +00:00
These images are simply the contents of [release tarballs](./binaries.md) inside a `debian:bullseye-slim` image, running under a user imaginatively named `user`, with UID:GID of 1000:1000.
CI: build and publish a Docker image for end-users Also disable the log file and log colours for distribution binaries, to avoid duplicate logs.
2021-01-20 18:58:58 +00:00
update docker page
2021-05-19 09:58:48 +00:00
The unpacked archive is in `/home/user/nimbus-eth2` which is also the default *WORKDIR*. The default *ENTRYPOINT* is the binary itself: `/home/user/nimbus-eth2/build/nimbus\_beacon\_node`
CI: build and publish a Docker image for end-users Also disable the log file and log colours for distribution binaries, to avoid duplicate logs.
2021-01-20 18:58:58 +00:00
## Usage
update docker page
2021-05-19 09:58:48 +00:00
You need to create an external data directory and mount it as a volume inside the container, with mounting point: `/home/user/nimbus-eth2/build/data`
CI: build and publish a Docker image for end-users Also disable the log file and log colours for distribution binaries, to avoid duplicate logs.
2021-01-20 18:58:58 +00:00
```text
mkdir data
docker run -it --rm -v ${PWD}/data:/home/user/nimbus-eth2/build/data statusim/nimbus-eth2:amd64-latest [nimbus_beacon_node args here]
```
update docker page
2021-05-19 09:58:48 +00:00
### Wrapper script
If you wish, you can choose to use a wrapper script instead:
CI: build and publish a Docker image for end-users Also disable the log file and log colours for distribution binaries, to avoid duplicate logs.
2021-01-20 18:58:58 +00:00
```text
mkdir data
docker run -it --rm -v ${PWD}/data:/home/user/nimbus-eth2/build/data -e WEB3_URL="wss://mainnet.infura.io/ws/v3/YOUR_TOKEN" --entrypoint /home/user/nimbus-eth2/run-mainnet-beacon-node.sh statusim/nimbus-eth2:amd64-latest [nimbus_beacon_node args here]
```
update docker page
2021-05-19 09:58:48 +00:00
### Docker compose
Our preferred setup is using `docker-compose`. You can use one of our [example configuration files](https://github.com/status-im/nimbus-eth2/tree/stable/docker/dist/binaries) as a base for your own custom configuration:
CI: build and publish a Docker image for end-users Also disable the log file and log colours for distribution binaries, to avoid duplicate logs.
2021-01-20 18:58:58 +00:00
```text
mkdir data
docker-compose -f docker-compose-example1.yml up --quiet-pull --no-color --detach
```
update docker page
2021-05-19 09:58:48 +00:00
> **Note:** The rather voluminous logging is done on `stdout`, so you might want to change the system-wide Docker logging defaults (which dumps everything in `/var/lib/docker/containers/CONTAINER_ID/CONTAINER_ID-json.log`) to something like `syslog`. We recommend using a log rotation system with appropriate intervals for logs of this size.
Book edits (#2597) * simplify beacon node quickstart * remove extra emacs generated file * focus sync info around slot start message * sync edits * log rotate edits + clarifications * remove validator keys folder
2021-05-24 14:03:45 +00:00