Home

Prometheus-X Dataspace Connector

The Data Space Connector is an open source project aimed to facilitate the onboarding and participation of organisations in the data space. It is built with simplicity in mind and offers the necessary functionalities for organisations to communicate with the core components of the data space such as Catalogue for resources, offerings and data space use cases management, Contract for negotiation and contract verification and Consent for the management of individuals, privacy notices & consent driven data exchanges.

Installation

Docker

You can launch the data space connector with docker and docker compose by using the following command at the root of the project.

docker compose build && docker compose up -d

or

docker compose up -d

The docker compose file will launch the app and a mongodb container.

Using your own mongodb database is possible by updating the following variable in your .env

MONGO_URI=mongodb://mongodb:27017/dataspace-connector

Classic installation

1. Clone the repository from GitHub:

git clone https://github.com/Prometheus-X-association/dataspace-connector.git

2. Install packages using pnpm

npm i -g pnpm # If pnpm is not installed
pnpm i

3. Copy the .env.sample into a .env and set your environment variables

cp .env.sample .env

4. Copy the config.sample.json into a config.${NODE_ENV}.json and set your configuration variables

# Copy the config.sample.json to config.${NODE_ENV}.json matching your NODE_ENV variable

#For production
cp src/config.sample.json src/config.production.json