Skip to content

SoftwareAG/iECO-Federated-Catalog-Metadata-Backend

Repository files navigation

iECO Federated Catalog Metadata Backend

Description

This Spring Boot application provides storage capabilities for additional metadata to the Federated Catalog Portal application by Software GmbH.

Installation

The application can be compiled with Maven from source (mvn package) or to a Docker image using the attached Dockerfile (docker build . -t ieco-fc-metadata-backend --build_arg SKIPTESTS=true).

Requirements

  • Maven
  • Java 17 or higher
  • Optional: Docker

Usage

Regardless whether the application is executed with or without Docker, a few configuration properties have to be set:

Environment variable Description Mandatory? Example
APP_CATALOG_URL Public URL to the Federated Catalog instance Yes https://catalog.example.com
APP_KEYCLOAK_URL Public URL to the Keycloak realm used by the Federated Catalog Yes https://keycloak.example.com/realms/my-realm
OAUTH_CLIENT_ID The Client ID of the OAuth Client/Keycloak Client that the Portal component should be using Yes participant-portal-backend
OAUTH_CLIENT_SECRET The Client Secret of the OAuth Client/Keycloak Client that the Portal component should be using Yes UR77nW70HIcXctNlx1x0PHvsQBzlAa7q
H2_CONSOLE_ENABLED Whether the H2 Web-Console should be active, allowing access to the database through the browser. Should be disabled in non-testing environments. No true
SERVER_PORT HTTP Port where the application should be running. Default is 8080 No 8080

Data is stored to a file-based database. Ensure that the application has write permissions in it's folder, or if used as Dockerfile, has a volume mounting at ./db in the application folder.

License

Copyright 2025 Software GmbH, Darmstadt, Germany and/or its subsidiaries and/or its affiliates and/or their licensors.

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

About

No description, website, or topics provided.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published