Skip to content

πŸ“¦ Container DeploymentΒΆ

You can run ContextForge as a fully self-contained container. This is the recommended method for production or platform-agnostic deployments. You can use any container engine (ex: Docker or Podman).


Quick Start (Pre-built Container Image)ΒΆ

If you just want to run the gateway using the official OCI container image from GitHub Container Registry:

docker run -d --name mcpgateway \
  -p 4444:4444 \
  -e HOST=0.0.0.0 \
  -e JWT_SECRET_KEY=my-test-key-but-now-longer-than-32-bytes \
  -e JWT_AUDIENCE=mcpgateway-api \
  -e JWT_ISSUER=mcpgateway \
  -e AUTH_REQUIRED=true \
  -e PLATFORM_ADMIN_EMAIL=admin@example.com \
  -e PLATFORM_ADMIN_PASSWORD=changeme \
  -e PLATFORM_ADMIN_FULL_NAME="Platform Administrator" \
  -e DATABASE_URL=sqlite:///./mcp.db \
  ghcr.io/ibm/mcp-context-forge:1.0.0-RC-3

docker logs mcpgateway

You can now access the UI at http://localhost:4444/admin using email/password authentication.

Authentication

The Admin UI uses email/password authentication (PLATFORM_ADMIN_EMAIL/PASSWORD). Basic auth for API endpoints is disabled by default for security. Use JWT tokens for API access.

Multi-architecture containersΒΆ

Note: the container build process creates container images for 'amd64', 'arm64', 's390x', and 'ppc64le' architectures. The version ghcr.io/ibm/mcp-context-forge:VERSION points to a manifest so that all commands will pull the correct image for the architecture being used (whether that be locally or on Kubernetes or OpenShift).

If the specific image is needed for one architecture on a different architecture use the appropriate arguments for your given container execution tool:

With docker run:

docker run [... all your options...] --platform linux/arm64 ghcr.io/ibm/mcp-context-forge:VERSION

With podman run:

podman run [... all your options...] --platform linux/arm64 ghcr.io/ibm/mcp-context-forge:VERSION
Or
podman run [... all your options...] --arch arm64 ghcr.io/ibm/mcp-context-forge:VERSION

🐳 Build the Container¢

make podman

Using Docker (manual alternative)ΒΆ

docker build -t mcpgateway:latest -f Containerfile.lite .

The container images are based on Red Hat UBI 10 with Python 3.12 and run Gunicorn with Uvicorn workers.

Build StagesΒΆ

All container builds include a Node.js stage that compiles Tailwind CSS from source. This removes the need for the Tailwind CDN and eliminates unsafe-eval from the Content Security Policy for Tailwind-related assets.

Stage Image Purpose
frontend-builder node:lts-alpine Builds the Admin UI Vite bundle (JS/CSS)
node-builder ubi10/nodejs-24 Compiles tailwind.src.css β†’ tailwind.min.css
rust-builder (lite only) ubi10/ubi Builds optional Rust native extensions
builder ubi10/ubi Installs Python dependencies into a venv
runtime ubi10-minimal or scratch Final runtime image

The Node.js builder uses the official Red Hat UBI10 Node.js 24 image (registry.access.redhat.com/ubi10/nodejs-24). It is a temporary build stage and does not affect the final runtime image size.

Required files for the CSS build:

  • package.json / package-lock.json β€” Node.js dependencies
  • tailwind.config.js β€” Tailwind configuration with content paths
  • postcss.config.js β€” PostCSS configuration
  • mcpgateway/static/css/tailwind.src.css β€” Source CSS file
  • mcpgateway/templates/**/*.html β€” Templates scanned for Tailwind classes
  • mcpgateway/static/**/*.js β€” JavaScript files scanned for classes

Local development (without Docker):

# Install Node.js dependencies
npm install

# Build CSS once
make build-css

# Or watch for changes during development
make watch-css

πŸ”’ Airgapped DeploymentsΒΆ

For environments without internet access, you can build a container with all UI assets bundled locally.

Build Airgapped ContainerΒΆ

Use Containerfile.lite which automatically downloads CDN assets during build:

docker build -f Containerfile.lite -t mcpgateway:airgapped .

This downloads and bundles:

  • Tailwind CSS (~404KB)
  • HTMX (bundled in main JS via npm/Vite)
  • CodeMirror (~216KB)
  • Alpine.js (~48KB)
  • Chart.js (~208KB)

Total: ~932KB of UI assets

Run in Airgapped ModeΒΆ

docker run -d --name mcpgateway \
  -p 4444:4444 \
  -e MCPGATEWAY_UI_AIRGAPPED=true \
  -e MCPGATEWAY_UI_ENABLED=true \
  -e MCPGATEWAY_ADMIN_API_ENABLED=true \
  -e HOST=0.0.0.0 \
  -e JWT_SECRET_KEY=my-test-key-but-now-longer-than-32-bytes \
  -e AUTH_REQUIRED=true \
  -e PLATFORM_ADMIN_EMAIL=admin@example.com \
  -e PLATFORM_ADMIN_PASSWORD=changeme \
  -e DATABASE_URL=sqlite:///./mcp.db \
  mcpgateway:airgapped

Fully Offline UI

With MCPGATEWAY_UI_AIRGAPPED=true, the Admin UI works completely offline with zero external dependencies. All CSS and JavaScript are served from local files bundled in the container.


πŸƒ Run the ContainerΒΆ

With HTTP (no TLS)ΒΆ

make podman-run

This starts the app at http://localhost:4444.


With Self-Signed TLS (HTTPS)ΒΆ

make podman-run-ssl

Runs the gateway using certs from ./certs/, available at:

https://localhost:4444

βš™ Runtime ConfigurationΒΆ

All environment variables can be passed via:

  • docker run -e KEY=value
  • A mounted .env file (--env-file .env)

πŸ§ͺ Test the Running ContainerΒΆ

curl http://localhost:4444/health
curl http://localhost:4444/tools

Use curl -k if running with self-signed TLS


🧼 Stop & Clean Up¢

podman stop mcpgateway
podman rm mcpgateway

Or with Docker:

docker stop mcpgateway
docker rm mcpgateway