reiizumi/toranku repository overview

⁠Toranku

Toranku container images

⁠Description

This service allows you to manage categories that are used by other services. These services must be authenticated with a token, the client's name is used as an identifier, so the categories of a client are not seen by the rest of services.

Resources are published according to the OpenAPI specification. This is published in the code repository⁠, it is not published inside the container.

You can find more information about the code in the repository⁠.

Toranku does not have the functionalities to publish its services via HTTPS, delegating this functionality to a web frontend/proxy (like Traefik⁠ or Ingress.

⁠Usage

The service requires a PostgreSQL⁠ database and an Identity Manager (like Keycloak⁠) to confirm that the received tokens are correct.

it is possible to use other databases, but the container does not have the libraries. You must pack and generate the container with the correct library. Remember that the Toranku project uses the Quarkus Reactive JDBC libraries.

⁠Database parameters

You must indicate the connection data to the database. Toranku will generate the tables if they don't exist, so the user has to have permission to do so:

• quarkus.datasource.reactive.url database URL like postgresql://postgres.example.cat:5432/toranku_db
• quarkus.datasource.username database Username
• quarkus.datasource.password database Password

⁠OIDC parameters

Connection data to Identity Manager to check that the tokens are correct. Must be compatible with the OIDC format.

• quarkus.oidc.auth-server-url Identity Manager URL like https://keycloak.example.cat/auth/realms/Intranet

It requires roles according to the Keycloak format

⁠OIDC HTTPS certificate

if an Identity Manager is accessed via HTTPS and it has an invalid certificate, it must be added into the service so that it can connect.

To do this, you must replace the cacerts file in /cacerts mounting your own cacerts file with your certificate. If you don't have any cacerts file, you can download the original from the container or any from Java 17.

⁠Expose on localhost

To start the system, you must first configure the database and the Identity Manager. When everything has been configured, the following command will allow you to start the service:

docker run -p 8080:8080 \
  -e quarkus.datasource.reactive.url=postgresql://postgres.example.cat:5432/toranku_db \
  -e quarkus.datasource.username=postgres \
  -e quarkus.datasource.password=postgres \
  -e quarkus.oidc.auth-server-url=https://keycloak.example.cat/auth/realms/Intranet \
  reiizumi/toranku

⁠Other services

The service has a simple index website (in HTML) to see the version and compilation information.

Health and metrics are also published:

• /q/health/ready indicates whether the service is available for use.
• /q/metrics metrics in Prometheus format.