From 81a850d4da6fd7944dbae41162d87690e04eb234 Mon Sep 17 00:00:00 2001 From: Tim Smyth Date: Tue, 6 Jun 2023 08:49:05 +0200 Subject: [PATCH 1/3] docu --- README.md | 45 +++++++++++++++++++++++++++++ src/main/resources/application.yaml | 4 +-- 2 files changed, 47 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 7abe12d..3429618 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,50 @@ # Trusted Issuers Registry + +The Trusted Issuers Registry provides both an [EBSI Trusted Issuers Registry](https://api-pilot.ebsi.eu/docs/apis/trusted-issuers-registry/v4#/) implementation and an iShare implementation. The service provides data from an NGSI-LD compliant backend and configuration files. + +[![FIWARE Security](https://nexus.lab.fiware.org/repository/raw/public/badges/chapters/security.svg)](https://www.fiware.org/developers/catalogue/) +[![License badge](https://img.shields.io/badge/License-Apache_2.0-blue.svg)](https://opensource.org/licenses/Apache-2.0) [![Coverage Status](https://coveralls.io/repos/github/pulledtim/trusted-issuers-registry/badge.svg?branch=main)](https://coveralls.io/github/pulledtim/trusted-issuers-registry?branch=main) +[![Test](https://github.com/pulledtim/trusted-issuers-registry/actions/workflows/test.yml/badge.svg)](https://github.com/FIWARE/trusted-issuers-list/actions/workflows/test.yml) +[![Release](https://github.com/pulledtim/trusted-issuers-registry/actions/workflows/release.yml/badge.svg)](https://github.com/FIWARE/trusted-issuers-list/actions/workflows/release.yml) +## Background Implementation of the [TIR](https://api-pilot.ebsi.eu/docs/apis/trusted-issuers-registry/v4#/) backed by NGSI-LD Context Broker + + +## Installation +### Container + +The Trusted Issuers Registry is provided as a container at [quay.io](https://quay.io/repository/pulledtim/trusted-issuers-registry). +To provide the service, a NGSI-LG service has to be provided. In a local setup, you can for example use: +```shell +docker run --name orionld -p 1206:1206 quay.io/fiware/orion-ld:1.1.1 +``` +and the start the service: +```shell +docker run --network host quay.io/pulledtim/trusted-issuers-registry:0.0.1 +``` +After that, its accessible at ```localhost:8080```. +### Helm Chart + +More convinient deployment is available via the [Helm Chart](https://github.com/FIWARE/helm-charts/tree/main/charts/trusted-issuers-registry) + +### Configuration + +Configurations can be provided with the standard mechanisms of the [Micronaut-Framework](https://micronaut.io/), e.g. [environment variables or appliction.yaml file](https://docs.micronaut.io/3.1.3/guide/index.html#configurationProperties). +The following table concentrates on the most important configuration parameters: + +| Property | Env-Var | Description | Default | +|------------------------------------|------------------------------------|--------------------------------------------------------------|---------------------------| +| `micronaut.server.port` | `MICRONAUT_SERVER_PORT` | Server port to be used. | 8080 | +| `micronaut.metrics.enabled` | `MICRONAUT_METRICS_ENABLED` | Enable the metrics gathering | true | +| `micronaut.http.services.ngsi.url` | `MICRONAUT_HTTP_SERVICES_NGSI_URL` | Url of the backing NGSI-LD broker | ```http://ngsi-ld:1026``` | +| `general.contextUrl` | `GENERAL_CONTEXT_URL` | URL of the Context file to be used when accessing the broker | `````` | + + +## License + +Trusted-Issuers-List is licensed under the Apache License, Version 2.0. See LICENSE for the full license text. + +© 2023 FIWARE Foundation e.V. \ No newline at end of file diff --git a/src/main/resources/application.yaml b/src/main/resources/application.yaml index af7cd74..d0b4aaf 100644 --- a/src/main/resources/application.yaml +++ b/src/main/resources/application.yaml @@ -11,7 +11,7 @@ micronaut: server: port: 8080 netty: - log-level: TRACE + log-level: DEBUG max-header-size: 12000 security: enabled: true @@ -26,7 +26,7 @@ micronaut: read-timeout: 30s ngsi: path: ngsi-ld/v1 - url: http://gaia-x-orion-ld:1026 + url: http://ngsi-ld:1026 read-timeout: 30 --- endpoints: From 62fd44fcbe00f1034893e57a13959c37f48b6533 Mon Sep 17 00:00:00 2001 From: Tim Smyth Date: Tue, 6 Jun 2023 08:50:31 +0200 Subject: [PATCH 2/3] cleanup --- README.md | 5 ----- 1 file changed, 5 deletions(-) diff --git a/README.md b/README.md index 3429618..3b92910 100644 --- a/README.md +++ b/README.md @@ -8,11 +8,6 @@ The Trusted Issuers Registry provides both an [EBSI Trusted Issuers Registry](ht [![Test](https://github.com/pulledtim/trusted-issuers-registry/actions/workflows/test.yml/badge.svg)](https://github.com/FIWARE/trusted-issuers-list/actions/workflows/test.yml) [![Release](https://github.com/pulledtim/trusted-issuers-registry/actions/workflows/release.yml/badge.svg)](https://github.com/FIWARE/trusted-issuers-list/actions/workflows/release.yml) - -## Background -Implementation of the [TIR](https://api-pilot.ebsi.eu/docs/apis/trusted-issuers-registry/v4#/) backed by NGSI-LD Context Broker - - ## Installation ### Container From f4bd622de6f1ba3a5572a90c4d109a35f49dca74 Mon Sep 17 00:00:00 2001 From: Tim Smyth Date: Tue, 6 Jun 2023 08:51:13 +0200 Subject: [PATCH 3/3] fix --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 3b92910..507b42c 100644 --- a/README.md +++ b/README.md @@ -40,6 +40,6 @@ The following table concentrates on the most important configuration parameters: ## License -Trusted-Issuers-List is licensed under the Apache License, Version 2.0. See LICENSE for the full license text. +Trusted Issuers Registry is licensed under the Apache License, Version 2.0. See LICENSE for the full license text. © 2023 FIWARE Foundation e.V. \ No newline at end of file