backend

Dashboards backend

This backend exists to serve the subscription feature (which is not fully implemented and currently on hold). Genomic queries are served by LAPIS instances and do not go through this backend.

See docs/arc42/03-context.md for its place in the whole context.

Local setup

You have to provide config information to the backend:

• Dashboards configuration, e.g. the LAPIS instances of the organisms. We have profiles available that only need to be activated via spring.profiles.active.
• Database connection configuration: values need to be passed via external properties. For local development, we have a local-db profile available. You can also check that for required properties.

Start local database

Start the local PostgreSQL database using Docker Compose (from the repo root):

docker compose up -d database

Stop the database:

docker compose down database

Stop and remove data volumes:

docker compose down -v database

Run the backend

To run the backend locally, you can use the following command:

./gradlew bootRun --args='--spring.profiles.active=local-db,dashboards-prod'

The backend will be available at:

• Base URL: http://localhost:8080
• Swagger UI: http://localhost:8080/swagger-ui/index.html

Run tests:

./gradlew test

Authentication

While the backend uses user IDs internally, for example to track owners of collections or subscriptions, it doesn't handle authentication of users. This is done in the frontend. All requests are proxied through the frontend server, where authentication is handled, and then the authenticated requests are sent to the backend.

Logging

Logs to rotating files are stored in ./logs and written to stdout. In the Docker container, log files are stored in /workspace/logs

Swagger UI and OpenAPI

The backend provides a OpenApi 3.0 specification for the API documentation. The specification is available at /v3/api-docs.

The backend provides a Swagger UI for the API documentation. The Swagger UI is available at /swagger-ui/index.html.