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

51 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
book edits (#3903) * Reorganise menu, putting tabs on top * Use tabs for specific content * cleanups and consistency edits
2022-07-24 20:13:47 +00:00
Docker images are available from [Docker Hub](https://hub.docker.com/r/statusim/nimbus-eth2) .
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
book updates (#3763) * systemd: use same service file as package * systemd: recommend setting up a user * clean up obsolete / ephemeral notes * eth1 -> execution, in many places * clean up docker instructions to match the experience of running the runner script * add basic instructions / links for execution clients other than geth * clear a few more references to JSON-RPC, update to REST * update hardware requirements with execution client extras * start talking about merge requirements (this needs a dedicated page) * note that binaries do exist, where relevant * list gitcoin under donations * update syncing docs * `NOT` is for `NOTICE` in logs * update rpi hardware recommendations * prevent automatic doppelganger restarts in systemd service file
2022-06-17 15:28:13 +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
book edits (#3903) * Reorganise menu, putting tabs on top * Use tabs for specific content * cleanups and consistency edits
2022-07-24 20:13:47 +00:00
Before running Nimbus via docker, you need to prepare a data directory and mount it in docker.
book updates (#3763) * systemd: use same service file as package * systemd: recommend setting up a user * clean up obsolete / ephemeral notes * eth1 -> execution, in many places * clean up docker instructions to match the experience of running the runner script * add basic instructions / links for execution clients other than geth * clear a few more references to JSON-RPC, update to REST * update hardware requirements with execution client extras * start talking about merge requirements (this needs a dedicated page) * note that binaries do exist, where relevant * list gitcoin under donations * update syncing docs * `NOT` is for `NOTICE` in logs * update rpi hardware recommendations * prevent automatic doppelganger restarts in systemd service file
2022-06-17 15:28:13 +00:00
Fix typo in docs/docker.md (#4110)
2022-09-10 16:50:57 +00:00
It is recommended that you mount the directory at `/home/user/nimbus-eth2/build/data` and pass `--data-dir=build/data/shared_mainnet_0` to all `nimbus_beacon_node` commands.
book updates (#3763) * systemd: use same service file as package * systemd: recommend setting up a user * clean up obsolete / ephemeral notes * eth1 -> execution, in many places * clean up docker instructions to match the experience of running the runner script * add basic instructions / links for execution clients other than geth * clear a few more references to JSON-RPC, update to REST * update hardware requirements with execution client extras * start talking about merge requirements (this needs a dedicated page) * note that binaries do exist, where relevant * list gitcoin under donations * update syncing docs * `NOT` is for `NOTICE` in logs * update rpi hardware recommendations * prevent automatic doppelganger restarts in systemd service file
2022-06-17 15:28:13 +00:00
The wrapper script outlined below will set the data directory automatically.
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
book edits (#3903) * Reorganise menu, putting tabs on top * Use tabs for specific content * cleanups and consistency edits
2022-07-24 20:13:47 +00:00
```sh
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
mkdir data
book edits (#3903) * Reorganise menu, putting tabs on top * Use tabs for specific content * cleanups and consistency edits
2022-07-24 20:13:47 +00:00
docker run -it --rm \
-v ${PWD}/data:/home/user/nimbus-eth2/build/data \
statusim/nimbus-eth2:amd64-latest \
--data-dir=build/data/shared_mainnet_0
--network=mainnet [other options]
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
### Wrapper script
book updates (#3763) * systemd: use same service file as package * systemd: recommend setting up a user * clean up obsolete / ephemeral notes * eth1 -> execution, in many places * clean up docker instructions to match the experience of running the runner script * add basic instructions / links for execution clients other than geth * clear a few more references to JSON-RPC, update to REST * update hardware requirements with execution client extras * start talking about merge requirements (this needs a dedicated page) * note that binaries do exist, where relevant * list gitcoin under donations * update syncing docs * `NOT` is for `NOTICE` in logs * update rpi hardware recommendations * prevent automatic doppelganger restarts in systemd service file
2022-06-17 15:28:13 +00:00
update docker page
2021-05-19 09:58:48 +00:00
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
book edits (#3903) * Reorganise menu, putting tabs on top * Use tabs for specific content * cleanups and consistency edits
2022-07-24 20:13:47 +00:00
```sh
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
mkdir data
book edits (#3903) * Reorganise menu, putting tabs on top * Use tabs for specific content * cleanups and consistency edits
2022-07-24 20:13:47 +00:00
docker run -it --rm \
-v ${PWD}/data:/home/user/nimbus-eth2/build/data \
--entrypoint /home/user/nimbus-eth2/run-mainnet-beacon-node.sh \
statusim/nimbus-eth2:amd64-latest [other options]
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
### Docker compose
book updates (#3763) * systemd: use same service file as package * systemd: recommend setting up a user * clean up obsolete / ephemeral notes * eth1 -> execution, in many places * clean up docker instructions to match the experience of running the runner script * add basic instructions / links for execution clients other than geth * clear a few more references to JSON-RPC, update to REST * update hardware requirements with execution client extras * start talking about merge requirements (this needs a dedicated page) * note that binaries do exist, where relevant * list gitcoin under donations * update syncing docs * `NOT` is for `NOTICE` in logs * update rpi hardware recommendations * prevent automatic doppelganger restarts in systemd service file
2022-06-17 15:28:13 +00:00
update docker page
2021-05-19 09:58:48 +00:00
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
book edits (#3903) * Reorganise menu, putting tabs on top * Use tabs for specific content * cleanups and consistency edits
2022-07-24 20:13:47 +00:00
```sh
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
mkdir data
docker-compose -f docker-compose-example1.yml up --quiet-pull --no-color --detach
```
book edits (#3903) * Reorganise menu, putting tabs on top * Use tabs for specific content * cleanups and consistency edits
2022-07-24 20:13:47 +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.