The official Docker image for Doc Detective, a documentation testing framework that makes it easy to keep your docs accurate and up-to-date. This image provides a pre-configured environment with all the dependencies needed to run Doc Detective tests without having to install Node.js or other prerequisites locally.

• Pre-installed with Node.js and Doc Detective
• Includes Google Chrome and Firefox for browser-based tests
• Includes DITA Open Toolkit (DITA-OT) for DITA content transformation
• Optimized for CI/CD pipelines and containerized environments
• Simple volume mounting for working with your local test files

Note: This image runs Doc Detective in a headless mode and isn't compatible with the record step. If you need to record test runs, use the Doc Detective CLI directly in your local environment.

Run Doc Detective tests in the current directory:

docker run --rm -v .:/app docdetective/docdetective

This command:

• Mounts your current directory to /app in the container
• Runs Doc Detective on any test files in that directory
• Automatically cleans up the container after execution (--rm)

To run tests from a specific file:

docker run --rm -v .:/app docdetective/docdetective --input my-tests.spec.json

If you have a custom .doc-detective.json config file:

docker run --rm -v .:/app docdetective/docdetective --config .doc-detective.json

To pass environment variables to your tests:

docker run --rm -v .:/app -e API_KEY=your_key docdetective/docdetective

You can pass any Doc Detective arguments to the container:

docker run --rm -v .:/app docdetective/docdetective --input tests.spec.json --output results.json

• latest: The most recent stable release

If you want to build the Docker image locally:

git clone https://github.com/doc-detective/docker-image.git
cd docker-image/linux
npm run build

This project uses the AGPL-3.0 license.