Installation guide

Discover 3 pathways to install ReportPortal with

Docker

Kubernetes

Google CM

Install Docker

Download and install Docker. It’s supported by all major Linux distributions, MacOS and Windows.

Important!

Recommended change resources limits at least 2 CPU 6 GB RAM for Docker
Desktop: MAC |Windows |Linux
We strongly recommend to deploy in Linux based environment

For Windows users Docker requires 64-bit Windows 10 Pro (or higher) and Microsoft Hyper-V

Instead of using Docker for deployment you can follow the steps described here.

Details about production deployment and system capacity are here.

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

Ensure you override the UAT Service environment variable RP_INITIAL_ADMIN_PASSWORD

2. Start the application using the following command:

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

Where:

-p reportportal — adds project prefix 'reportportal' to all containers

up — creates and starts containers

-d — daemon mode

--force-recreate — re-creates containers

Useful commands

docker-compose logs — shows logs from all containers
docker logs <container_name> — shows logs from selected container

docker ps -a | grep "reportportal_" | awk '{print $1}' | xargs
docker rm -f

— deletes all ReportPortal containers

For a more comprehensive installation guide, please refer to the link.

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.