status-im
/
nim-codex
mirror of https://github.com/status-im/nim-codex.git
2
0
Fork 0
Code Issues Projects Releases Wiki Activity
nim-codex/docker/README.md

1.2 KiB
Raw Blame History

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:

  • 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

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