Docker

The published image is jaredwray/mockhttp on Docker Hub. It runs the Node.js server and the documentation site in one container. The latest tag is linux/amd64 only. Apple Silicon runs it under emulation. On arm64 Linux, build the image from this repository instead.

Table of Contents

• Run the image
• Docker Compose
• Environment variables
• Build the image
• Publish to Docker Hub

Run the image

docker run -d -p 3000:3000 jaredwray/mockhttp

The server listens on port 3000. Open http://localhost:3000/get for a mock response, http://localhost:3000/docs for these guides, and http://localhost:3000/api for the OpenAPI reference.

pnpm docker:run is docker run -p 3000:3000 jaredwray/mockhttp. It stays in the foreground. Docker pulls the Hub image when it is not already local.

Rate limiting is on: 1000 requests per minute. The allow list is only 127.0.0.1 and ::1. A published port delivers traffic from the Docker bridge address, not from loopback inside the container, so those requests count against the limit. None of the environment variables below turn it off. Change or disable it with the library rateLimit option. A test suite that sends more than 1000 requests a minute to the published port will get 429 responses.

Docker Compose

services:
  mockhttp:
    image: jaredwray/mockhttp:latest
    ports:
      - "3000:3000"

The Compose file in this repository publishes port 3001 and sets PORT so the process listens on that same port:

services:
  mockhttp:
    image: jaredwray/mockhttp:latest
    ports:
      - "3001:3001"
    environment:
      - PORT=3001

pnpm docker:compose:up and pnpm docker:compose:down call the docker-compose binary. Current Docker installs often provide docker compose instead, which you can run against the same file.

Environment variables

The container starts node dist/index.mjs. That process reads these variables:

HTTPS certificates are configured in the library, not through container environment variables. Put a TLS proxy in front of the container when you need HTTPS.

Build the image

The Dockerfile copies node_modules, package.json, public/, dist/, and site/dist/ from the build context. Build the package and the docs site before docker build.

pnpm install
pnpm build
pnpm website:build
docker build -t jaredwray/mockhttp .
docker run -d -p 3000:3000 jaredwray/mockhttp

pnpm docker:build is the docker build step. The image is based on Node.js 24 Alpine, runs as the node user, exposes port 3000, and starts node dist/index.mjs.

Publish to Docker Hub

.github/workflows/docker-publish.yaml runs on the released event (a published release, not a prerelease) and when the workflow is started by hand. It builds jaredwray/mockhttp:<version> and jaredwray/mockhttp:latest with docker build on ubuntu-latest, pushes both tags, and updates the Docker Hub description from DOCKER.md. That build is linux/amd64.

The same Node server can run on Wasmer Edge. The public site at mockhttp.org is the Cloudflare Worker, not this image.