mockoon/pro repository overview

⁠Mockoon Pro

Mockoon Pro brings collaborative API mocking to your private infrastructure, sovereign cloud, on-premises servers, or air-gapped network. The official mockoon/pro image packages the Mockoon Pro API, administration dashboard, embedded web application, real-time synchronization, and mock deployment orchestration in a single container.

All application state is stored in one mounted /data directory. No external database is required, license validation is fully offline, and Mockoon Pro collects no telemetry or analytics.

⁠Features

• Real-time mock API synchronization and team collaboration
• Embedded browser-based Mockoon application
• Private mock API deployments on wildcard subdomains
• Local user accounts, invitations, roles, and OpenID Connect SSO
• Administrative dashboard and audit trail
• SQLite-backed persistence with no external database dependency
• Offline cryptographic license validation with no phoning home
• Docker, Docker Compose, Kubernetes, and OpenShift support

⁠Quick start

For local evaluation, run:

docker run -d \
  --name mockoon-pro \
  -p 5020:5020 \
  -e NODE_ENV=production \
  -e PORT=5020 \
  -e MOCKOON_DOMAIN=localhost \
  -e MOCKOON_SERVER_ID=mockoon-pro-local \
  -e MOCKOON_STORAGE_DIR=/data/ \
  -v mockoon-pro-data:/data \
  mockoon/pro:latest

Open http://localhost:5020⁠ and complete the setup wizard. You will need a valid Mockoon Pro license key to activate the instance.

Get a free trial key⁠

⁠Docker Compose

services:
  mockoon-pro:
    image: mockoon/pro:latest
    container_name: mockoon-pro
    restart: unless-stopped
    ports:
      - '5020:5020'
    environment:
      NODE_ENV: production
      PORT: 5020
      MOCKOON_DOMAIN: mockoon.company.com
      MOCKOON_SERVER_ID: mockoon-pro-prod
      MOCKOON_STORAGE_DIR: /data/
      USE_HTTPS: 'true'
    volumes:
      - mockoon-pro-data:/data

volumes:
  mockoon-pro-data:

For production, place the container behind a reverse proxy or load balancer that terminates TLS and forwards traffic to port 5020.

⁠Production requirements

Mockoon Pro uses the configured base domain for its dashboard, API, real-time synchronization, and deployed mock instances. A production deployment requires:

• A DNS record for the base domain, such as mockoon.company.com
• A wildcard DNS record, such as *.mockoon.company.com, pointing to the same deployment
• TLS coverage for both the base domain and wildcard subdomains
• Persistent storage mounted at /data
• A unique, stable MOCKOON_SERVER_ID

Dynamic mock APIs are served on subdomains such as users.mockoon.company.com and payments.mockoon.company.com.

⁠Configuration

Do not set development license public-key variables in production.

⁠Persistent data

Mount persistent storage at /data. This directory contains the SQLite database, settings, users, license information, synchronized mock environments, and deployment state.

Back up this volume before upgrades. Do not run multiple container replicas against the same SQLite data directory.

⁠Health check

The container exposes an unauthenticated health endpoint:

GET /health

A healthy instance returns:

{"status":"ok"}

⁠Licensing

Mockoon Pro is commercial, proprietary software and requires a signed paid or trial license key, entered during the first-run setup wizard. License validation is performed locally and does not contact Mockoon servers. The license defines the plan, expiration date, and total capacity available for allocation between team members and deployed mock instances.

Purchase a license or request a trial at mockoon.com/pro⁠.

⁠Updating

Because all persistent state lives in /data, updates only require pulling and recreating the container:

docker pull mockoon/pro:latest
docker stop mockoon-pro
docker rm mockoon-pro

Then run the container again with the same environment variables and /data volume. For production deployments, pin a version tag and back up the data volume before upgrading.

⁠Documentation and support

• Mockoon Pro documentation⁠
• Installation guide⁠
• Initial setup and licensing⁠
• Contact the Mockoon team⁠

Mockoon Pro is not distributed under Mockoon's open-source license. The separate public mockoon/mockoon⁠ project remains available under its own open-source license, but that license does not apply to this image or the Mockoon Pro software it contains.