Deployment on Linux, MacOS and Windows (with WSL2)

• Install Docker on your system according to OS:

  • Docker Desktop for MacOS and Windows

  • Docker install on Ubuntu

• For Ubuntu, also install docker-compose:

• Install the dependencies on ubuntu:

• Clone the repository and open it.

• Run the setup.py file using python3

After the setup is done, you can view the connector setup UI at: http://localhost:8000.

Quick start

In browser, open: http://localhost:8000/ and follow the instructions

For more details see local deployment.

Requirements:

• Python3.6+

• Docker Desktop (for MacOS and Windows with wsl2).

• Docker and Docker Compose for ubuntu

Deployment and Guides

You can see FarmStack in action by Setting up Video Library Connector for fetching data from Digital Green's Video Library.

Or you can follow one of our step-by-step guide to setup your own connectors:

• Configuring a connector with CSV file

• Dockerizing applications to be compatible with FarmStack Connector

• Install a dockerized application with a connector

Features

FarmStack enables network of data providers and consumers through a suite of products and functionalities:

1. Share data directly without any third party through trusted peer to peer (p2p) connector.

2. Empower the data provider to restrict usage of data through usage policies.

3. Give control of data back to the farmers by managing consent using data wallet.

4. Enable entities to create plugins to make their data discoverable (description of data).

FarmStack is the sum total of all the peer to peer connectors and associated usage policies.

For more information visit our website or Confluence Page.

Contributing

We would love your contribution to this project no matter big or small.

To get started see our contribution guide.

Roadmap

@TODO - Add Roadmap

License

Farmstack is licensed under Apache License 2.0. See LICENSE file for licensing information

In the terminal window type the following command to run FarmStack setup:

After the setup is complete, in the browser window, open the installer frontend by typing http://localhost:8000.

Running example connectors

Navigate to New Connector tab

Give the provider a unique name, for example, Test Provider 1 and click Next

Give the consumer a unique name, for example, Test Consumer 1 and click Next

Verify the details and start the connection by clicking Set up Connection button.

Depending on your system resources and internet speed this step could take anywhere from a few seconds to a few minutes. You can check the progress in the terminal window.

When the connector setup is complete, open the status tab and click View transferred data link to see your data.

Kindly wait a couple of minutes for the contract negotiation process of provider and consumer to complete before they can start sharing the data.

After the negotiation, the provider will start streaming data to the consumer. Kindly refresh to see the data shared into the consumer application.

This completes the tutorial for Setting up a Managed connector with usage control example. If you face any issue while running the self managed connector, kindly open a new issue in the Github repository and our experts will guide you.

Copy this code into the Dockerfile

First we are going to define the image we are going to use. Here we are using latest alpine image of node to keep the size of NodeJS application small. You can use any image available in the Node's Dockerhub.

Next we will create a directory to copy all our application code inside the image.

Since we are using node image, node and npm are already installed in this image. We just need to copy our package.json and package-lock.json files.

Here, we copy package.json files before copying complete project. This is done to take advantage of Docker layers caching and only install dependencies if the files have changed. You can find more information about this here.

Now we will copy your app's source code to docker image.

Our sample-nodejs app binds to port 8081 so we will map this port to docker daemon by using EXPOSE command. If your app uses any other port, kindly change it

In this last step, define the command to start your application. Our sample application starts withnpm start command. You can also use a shell script file here which executes to start your server.

This should be your final Dockerfile

You can find the final Dockerfile here.

.dockerignore file

Create a .dockerignore file in the same directory as your Dockerfile. Add the following lines to the file:

Next Steps

Kindly follow the previous tutorial to locally setup and deploy FarmStack before proceeding with this next step, if not done already.

Clone the FarmStack repository and open in terminal, using following commands:

Open prepareConsumerApp.sh in scripts folder in your favorite editor.

Edit the following variable to according to your application:

You can also edit the parameters for the example configuration according to your requirements, but it is advised to leave these variables untouched, unless you know what you're doing.

In the terminal, execute the script from farmstack-open directory:

This script will create a docker image for your application and modify the required usage control parameters in the example-provider-routes.xml file.

In the terminal window type the following command to run FarmStack setup:

After the setup is complete, in the browser window, open the installer frontend by typing localhost:8000.

Follow the steps to create your connectors, give a unique name to your connectors such as cities-provider and cities-consumer.

Start the connection by clicking Setup Connection Button.

When the connector setup is done click View transferred data link to see your data. Kindly wait a couple of minutes for the contract negotiation process of provider and consumer to complete before they can start sharing the data.

This completes the tutorial for running the dockerized application with the consumer connector. If you face any issue while running your consumer app kindly open a new issue in the github repository and our experts will guide you.