Installation guide

Discover 3 pathways to install ReportPortal with

Docker

Kubernetes

Google CM

Install Docker

OS Support

Linux (Ubuntu 20.04+ or equivalent) - Recommended
macOS (Intel or Apple Silicon; Docker Desktop requires macOS 12.0+)
Windows (64-bit Windows 11 Pro+ with Hyper-V/WSL 2)

Docker & Compose

Install Docker Engine
Ensure Docker Compose plugin is version ≥ 2.2 docker compose version

Resources

Important!

Allocate ≥ 2 CPUs & 6 GB RAM to Docker; ≥ 20 GB free disk space

Step 1

Configure and deploy ReportPortal

The following guide describes deployment on Linux/Mac/Windows.

1. Download the latest ReportPortal Docker compose file from GitHub. You can make it by running the following command:

curl -LO https://raw.githubusercontent.com/reportportal/reportportal/master/docker-compose.yml

Open docker-compose.yml and set a strong admin password:

services:
  uat:
    environment:
      RP_INITIAL_ADMIN_PASSWORD: "YourSecurePass"

2. Start the application using the following command:

docker-compose -p reportportal up -d --force-recreate

For detailed instructions, advanced configuration, backup/restore, and production recommendations, see the full guide: How to deploy with Docker.

Step 2

Launch ReportPortal

If you deploy ReportPortal on a separate host, use:

http://IP_ADDRESS:8080

Otherwise, open ReportPortal and login.

Important!

ReportPortal is ready for login when you see a list of services (API Service, Jobs Service, Authorization Service, Service UI) at the bottom of the Login Page.

Use the following credentials:

For user access:

Password:1q2w3e

For admin access:

Password:erebus

Please change admin password for security reasons.

Step 3

Integrate with your test framework

Integration scheme:

Choose needed integration by language:

Java

.NET

JavaScript

Python

PHP

Other

from contributor

from contributor

If there is no integration with your test framework, you can make it on your own.

Please don’t forget to share your integration. We really appreciate your contribution to ReportPortal development. Examples of contributions you can find at Github page.