Setup

Setup:

• See also: System requirements
• You need to provide the signprefix, public key, host and port of the node (and whether you use tls or not) and the used encryption key (if any) to all nodes that want to join. So make note of those values.

Setup processor, database and node using docker-compose:

• Download the docker-compose.yml file.
• In case you want to target specific versions, rather then latest, modify the context for all services.
• Fill in the variables in the docker-compose file as well as choosing a database password. (Alternately you can provide them when starting the docker using -e VARNAME=VALUE flags.) You can also modify any other settings.
• Run docker-compose build.

Setup processor using docker:

• Start a postgres server and setup the database using the setup script. It is recommended to run this on the same system as the processor to reduce latency, as all reads/writes need to be done in sequence.
• Download the Processor.Dockerfile file.
• In case you want to target a specific version, rather then latest, modify the git clone command to point to a specific version.
• Fill in the variables in the docker file. (Alternately you can provide them when starting the docker using -e VARNAME=VALUE flags.)
• Run docker build -f processor.Dockerfile -t vprocessor . where the processor was downloaded.

Setup processor standalone:

• Start a postgres server and setup the database using the setup script. It is recommended to run this on the same system as the processor to reduce latency, as all reads/writes need to be done in sequence.
• Create a config file for the processor. (Alternately use environment variables.)
• Install yarn (https://yarnpkg.com/en/docs/install)
• Run yarn global add typescript, yarn install and yarn build

Starting:

Start processor, database and node using docker-compose:

• The first time use docker-compose up -d (From the folder the docker file is in.)
• Subsequent times use docker-compose start (From the folder the docker file is in.)
• Log can be viewed using docker-compose logs (From the folder the docker file is in.)

Start processor using docker:

• The first time use docker run --name vprocessor -d vprocessor.
• Subsequent times use docker start vprocessor.
• Log can be viewed using docker logs vprocessor.

Start processor standalone:

• Run yarn start path/to/config.json (From the folder the processor is downloaded to.)
  • Everything will be logged to the standard output, most notably watch the first few seconds to see if there are problems with the setup.

Shutdown:

Shutdown processor, database and node using docker-compose:

• Run docker-compose stop (From the folder the docker-compose file is in.)

Stop processor using docker:

• Run docker stop vprocessor.

Shutdown processor standalone:

• Send a SIGINT for a graceful shutdown, send a SIGTERM for an attempted graceful shutdown, but a hard shutdown after 10 seconds, send a SIGKILL for an immediate shutdown.
  • If the shutdown was not graceful it may be in the middle of processing a block, which won't be finished processing till it is started again.