sovity EDC UI

UI for sovity's extended EDC-Connector.
Report Bug · Request Feature

Table of Contents

1. About The Project
2. Getting Started
3. Configuration
4. Running dev mode
5. Build docker image
6. Contributing
7. License
8. Contact

About The Project

Eclipse Dataspace Components is a framework for building dataspaces, exchanging data securely with ensured data sovereignity.

sovity extends the EDC functionality to offer enterprise-ready managed "Connector-as-a-Service" services, bringing out-of-the-box fully configured DAPS and integrations to existing other dataspace technologies.

Our extension of EDC DataDashboard functionalities has been made open source and will be kept compatible to mostly stock EDCs with minimal API extending extensions.

(back to top)

Getting Started

The fastest way to get started is using our Getting Started Guide: sovity EDC CE Getting Started Guide.

(back to top)

Configuration

A list of all available configuration properties can be found here.

In general, all ENV vars EDC_UI_* are written to an assets/app-config.json, either before starting the angular build server or before starting the nginx to serve static files.

(Optional) Pass a JSON in an ENV Var

The ENV var EDC_UI_CONFIG_JSON can be used to pass a JSON that can contain all properties that would otherwise need to be specified individually. Individually provided ENV vars take precedence, however.

(back to top)

(Optional) Configuring the NGINX

# Customizable ENV Vars and their defaults
NGINX_BIND: '0.0.0.0'
NGINX_PORT: '8080'
NGINX_ACCESS_LOG: '/dev/stdout'
NGINX_ERROR_LOG: '/dev/stderr'

Running dev mode

Requires Node.js version ^16.10.0.

# Fake backend
(cd fake-backend && npm i && npm run start)

# Run Angular Application
npm i
npm run start

Configuring Dev Mode

For dev mode ENV vars are read from:

• Current Environment Variables (highest precedence)
• .env file (not committed, in .gitignore)
• .env.local-dev file (defaults for working with fake backend).

# Example:
# Create a .env file to easily switch between profiles
EDC_UI_ACTIVE_PROFILE=mds-open-source

(back to top)

Build docker image

Requires docker.

# Build docker image
docker build -f "docker/Dockerfile" -t "edc-ui:latest" .

# Docker image will serve at :80

(back to top)

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

Our contribution guide can be found in CONTRIBUTING.md.

(back to top)

License

Distributed under the Apache 2.0 License. See LICENSE for more information.

(back to top)

Contact

contact@sovity.de

(back to top)