Skip to content

Latest commit

 

History

History
77 lines (50 loc) · 2.88 KB

INSTALLATION.md

File metadata and controls

77 lines (50 loc) · 2.88 KB

Installation

Run with Docker-Compose

In order to set up the whole system consisting of multiple components, a docker-compose file has been prepared. This makes it straightforward to get a sample system up and running.

The full system will comprise:

  • damap-backend,
  • damap-frontend,
  • dummy Keycloak with login name "user" and password "user",
  • dummy PostgreSQL database,
  • FITS service (https://github.com/harvard-lts/FITSservlet)
  • and dummy APIs providing person and project data.

To start up the cluster of components, run the following command:

cd docker
docker compose up --build --force-recreate -d
  • --build: Ensures that images are rebuilt before running.
  • --force-recreate: Forces the recreation of containers, which is useful if you want to refresh your setup and ensure all components start cleanly.

For local development, it is often enough to only run the additional services, as the local development instances for the backend and frontend are used. To only start the additional services, run the following command:

cd docker
docker compose -f docker-compose-services.yaml up -d

The -d flag runs the services in detached mode, meaning they run in the background, allowing you to keep using the terminal for other commands.

See the documented sections in the docker/docker-compose.yaml to make further configurations.

Keycloak

Keycloak can be accessed through http://localhost:8087. You can log in to Keycloak as an admin with the following credentials:

username: admin
password: admin

Update Realm Config

If you update a running Keycloak instance (e.g., adding users, changing properties), you can export the current configuration to a JSON file. Save this JSON file to keycloak export file to integrate it with the docker-compose cluster. Be sure to rebuild Keycloak by running the following commands:

# Rebuild Keycloak
docker compose build keycloak

# Restart Keycloak
docker compose up -d keycloak

PostgreSQL

You can access the PostgreSQL CLI directly within the container using:

cd docker
docker compose exec damap-db psql -U damap damap

Custom Deployment

In order to adapt the project and deploy it in your own institutional environment, follow the deployment instructions.

OpenAPI Documentation

The OpenAPI documentation is automatically generated for the backend. Additionally, a Swagger-UI is available for easy access to the API documentation. This interface allows you to explore and test the available endpoints.

TU Graz API

For the TUGraz environment, the relevant API information can be accessed at TUGraz API. The client ID and secret for accessing the API are obtained through sesam.tugraz.at.