[opensourcedex]

allure-docker-service is a free, open source business intelligence & reporting project written in Python and released under Apache-2.0. It has 750 GitHub stars, 208 forks and 44 open issues, and was last pushed 2 months ago. On this registry it ranks #30 of 34 tracked projects in Business Intelligence & Reporting, with 5 head-to-head comparisons available.

What is allure-docker-service?

What it is

Allure Docker Service is an open-source Docker container for viewing up-to-date Allure reports from automated tests. It lives in the Allure testing ecosystem, a Python-based Apache-2.0 project tagged with topics such as allure, allure-docker, docker-compose, and allure-api. It is intended for report viewing without repeatedly installing and running the Allure server manually on Jenkins or a local machine.

The concrete problem it solves is the tedious setup of report generation after each test run. A user can mount an allure-results directory for a single project or a projects directory for multiple projects, and the container detects new results and generates a new report automatically. This gives teams a persistent report viewer for local or remote use, while also providing an API workflow for sending results and triggering report generation.

Key capabilities

  • Mounts an allure-results directory for a single project or a projects directory for multiple projects.
  • Detects new Allure results and generates a new report automatically.
  • Supports Docker and Docker Compose usage for local and remote report viewing.
  • Exposes Allure API endpoints for sending results, project management, and report actions.
  • Accepts result submission with application/json and multipart/form-data content types.
  • Offers options for version switching, port switching, TLS, security, login, roles, custom URL prefixes, and multi-instance setups.
  • Supports emailable reports, native full report export, CSS overrides, title overrides, and custom templates.

Who uses it and how

  • Automation test users mount a local allure-results directory to browse current reports without running the Allure server manually.
  • Multiple-project users mount a projects directory and create projects through the API or usage flow.
  • API users send results through the Allure API and use the service to generate or refresh reports.
  • Docker Compose and Kubernetes deployments provide local development or remote report viewing.

Getting started

Pull the frankescobar/allure-docker-service image from Docker Hub, mount allure-results or projects, and open the report through the container. The README also describes Docker Compose and Kubernetes deployment options.

When to use it — and when not to

Use it when you need a self-hosted Docker viewer for Allure results that updates automatically and supports API-based result submission. It is not listed as a replacement for a paid product, so the comparison is mainly against manually running the Allure server or building a custom report host. A self-hoster must operate the container, mounted result directories, and any enabled security, TLS, or API access; the project also lists 44 open issues, known issues, a deprecated port, and an ongoing transition to a new open-source version.

project readme (upstream, from github) — read inline

ALLURE DOCKER SERVICE

[!IMPORTANT]

ANNOUNCEMENT

We are developing a new open-source version designed to resolve known issues and introduce significant enhancements related to UI, functionality, and data processing. While this transition will take time, we are prioritizing development to get a build ready for our testers as soon as possible.

Table of contents

FEATURES

Allure Framework provides you good looking reports for automation testing. For using this tool is required to install a server. You could have this server running on Jenkins or if you want to see reports locally, you need to run some commands on your machine. This work results tedious, at least for me :)

For that reason, this docker container allows you to see up to date reports simply mounting your allure-results directory (for a Single Project) or your projects directory (for Multiple Projects). Every time appears new results (generated for your tests), Allure Docker Service will detect those changes and it will generate a new report automatically (optional: send results / generate report through API), what you will see refreshing your browser.

  • Useful for developers who wants to run tests locally and want to see what were the problems during regressions.
  • Useful for the team to check the tests status for every project.

Docker Hub

Docker Versions

Docker container versions are based on binary Allure 2 releases

Image Variants

Allure Docker Service supports architectures amd64, arm32v7 and arm64v8.

The following table shows the variation of provided images.

Base Image Arch OS
amd64/eclipse-temurin:11-jre-noble amd64 ubuntu
arm32v7/eclipse-temurin:11-jre-noble armv7 ubuntu
arm64/eclipse-temurin:11-jre-noble arm64 ubuntu

The following table shows the provided Manifest Lists.

Tag allure-docker-service Base Image
latest, 2.44.0 frankescobar/allure-docker-service:2.44.0-amd64
frankescobar/allure-docker-service:2.44.0-armv7
frankescobar/allure-docker-service:2.44.0-arm64

USAGE

Generate Allure Results

First at all it's important to be clear. This container only generates reports based on results. You have to generate allure results according to the technology what are you using.

Reference: https://github.com/fescobar/allure-docker-service-examples

We have some examples projects:

In this case we are going to generate results using the java project allure-docker-java-testng-example of this repository.

Go to directory allure-docker-java-testng-example via command line:

cd allure

readme truncated — read the full docs on github

Frequently asked questions

Is allure-docker-service free to use?

allure-docker-service is open source under the Apache-2.0 licence. There is no licence fee and no seat count — you can self-host it or, where the project offers one, pay a vendor for a managed version instead.

What does allure-docker-service do?

This docker container allows you to see up to date reports simply mounting your "allure-results" directory in the container (for a Single Project) or your "proj

What is allure-docker-service written in?

allure-docker-service is primarily written in Python. Its source is publicly available at https://github.com/fescobar/allure-docker-service, and it has 750 GitHub stars.