Home

Table of Contents Prerequisites Install and start a CSBWizard Node How to use CSBWizard

Prerequisites

Install or update Node to version 8.x.x or newer.

Install and start a CSBWizard Node

First of all, create a local clone of the PrivateSky Github project:

git clone https://github.com/PrivateSky/privatesky

Enter into checkout folder and run the following command:

cd privatesky
npm run install

The Node version is checked and if is all good the installation process begins by downloading the required dependencies. Once the installation process has finished successfully, run the script:
For Linux:

 ./bin/virtualMq.sh [--port=] [--folder=] 

For Windows:

 bin\virtualMq.bat [--port=] [--folder=]

The default port that will be used is 8080 and the folder is ../tmp . Once the command is executed and the virtualMq server is running, run the following command:
For Linux:

 ./bin/csbwizard.sh [--port=] [--folder=] 

For Windows:

 bin\csbwizard.bat [--port=] [--folder=]

The default port that will be used is 8081 and the folder is ../tmp .

How to use CSBWizard

CSBWizard exposes the following API:

 POST /beginCSB 

Creates a new transaction and returns it's ID to be used in subsequent requests.

---

 POST /addBackup/:transactionID 

Accepts in body a base url (ex: http://localhost:8080) as text/plain to a virtualMQ server where it will send backups once the build csb command will be called.

---

 POST /attachFile/:transactionID/:fileAlias 

Accepts in body a file as application/octet-stream and saves with with the given alias.

---

 POST /buildCSB/:transactionID 

Sends the created CSB to the backups provided previously and return the SEED used to encrypt it