Skip to content

Latest commit

 

History

History
105 lines (81 loc) · 5.66 KB

README.md

File metadata and controls

105 lines (81 loc) · 5.66 KB
Raw

Issuer-ui

by in2.es

Quality Gate Status

Bugs Vulnerabilities Security Rating Code Smells Lines of Code

Coverage Duplicated Lines (%) Reliability Rating Maintainability Rating Technical Debt

Introduction

IN2 Issuer UI is the presentation side application for the IN2 Issuer project. It is a Angular application.

Main Features

  • Landing Page
  • Login and register with conventional login
  • Login and register with digital certificate
  • Issued Credentials list view
  • New Credential and New Credential as Signer forms
  • Credential Details view

Installation

As key part of the Credential Issuer solution the Issuer UI is designed to work with the following dependencies:

Dependencies

To utilize the Credential Issuer, you will need the following components:

  • Issuer-UI
  • Issuer-API
  • Issuer Keycloak Plugin
  • Postgres Database
  • SMTP Email Server

For each dependency, you can refer to their respective repositories for detailed setup instructions. We offer a Docker image to run the application. You can find it in Docker Hub.

Here, you can find an example of how to run the application with all the required services and configuration.

Issuer UI

The application needs key custom environment variables to be configured

  • LOGIN_URL: login url for your Keycloak realm
  • CLIENT_ID: Keycloak client responsible for the registration
  • WALLET_URL: Url of the Wallet application intended to be used to retrieve the credentials
  • BASE_URL: base url of the Issuer API

Example of a typical configuration:

docker run -d \
  --name issuer-ui \
  -e LOGIN_URL=http://keycloak-external.org/realms/CredentialIssuer \
  -e CLIENT_ID=account-console \
  -e SCOPE="openid profile email offline_access" \
  -e GRANT_TYPE=code \
  -e BASE_URL=http://issuer-api.com/ \
  -e WALLET_URL=http://wallet.com/ \
  -p 4201:8080 \
  in2workspace/issuer-ui:v1.0.0

Issuer API

The Server application of the Credential Issuer. Refer to the Issuer API Documentation for more information on configuration variables.

Issuer Keycloak Plugin

Keycloak is used for identity and access management, as well as for other OpenID4VCI DOME profile requirements. It's an implementation of the official quay.io keycloak image with a custom layer. Refer to the Keycloak Plugin Documentation for more information on setup and configuration variables.

Postgres Database

Separate instances of Postgres are used as the database for Keycloak and the Issuer API. You can find more information in the official documentation.

SMTP Email Server

An SMTP Email Server of your choice. It must support StartTLS for a secure connection. Refer to the Issuer API Documentation for more information

Contribution

How to contribute

If you want to contribute to this project, please read the CONTRIBUTING.md file.

License

This project is licensed under the Apache License 2.0 - see the LICENSE file for details.

Project/Component Status

This project is currently in development.

Contact

For any inquiries or further information, feel free to reach out to us:

Acknowledgments

This project is part of the IN2 strategic R&D, which has received funding from the DOME project within the European Union’s Horizon Europe Research and Innovation program under the Grant Agreement No 101084071.