Tilkynna

Tilkynna is an enterprise grade, utility-style report server wrapper written in Java.

Quickstart

Taking it out for a spin in 5-10 minutes:

Pre-requisites

This example uses:

• docker: docker must be installed on the host.
• docker-compose: docker-compose must be installed on the host.

• Clone Github repo:

git clone git@github.com:GrindrodBank/tilkynna.git

• Run using docker-compose:

cd tilkynna
cd quickstart/docker-compose
docker-compose -p tilkynna up

4 services are installed:

• Web_1 - The actual Tilkynna reporting service installed on port 9981
• PostgreSQL Database installed on port 5432
• Keycloak Authentication service installed on port 9191 and can be accessed by going to http://localhost:9191
• SFTP - An SFTP server running on port 2222

Credentials for PostgreSQL database

• Password: postgres
• Database: tilkynna

Credentials for Keycloak

• Username: admin
• Password: admin

Credentials for SFTP

• Username: foo
• Password: pass

Using the API

• Via CLI curl commands
• Using Postman GUI Tool

To undeploy everything:

docker-compose -p tilkynna down

Project Documentation

All project documentation is currently available within the /doc folder.

Performance Testing Results are available in the /doc folder

License