.. | ||
rinkeby | ||
seed_node | ||
README.md | ||
startup_script.sh |
S
Dockerfile
will build an alpine image containing:
- vDB as a binary with runtime deps statically linked:
/app/vulcanizedb
- The migration tool goose:
/app/goose
- Two services for running
headerSync
andcontinuousLogSync
, started with the default configurationenvironments/staging.toml
.
By default, vDB is configured towards the Kovan deploy. The configuration values can be overridden using environment variables, using the same hierarchical naming pattern but in CAPS and using underscores. For example, the contract address for the Pit
can be set with the variable CONTRACT_ADDRESS_PIT="0x123..."
.
To use the container:
- Setup a postgres database with superuser
vulcanize
- Set the env variables
DATABASE_NAME
,DATABASE_HOSTNAME
,DATABASE_PORT
,DATABASE_USER
&DATABASE_PASSWORD
- Run the DB migrations:
./goose postgres "postgresql://$(DATABASE_USER):$(DATABASE_PASSWORD)@$(DATABASE_HOSTNAME):$(DATABASE_PORT)/$(DATABASE_NAME)?sslmode=disable" e
- Set
CLIENT_IPCPATH
to a node endpoint - Set the contract variables:
CONTRACT_ADDRESS_[CONTRACT NAME]=0x123...
CONTRACT_ABI_[CONTRACT NAME]="ABI STRING"
CONTRACT_DEPLOYMENT-BLOCK_[CONTRACT NAME]=0
(doesn't really matter on a short chain, just avoids long unnecessary searching)
- Start the
headerSync
andcontinuousLogSync
services:
./vulcanizedb headerSync --config environments/staging.toml
./vulcanizedb continuousLogSync --config environments/staging.toml
Automated
The steps above have been rolled into a script: /app/startup_script.sh
, which just assumes the DB env variables have been set, and defaults the rest to Kovan according to environments/staging.toml
. This can be called with something like:
docker run -d -e DATABASE_NAME=vulcanize_public -e DATABASE_HOSTNAME=localhost -e DATABASE_PORT=5432 -e DATABASE_USER=vulcanize -e DATABASE_PASSWORD=vulcanize m0ar/images:vDB
Logging
When running, vDB services log to /app/vulcanizedb.log
.