usage.md

Usage Guide

Please read the Install Guide and install all necessary components first.

Quick start guide

Steps for Falcon infrastructure and Bluejay

1. Setup infrastructure

   fides setup infrastructure https://github.com/governify/falcon-infrastructure.git --env-file .env -a src/agreements/bluejay_ans.json
   

   In this link you can check the information that the .env file must contain for this use case

   This setup will load predefined data in order to execute experiments. You can see the data in the dashboard once the infrastructure setup is finished.

2. Setup ESC

   fides setup esc https://github.com/isa-group/esc-falcon.git
   

Custom setup

Infrastructure Setup

To setup the infrastructure execute the next command:

fides setup infrastructure <infrastructure repository url> --env-file <path to .environment file> -f <Path to the docker-compose file> -a <path to agreement json file>

By default these params values are:

• Infrastructure repository url: Falcon infrastructure: https://github.com/governify/falcon-infrastructure.git
• Docker-compose file: docker-falcon/docker-compose-local.yaml
• SLA Agreement Bluejay

ESC Setup

To setup the Elastic Smart Contracts framework execute the next command:

fides setup esc <esc repository url>

This command will start the server on port 6100

Experiment configuration

Follow the experiment guide to configure and execute experiments

Cleanup

To turn everything off execute the next command:

fides down --clean -f <Path to the docker-compose file>

The clean param is optional. If you indicate this one, all folders and files generated will be removed.

By default the Docker-compose file path is docker-falcon/docker-compose-local.yaml