Skip to content

Latest commit

 

History

History
executable file
·
95 lines (63 loc) · 3.6 KB

README.md

File metadata and controls

executable file
·
95 lines (63 loc) · 3.6 KB

Docker-Regen

Dockerized Regen Node


MicroBadger Version CircleCI (all branches) Docker Pulls

MicroBadger Layers (latest) MicroBadger Image-Size (latest)

Codacy grade


Prerequisites

  • Docker
  • Docker-Compose (optional)

Quick Start

The image can be run without any configuration and defaults to the regen-1

docker run --rm -d -p 1317:1317/tcp -p 26656:26656/tcp -p 26657:26657/tcp -p 26658:26658/tcp ryanhendricks/docker-regen:latest

Configuration

Config.toml Parameters

  • The config.toml is created dynamically when starting the container.
  • All parameters specified in the standard config.toml file can be set using environmental variables with the same as the config parameter but in all caps.
  • If left unset the default values will be used.
  • Parameters can be set directly by modifying the config.toml portion of ./scripts/entrypoint.sh if you are cloning and building the image yourself.

Environment Variables

You can set the following env variables either in a docker-compose file or in the docker run command if running the container directly. If left unchanged they will default to the values listed below.

  • MONIKER
    • defaults to "nonamenode"
  • CHAIN_ID
    • defaults to regen-1
  • GENESIS_URL
# Example ENV variable from config.toml
MONIKER=regen-node
# The following variables (and their defaults) are set in the container creation entrypoint script and not set in config.toml:
CHAIN_ID=regen-1
GENESIS_URL=https://raw.githubusercontent.com/regen-network/mainnet/main/regen-1/genesis.json

Build

The following command will build the image.

docker build --rm -f Dockerfile -t docker-regen:latest .

Supervisor

The image uses Supervisor to start regen at container runtime. Supervisor also restarts either process should it fail for some reason.

Additional Info

After starting the container you can check the status here: http://0.0.0.0:26657/status.

or from the terminal

# Node
curl -X GET \
  http://0.0.0.0:26657/status? \
  -H 'cache-control: no-cache'

Contributing

PRs Welcome

Contributors

Keybase PGP