Skip to main content

Getting Started

Prerequisites​

  • docker
  • docker-compose
note

On Windows platform it is highly recommended to use Windows Subsystem for Linux (WSL) and enable Use the WSL 2 based engine in docker settings.

Step 1: Clone repository​

If you haven't already, clone JtlReporter repository:

git clone https://github.com/ludeknovy/jtl-reporter.git

Step 2: Deploy JtlReporter with docker-compose​

After cloning the project repository cd into the jtl-reporter folder and deploy the application:

docker-compose up -d
note

Please, wait a bit for all the services to be up and migrations to finish. If you access the application before that, you will get an error.

Step 3: That's it! 🎉​

Congratulations! You've successfully deployed JtlReporter

Now open the application in your browser:

http://IP_ADDRESS:2020

Once the application is up, you will be redirected to the init page, where you will create the credentials.

Now refer to the Integration section on how to get some data in.