Skip to navigation

docker-image (alpha)

This repo is in alpha. It’s not ready for production use.

docker-image runs Doc Detective in a container. Doc Detective runs on most machines as-is. This Docker image simplifies installing and running it on machines without Node.js, or with heightened security requirements.

Supported platforms

Doc Detective publishes the Docker image as a multi-architecture manifest, so docker pull automatically selects the right image for your system:

PlatformArchitectures
Linuxamd64 (x86_64), arm64 (Apple Silicon, Amazon Web Services Graviton, Raspberry Pi)
Windowsamd64 (x86_64) only

Existing tags (latest, linux, windows, version-scoped tags) work the same way. Arm64 Linux hosts receive native images without any tag changes.

Chrome and ChromeDriver aren’t available on the linux/arm64 image. Google’s Chrome for Testing publishes only x64 binaries, with no native linux/arm64 build. They’re skipped rather than failing when the image warms its runtime assets. Firefox works on both architectures. To run Chrome-driven tests on an arm64 host, run the linux/amd64 image under emulation, or use Firefox instead.

What’s included

The Docker image includes:

  • Node.js and Doc Detective: The core testing framework
  • Python 3: Python interpreter (3.11.2 on Linux, 3.13.1 on Windows) with pip and venv for running Python scripts via the runCode action
  • Browsers: Firefox for browser-based tests on every architecture, plus Google Chrome on amd64 (Chrome has no native linux/arm64 build)
  • DITA-OT: DITA Open Toolkit for DITA content transformation
  • Java Runtime: Required for DITA-OT operations

This repo depends on doc-detective for performing the tests.