Skip to content

Latest commit

 

History

History
60 lines (47 loc) · 2.99 KB

README.md

File metadata and controls

60 lines (47 loc) · 2.99 KB
Raw

Prerequisites

  • Docker
  • Current used added to 'docker' group (not needed for all environments)
  • macOS users will need to install an up to date version of sed using Homebrew brew install gnu-sed --with-default-names

Start pool

./pool_start.sh [number of nodes in pool] [IP addresses of nodes] [number of clients] [port for the first node]

Defaults:

  • Number of nodes is 4
  • IP addresses are generated consequently starting from 10.0.0.2 ** Format: 10.0.0.2,10.0.0.3,10.0.0.4,10.0.0.5
  • Number of clients is 10
  • Ports are generated consequently starting from 9701

Start client

./client_for_pool_start.sh [file with pool data] [client's IP address] [number of clients]

Defaults:

  • File is pool_data
  • IP address is the next in sequence of IP addresses read from pool data (e.g. 10.0.0.6)
  • Number of clients is 10

Container is retained after sovrin shell is closed. Executing client_stop.sh removes the container.

Start agents (optional)

If you are planning to run the Sovrin Tutorial (about Alice, her transcripts, job, and bank), start the organization Sovrin Agents using the instructions in StartSovrinAgents.md in this folder.

Stop pool

./pool_stop.sh [file with pool data] [pool network name]

Defaults:

  • File is pool_data
  • Network name is pool-network

Stop client

./client_stop.sh

Stopping the sovrin client removes the client container.

Running on Windows using git bash

Using the git bash shell is a productive command line for those familiar with Unix/Linux to run applications/environments on Windows. However, git bash can create problems with pathnames, and does so with this application. Specifcally, by default git bash converts absolute path names to a Windows equivalent path name (e.g. C:\...), which is helpful if it is expected by an app, but not always - and rarely with Docker. In particular, it's not helpful with Docker volume mounting on docker run and build commands. The Sovrin test scripts - client_build.sh, node_build.sh, client_start.sh and node_start.sh are all affected by this. When just run, docker build/run commands error off with messages like:

C:\Program Files\Docker\Docker\Resources\bin\docker.exe: Error response from daemon: invalid bind mount spec "/C/Program Files/Git/sys/fs/cgroup;C:\\Program Files\\Git\\sys\\fs\\cgroup;ro": invalid volume specification: '/C/Program Files/Git/sys/fs/cgroup;C:\Program Files\Git\sys\fs\cgroup;ro': invalid mount config for type "bind": invalid mount path: '\Program Files\Git\sys\fs\cgroup;ro' mount path must be absolute.

The easiest way to prevent pathname expansion is to preface the pool and client commands with MSYS_NO_PATHCONV=1, for example:

MSYS_NO_PATHCONV=1 ./pool_start.sh

Alternatively, you can edit the scripts and on the docker run and build scripts, change leading slashes (/) in pathnames to double slashes (//) on -v (volume mount) parameters.