Skip to content

Commit

Permalink
Merge f4bd622 into 4616210
Browse files Browse the repository at this point in the history
  • Loading branch information
pulledtim authored Jun 6, 2023
2 parents 4616210 + f4bd622 commit d315fda
Show file tree
Hide file tree
Showing 2 changed files with 43 additions and 3 deletions.
42 changes: 41 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,45 @@
# 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)

## 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 Registry is licensed under the Apache License, Version 2.0. See LICENSE for the full license text.

Implementation of the [TIR](https://api-pilot.ebsi.eu/docs/apis/trusted-issuers-registry/v4#/) backed by NGSI-LD Context Broker
© 2023 FIWARE Foundation e.V.
4 changes: 2 additions & 2 deletions src/main/resources/application.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ micronaut:
server:
port: 8080
netty:
log-level: TRACE
log-level: DEBUG
max-header-size: 12000
security:
enabled: true
Expand All @@ -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:
Expand Down

0 comments on commit d315fda

Please sign in to comment.