LogoLogo
diffblue.comFree trial
  • Discover Diffblue Cover
  • Get Started
    • What is Diffblue Cover?
    • Get started
      • Free trial
      • Get started - Cover Plugin
      • Get started - Cover CLI
      • Get started - Cover Pipeline
      • Get started - Cover Reports
    • Specs & Reqs
    • Reference Deployments
    • Licensing
      • Online license activation
      • Offline license activation
      • Diffblue License Manager
    • Update Cover
    • FAQs
    • Diffblue Learning
      • Get started
        • Just the basics
        • Free trial
        • Cover Plugin (IDE)
        • Cover CLI (Command Line)
      • Developer
        • Unit tests (IDE)
        • Unit tests (CLI)
        • Test coverage
      • DevOps
        • GitHub
        • GitLab
        • Other CI
      • Administrator
        • Admin - IntelliJ
        • Admin - CLI
        • Admin - Reports
      • Test coverage
        • Developer
        • Senior developer
        • Cover Reports Administrator
  • EVALUATION & ONBOARDING
    • Proof of Value
    • Jumpstart
      • Prerequisites for onboarding
      • Phase 1: Up and running
        • Module 1: Create your Cover unit test baseline
        • Module 2: Cover Pipeline CI integration
      • Phase 2: Developer productivity
        • Module 3: Getting started using Cover
        • Module 4: Introduction to Cover Reports
      • Phase 3: Advanced topics
        • Module 5: Speed up your test execution
        • Module 6: Getting more from Cover
  • Features
    • Cover Plugin
      • Writing tests
        • Gutter icons
        • Menu options
        • Run configurations
        • Cover Plugin tool window
        • Test Review
        • Test examples
        • Creating partial tests
        • Creating skeleton tests
        • Covering all enum values
        • Test insertion order
        • Diffblue Sandbox
        • Environment Check Cache
      • Project configuration
        • General dependencies
        • Test framework dependencies
      • Cover Plugin settings
        • Test Naming
        • Test Formatting
        • Spring configuration options
        • Method Annotations
        • Test Directory
        • Reset Cover Plugin settings
      • Cover Plugin admin
        • Core Maintenance
        • Cover Plugin toolbar menu
        • Cover Plugin status bar widget
        • Telemetry
        • Memory management
        • Using SonarQube with Cover Plugin
        • Log files
        • Troubleshooting
    • Cover CLI
      • Writing tests
        • Command summary
        • Test examples
        • Creating partial tests
        • Customizing test inputs
        • Customizing test setup
        • Test naming
        • Test formatting
        • Test insertion order
        • Patch files
        • Diffblue Sandbox
        • Operational behaviors
        • Test validation
      • Project configuration
        • Preflight checks
        • General dependencies
        • Test framework dependencies
        • Compiling your project successfully
          • Building a Maven project
          • Building a Gradle project
        • Configuring Cover to work with your project's build system
          • Quick guide
          • Configuration file in detail
          • Getting Started with Ant Projects
          • Default configuration
        • Mocking using Mockito
        • Spring profiles
        • Runtime environment
      • Commands & Arguments
        • Environment configuration for CI
        • Packages, classes, and methods
        • Quoting command line arguments
        • Argument files
      • Cover CLI admin
        • Core Maintenance
        • Telemetry
        • Memory management
        • Using Cover CLI in Eclipse
        • Using SonarQube with Cover CLI
        • Log files
        • Troubleshooting
      • Environment Configuration
    • Cover Pipeline
      • Cover Pipeline for CI
        • Quick Start - General
        • Quick Start - Jenkins
        • Quick Start - Azure Pipelines
        • Quick Start - AWS Codebuild
        • Integrating Diffblue Cover into CI on pull requests
        • Installation - VMs or CI run
      • Cover Pipeline for GitLab
        • Introduction
        • Installation and initial setup
        • GitLab workflow
        • Configuration
        • Troubleshooting
        • Related topics
      • Cover Pipeline for GitHub
        • Introduction
        • Installation and initial setup
        • GitHub workflow
        • Configuration
        • Troubleshooting
        • Related topics
    • Cover Reports
      • Cover Reports Contributor
        • Java project config (JaCoCo)
        • Generate and upload reports bundles
        • Authenticated uploads
      • Cover Reports User
        • Navigation
        • Dashboards
        • Telemetry data
        • Export API
        • Considerations
      • Cover Reports Administrator
        • Install and update Cover Reports
        • Configuration options
        • Database backup
        • SSO with Cover Reports
        • Uninstall Cover Reports
    • Cover Optimize
      • Get started - Cover Optimize
      • Cover Optimize & Gradle
      • Cover Optimize & Maven
      • Patch files
    • Cover Refactor
      • Get started - Cover Refactor
    • Cover Annotations
      • Mocking Annotations
      • Custom Input Annotations
      • Interesting Value Annotations
    • Output Codes
      • E - Environment Codes
      • L - License Codes
      • R - Reason Codes
      • T - Testability Codes
      • V - Validation Codes
      • Working with output codes
        • Working with code E020
        • Working with codes E057 to E065
        • Working with code E085
        • Working with code R005
        • Working with code R006
        • Working with code R008
        • Working with code R011
        • Working with code R012
        • Working with code R013
        • Working with code R026
        • Working with code R031
        • Working with code V003
    • Tutorials
      • How to measure test quality
      • How to improve code coverage
      • How to test a new feature
      • How to find regressions
      • How to use Diffblue Cover in test driven development (TDD)
      • How to write tests for Kotlin projects
      • Examples of tests created by Diffblue Cover
      • Best practices for testing private methods
  • Updates & Upgrades
    • Update Cover
    • Cover Editions
    • What's new
    • Release archive
      • 2025-05-01
      • 2025-04-02
      • 2025-04-01
      • 2025-03-02
      • 2025-03-01
      • 2025-02-02
      • 2025-02-01
      • 2025-01-02
      • 2025-01-01
      • 2024-12-02
      • 2024-12-01
      • 2024-11-02
      • 2024-11-01
      • 2024-10-02
      • 2024-10-01
      • 2024-09-02
      • 2024-09-01
      • 2024-08-02
      • 2024-08-01
      • 2024-07-04
      • 2024-07-03
      • 2024-07-01
      • 2024-06-02
      • 2024-06-01
      • 2024-05-02
      • 2024-05-01
      • 2024-04-02
      • 2024-04-01
      • 2024-03-02
      • 2024-03-01
      • 2024-02-02
      • 2024-02-01
      • 2024-01-02
      • 2024-01-01
      • 2023-12-02
      • 2023-12-01
      • 2023-11-03
      • 2023-11-02
      • 2023-11-01
      • 2023-10-02
      • 2023-10-01
      • 2023-09-02
      • 2023-09-01
      • 2023-08-02
      • 2023-08-01
      • 2023-07-03
      • 2023-07-02
      • 2023-07-01
      • 2023-06-02
      • 2023-06-01
      • 2023-05-02
      • 2023-05-01
      • 2023-04-02
      • 2023-04-01
      • 2023-03-02
      • 2023-03-01
      • 2023-02-02
      • 2023-02-01
      • 2023-01-02
      • 2023-01-01
      • 2022-12-02
      • 2022-12-01
      • 2022-11-02
      • 2022-11-01
      • 2022-10-03
      • 2022-10-02
      • 2022-10-01
      • 2022-09-02
      • 2022-09-01
      • 2022-08-05
      • 2022-08-03
      • 2022-08-02
      • 2022-08-01
      • 2022-07-02
      • 2022-07-01
      • 2022-06-02
      • 2022-06-01
      • 2022-05-02
      • 2022-05-01
      • 2022-04-02
      • 2022-04-01
      • 2022-03-02
      • 2022-03-01
      • 2022-02-02
      • 2022-02-01
      • 2022-01-02
      • 2022-01-01
      • 2021-06-02
      • 2021-02-01
  • Legal
    • Diffblue Legal
      • Diffblue End User License Agreement (EULA)
      • Cover Third Party Notices and/or Licenses
      • Privacy Notice
Powered by GitBook
On this page
  • Prerequisites
  • Docker Install
  • Zip Install (Windows, macOS, Linux)
  • Exe Install (Windows)
  • Updating Cover Reports

Was this helpful?

Export as PDF
  1. Features
  2. Cover Reports
  3. Cover Reports Administrator

Install and update Cover Reports

PreviousCover Reports AdministratorNextConfiguration options

Last updated 1 month ago

Was this helpful?

Prerequisites

Specific Cover Reports prerequisites are listed below - see Specs & Reqs for full details.

Server hosting Cover Reports - Cover Reports Administrator:

  • 4GB RAM (8GB recommended), 2GB* minimum available disk space, 4 CPU cores.

  • 2GB Java heap allocation, 4GB recommended.

  • Docker Install - Docker Engine 20.10.17, Docker Compose v2.10.2, and if you're using Docker Hub you'll also need an internet connection.

  • Zip Install & Windows Installer - Java JDK 17+ (and available in your PATH system environment variable). For production use, you'll also need to provide a vanilla PostgreSQL 14 database (see ).

  • Windows Install - Windows Server 2019 and above, Windows 10 and above.

  • All - Network connectivity between the server(s) and client workstations. Note that if the Cover Reports server and database server are on different hosts, good network connectivity between them will ensure good performance.

* Note that the database server will store the data uploaded to Cover Reports. Sufficient storage should be ensured for projected usage.

Client workstation - Cover Reports Contributor:

  • Diffblue Cover CLI. The version of the CLI should correspond with the version of Reports to ensure the optimum experience.

  • JaCoCo 0.8.3+

  • Network connectivity between the user's workstation and the Cover Reports server.

Client workstation - Cover Reports User:

  • The latest version of Chrome, Edge, Safari, or Firefox with a screen resolution of 1920 x 1080 or higher.

  • Network connectivity between the user's workstation and the Cover Reports server.

Docker Install

  1. From the directory containing the Cover Reports .tar.gz file, load the Docker bundle:

docker load -i /path/diffblue-cover-reports-<version>.tar.gz
  1. From the $COVER_REPORTS_HOME directory, start Cover Reports:

docker compose up -d
  1. Finally, open a browser on a client PC that has access to the Cover Reports server and navigate to the Cover Reports Home Page (<HOSTURL>:8080). To change the default port see Configuration options.

docker login -u <username> <password_or_token>
  1. From the $COVER_REPORTS_HOME directory, start Cover Reports:

docker compose up -d
  1. Finally, open your browser and navigate to the Cover Reports Home Page (<HOSTURL>:8080). To change the default port see Configuration options.

Zip Install (Windows, macOS, Linux)

As an alternative, Cover Reports can be installed using the zip archive. This provides for running Cover Reports as a Windows Service, Linux Service, Windows .bat, or macOS/Linux .sh, and removes the need to use Docker. This also provides various database configuration options to provide further flexibility.

To install Cover Reports from the Zip archive:

  1. Using the link provided by Diffblue, download the Cover Reports .zip file - for example, diffblue-cover-reports-2023.10.02.zip

  2. In your shell, navigate to your preferred install directory (we'll now refer to this as $COVER_REPORTS_HOME). This will be the home directory of Cover Reports.

  3. Extract the contents of diffblue-cover-reports-2023.10.02.zip into the $COVER_REPORTS_HOME directory.

  4. Install and start the service or run the script as needed.

To install Cover Reports as a service on a Windows host, open a terminal, navigate to the windows-service folder in your Cover Reports install, and run cover-reports.exe install

Once the service has been installed, you can start and stop the Cover Reports service using the Windows Service Manager.

For a Linux host that uses systemd, you can start and stop the Cover Reports service using systemctl.

From the $COVER_REPORTS_HOME directory, start Cover Reports using the bin/cover-reports script for your operating system:

  • bin/cover-reports.bat for Windows

  • bin/cover-reports for macOS/Linux

  1. Once installation is complete, review and set up your configuration options - see Configuration options for details.

Exe Install (Windows)

Cover Reports can be installed on Windows using the combined Cover CLI & Cover Reports installer.

  1. Using the link provided by Diffblue, download the combined Cover CLI & Cover Reports - for example, diffblue-cover-installer-2023.10.02.exe

  2. Run the installer and follow the on screen prompts - note that to install Cover Reports, make sure that the Cover Reports option is selected during the install.

  3. Install and start the service or run the script as needed.

To install Cover Reports as a service on a Windows host, open a terminal, navigate to the windows-service folder in your Cover Reports install, and run cover-reports.exe install

Once the service has been installed, you can start and stop the Cover Reports service using the Windows Service Manager.

From the $COVER_REPORTS_HOME directory, start Cover Reports using the bin/cover-reports.bat script. Note that during install this script is automatically added to your PATH system variable and can be accessed via a command line.

  • Once installation is complete, review and set up your configuration options - see Configuration options for details.

Updating Cover Reports

Cover Reports update/upgrade details are provided below. Note that before you update Cover Reports, Diffblue recommends that you perform a database backup first - see Database backup.

Updating Cover Reports may take some time to complete. During this time you won't be able to upload new reports bundles and the Reports URL won't be accessible.

Cover Reports does not support downgrades. It is not possible to deploy an older version of Reports once it has been upgraded - even in case of failure.

On your Cover Reports server:

  1. Stop Cover Reports by running: docker compose down

  2. In your shell, navigate to the $COVER_REPORTS_HOME directory where the existing installation is located and make a copy (backup) of the directory.

  3. Rename the docker-compose.yml file in the $COVER_REPORTS_HOME directory - e.g. docker-compose-2023.08.13.yml

  4. Using the link provided by Diffblue, download Cover Reports: - For Cover Reports Docker Compose, download the docker-compose.yml file to the $COVER_REPORTS_HOME directory. - For Cover Reports .tar.gz, download the latest Cover Reports bundle (e.g. diffblue-cover-reports-2023.08.01.tar.gz) and load the Docker bundle: docker load -i /path/diffblue-cover-reports-<version>.tar.gz

  5. Start the new version of Cover Reports using the command: docker compose up -d

  1. Make a copy of your custom files as needed - application.properties, cover-reports.xml, cover-reports.service

  2. Using the link provided by Diffblue, download the latest Cover Reports .zip bundle to your Cover Reports install directory.

  3. Stop Cover Reports (if currently running).

  4. In your shell, navigate to the Cover Reports install directory and extract the contents of the downloaded zip file.

  5. Add your custom files back to the updated installation.

  6. Restart Cover Reports.

Windows:

  1. Using the link provided by Diffblue, download the combined Cover CLI & Cover Reports - for example, diffblue-cover-installer-2023.10.02.exe

  2. Run the installer and follow the on screen prompts - note that to install Cover Reports, make sure that the Cover Reports option is selected during the install.

  3. Restart the Cover Reports service.

How to deal with problems during an upgrade

The upgrade process is designed to occur automatically during deployment of a new version. In case an error occurs during an upgrade:

  1. Stop the Reports application

If Reports must be available for use while this problem is investigated:

  1. Restore the database backup created immediately prior to the failed upgrade

  2. Restart the previously installed version of Reports

Using the link provided by Diffblue, download the Cover Reports .tar.gz file (e.g. diffblue-cover-reports-2023.07.02.tar.gz) to the server you plan to use to host Cover Reports. Contact if you don't have the download link.

In your shell, navigate to your preferred install directory (we'll now refer to this as $COVER_REPORTS_HOME). Using the link provided by Diffblue, download the Cover Reports Docker Compose file docker-compose.yml to $COVER_REPORTS_HOME. Contact if you don't have the download link.

To access the repository please and provide with your username. Diffblue Support will grant access according to your subscription terms.

In your shell (from the server you plan to use to host Cover Reports), log in to Docker Hub using the docker login command with either your username and password or username and , for example:

In your shell, navigate to your preferred install directory (we'll now refer to this as $COVER_REPORTS_HOME). Using the link provided by Diffblue, download the Cover Reports Docker Compose file docker-compose.yml to $COVER_REPORTS_HOME. Contact if you don't have the download link.

Contact and provide the log files from the report-web application

Diffblue Support
Diffblue Support
sign up to Docker Hub
Diffblue Support
Docker Hub Access Token
Diffblue Support
Diffblue Support
Using an external database server