Docker

proxyaudit is published on Docker Hub and GHCR. The entrypoint is the proxyaudit binary itself, so any CLI command works after the image name.

Quick start

docker run --rm ghcr.io/cerberauth/proxyaudit scan https://proxy.example.com

docker run --rm cerberauth/proxyaudit scan https://proxy.example.com

Writing a report to a mounted volume

--output needs the destination path to exist inside the container. Mount a host directory as a volume and reference the in-container path:

docker run --rm -v "$(pwd)":/data ghcr.io/cerberauth/proxyaudit \
  scan https://proxy.example.com --output /data/report.json

Scanning a proxy running in another container

Caution

Only run proxyaudit scan against systems you own or have explicit written permission to test.

Join the target’s network so proxyaudit can reach it by service name or localhost:

docker run --rm --network container:proxy ghcr.io/cerberauth/proxyaudit \
  scan http://localhost:8080

Docker Compose

Run proxyaudit as a one-off step alongside the proxy under test:

services:
  proxy:
    build: .
    ports:
      - '8080:8080'

  proxyaudit:
    image: ghcr.io/cerberauth/proxyaudit
    depends_on:
      - proxy
    volumes:
      - ./reports:/data
    command: ['scan', 'http://proxy:8080', '--output', '/data/report.json']

docker compose run --rm proxyaudit

Build from source

1. Clone the repository:

   git clone https://github.com/cerberauth/proxyaudit.git
   cd proxyaudit

2. Build the image using the dev Dockerfile:

   docker build -f .docker/Dockerfile-build -t proxyaudit .

3. Run it:

   docker run --rm proxyaudit scan https://proxy.example.com

GitHub Actions

To run proxyaudit in CI without pulling the image manually, see the GitHub Actions guide. To use the container image directly in a workflow step:

- name: Scan proxy configuration
  run: docker run --rm ghcr.io/cerberauth/proxyaudit scan ${{ vars.STAGING_URL }}