Skip to content

Commit

Permalink
Merge pull request #73 from catenax-ng/documentation-update
Browse files Browse the repository at this point in the history
update README.md according to the last changes
  • Loading branch information
almadigabor authored Nov 15, 2023
2 parents 058cb10 + 30b015f commit cdcbc2f
Showing 1 changed file with 12 additions and 0 deletions.
12 changes: 12 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -155,6 +155,8 @@ keycloak:
spring:
jackson:
default-property-inclusion: non_null
profiles:
active: catena-x-ctx
security:
oauth2:
resourceserver:
Expand Down Expand Up @@ -190,6 +192,13 @@ app:
Here `keycloak` section defines keycloak's parameters for client requests authentication.

Section `spring.profiles` activates different modes. From functional point of view, the Factory acts as a converter,
transforming an input message to the output JSON and passes it to the Compliance Service. The actual converter is selected
by setting corresponding profile. Currently, two type of converters are supported. The old one is selected if profile
'catena-x-ctx' is selected. It was used from the the beginning and well tested. The second is activated when 'gaia-x-ctx'
profile is chosen. This converter generates JSON which shall be compatible with Gaia-X requirements, however it needs to
be aligned with other services/components.

`app.verifiableCredentials.durationDays` defines for how many days the VC is issued.

`schema2210Url` specify the JSON-LD vocabulary URL
Expand Down Expand Up @@ -228,6 +237,9 @@ SD-Factory can be fired up locally in Docker environment. Before that the image
to be created. Do not forget to provide necessary configuration parameters in `application.yml`
for keycloak and the Custodian Wallet.

If `spring.profile` is set to `test` then the Factory does not send self-description to the Compliance Service, instead
it just prints it out along with service data like Compliance Service URL, authentication token (if any) and external ID.

# Container images

This application provides container images for demonstration purposes. The base image used, to build this demo application image is eclipse-temurin:17-jdk-alpine
Expand Down

0 comments on commit cdcbc2f

Please sign in to comment.