ECEntrics
/
concordia
mirror of https://gitlab.com/ecentrics/concordia
1
0
Fork 0
Code Issues Projects Releases Wiki Activity
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
136 Commits
2 Branches
2 Tags
4.9 MiB
 
 
 
 
 
 
Tree: 084d41e666
Branches Tags
${ item.name }
Create tag ${ searchTerm }
Create branch ${ searchTerm }
from '084d41e666'
${ noResults }
concordia/docker/README.md

7.8 KiB
Raw Blame History

Concordia Dockerized

This page provides information about the provided docker images, their configuration and supported deployment strategies.

TLDR: head down to Putting it all together/Scripts for a quick setup.

Services

Concordia requires at the minimum two services to work, a blockchain and a rendezvous server.

Additionally, the Concordia application code must be provided to the user. Currently, the only way of distributing the application code is via a webserver as a web application.

Ganache

Ganache is a personal blockchain software used during development. It is a very convenient way of developing and testing dApps. More information can be found in the project's website.

Note that any other Ethereum compliant blockchain can be used.

Rendezvous

Concordia uses a distributed database to store forum data. A rendezvous server is needed in order for users to discover peers in the network and get access to the data.

Application

The Concordia application is a React app that handles interactions with the contracts and the distributed database used.

Docker images

This repository provides docker images to easily setup (and destroy) instances of all required services Concordia. Furthermore, we provide an image that builds the contracts and handles their migration to the blockchain in use.

Ganache

The Dockerfile is provided in the path ./docker/ganache. The image makes use of the environment variables described bellow.

Environment variable Default value Usage
ACCOUNTS_NUMBER 10 Set the number of accounts generated
ACCOUNTS_ETHER 10 Set the amount of ETH assigned to each account
MNEMONIC myth like bonus scare over problem client lizard pioneer submit female collect The mnemonic phrase sued as a seed for deterministic account generation
HOST 0.0.0.0 The hostname to listen on
PORT 8545 The port to listen on
NETWORK_ID 5778 The network id used to identify ganache

Note that the Ganache instance running inside the container will save the generated blockchain keys in the path /home/ganache_keys/keys.json. If you need to access the keys (eg for getting a private key and importing in Metamask) you can mount a volume to this path to have easier access.

Also, the database used by Ganache for storing blockchain information is placed in the path /home/ganache_db/. You can maintain the blockchain state between runs by mounting a volume to the database path.

Rendezvous

The rendezvous server used here is js-libp2p-webrtc-star. The server listens on port 9090. More information can be found on the github page of the project here.

Contracts

This is a provision system that compiles and deploys the contracts to any Ethereum blockchain.

A Dockerfile is provided in the path ./docker/concordia-contracts that will build the contracts used by Concordia and handle their deployment to any Ethereum network defined using env-vars upon container run. Dockerfile contains three useful stages, described in the table bellow.

Stage name Entrypoint Usage
compile Exits immediately Compiles the contracts
test Runs contract tests Compiles contracts and runs tests using blockchain defined by env vars
runtime Migrates contracts Compiles contracts and migrates to the blockchain defined by env vars. Does not run tests

The image makes use of the environment variables described bellow.

Environment variable Default value Usage
MIGRATE_NETWORK develop Set the network where the contracts will be deployed/tested (set to env unless you know what you're doing)
DEPLOY_CHAIN_HOST NaN Set the hostname of the blockchain network that will be used for deployment
DEPLOY_CHAIN_PORT NaN Set the port of the blockchain network that will be used for deployment
TEST_CHAIN_HOST NaN Set the hostname of the blockchain network that will be used for testing
TEST_CHAIN_PORT NaN Set the port of the blockchain network that will be used for testing

You can find the contract artifacts in the directory /usr/src/concordia/packages/concordia-contracts/build/ inside the image.

Attention: make sure the targeted blockchain is up and running before trying to migrate the contracts.

Application

The Dockerfile provided in the path ./docker/concordia-application builds the application for production and serves the resulting build using an nginx server. Dockerfile contains two useful stages, described in the table bellow.

Stage name Entrypoint Usage
test Runs tests Fetches npm packages and runs tests
runtime Serves application Builds for production and serves it through nginx

The image makes use of the environment variables described bellow.

Environment variable Default value Usage
REACT_APP_RENDEZVOUS_HOST 127.0.0.1 Set the hostname of the rendezvous server
REACT_APP_RENDEZVOUS_PORT 9090 Set the port of the rendezvous server

Attention: this image will copy the contract artifacts from the directory /packages/concordia-contracts/build. The image is bound the these artifacts after build. If the contracts change or get re-deployed the image must be re-built to use the new artifacts.

Attention: make sure the contracts have been deployed before building this image. Also, make sure the rendezvous server is up and running.

Docker Compose

A docker-compose file also is provided. The docker-compose handles the lifecycle of the Ganache and Rendezvous server containers.

Putting it all together

You can find some ready to use scripts for common scenarios like dev deploys and testing in the ./docker directory. These scripts are documented in the following chapters.

Makefile targets

Concordia uses blockchain and other distributed technologies. There are a number of ways to set up a running instance of this application.

This chapter will guide you through simple setups for testing and production that depend on local blockchain (ganache) instances which do not require real ETH to work or have any other charges.

Testing the contracts

Build the ganache image and spin up a blockchain for testing:

make build-ganache run-ganache-test

Build the testing stage of the contracts image:

make build-contracts-tests

Run the tests:

make run-contract-tests

The results should be printed in the terminal, but are also available in the directory ./reports/contracts.

Testing the application

Build the testing stage of the application image:

make build-app-tests

Run the test:

make run-app-tests

The results should be printed in the terminal, but are also available in the directory ./reports/app.

Production

Build the ganache image and spin up a blockchain and a rendezvous server:

make run

Build the migration stage of the contracts image:

make build-contracts-migrate

Deploy the contracts to the blockchain:

make run-contracts-migrate

Attention: this step must be executed before building the application image (next step).

Build the application image:

make build-app

Deploy the application:

make run-app

Head to localhost:8473 and voilà, a working Concordia instance appears! The blockchain is exposed in the address localhost:8545.

Tip: the accounts (private keys) generated by Ganache are available in the file ./volumes/ganache_keys/keys.json.

Env Files

Targets in the Makefile make use of env files suffixed by .docker located in the directory ./env. Using this environment variables, you can change various configuration options of the testing/production deploys.