nim-codex/docker/README.md

2.0 KiB

Codex Docker Image

Build and run using the example docker-compose file: docker-compose up -d

Stop and retain image and volume data: docker-compose down

Stop and delete image and volume data: docker-compose down --rmi all -v rm -R hostdatadir

Environment variables

Codex docker image supports the following environment variables:

  • LISTEN_ADDRS(*)
  • API_BINDADDR(*)
  • DATA_DIR(*)
  • LOG_LEVEL
  • METRICS_ADDR
  • METRICS_PORT
  • NAT_IP
  • API_PORT
  • DISC_IP
  • DISC_PORT
  • NET_PRIVKEY
  • BOOTSTRAP_SPR
  • MAX_PEERS
  • AGENT_STRING
  • STORAGE_QUOTA
  • BLOCK_TTL
  • CACHE_SIZE
  • ETH_PROVIDER
  • ETH_ACCOUNT
  • ETH_DEPLOYMENT
  • SIMULATE_PROOF_FAILURES
  • VALIDATOR
  • PERSISTENCE
  • CODEX_NODENAME(†)

(*) These variables have default values in the docker image that are different from Codex's standard default values.

(†) CODEX_NODENAME is used for logging purposes only in the docker image

All environment variables are optional and will default to Codex's CLI default values.

Constants

Codex CLI arguments 'data-dir', 'listen-addrs', and 'api-bindaddr' cannot be configured. They are set to values required for docker in case of bind addresses. In the case of 'data-dir', the value is set to /datadir. It is important that you map this folder to a host volume in your container configuration. See docker-compose.yaml for examples.

Useful

Connect nodes with the /connect endpoint. To get the IP address of a container within a network: Find container Id: docker ps Open terminal in container: docker exec -it <CONTAINER ID> sh Get IP addresses: ifconfig

Slim

  1. Build the image using docker build -t status-im/codexsetup:latest -f codex.Dockerfile ..
  2. The docker image can then be minifed using slim. Install slim on your path and then run:
slim # brings up interactive prompt
>>> build --target status-im/codexsetup --http-probe-off true
  1. This should output an image with name status-im/codexsetup.slim
  2. We can then bring up the image using docker-compose up -d.