History

Marco f5a209bb4a First data		2026-04-17 14:08:19 +02:00
..
.env.example	First data	2026-04-17 14:08:19 +02:00
.gitignore	First data	2026-04-17 14:08:19 +02:00
compose.yml	First data	2026-04-17 14:08:19 +02:00
docker-entrypoint.sh	First data	2026-04-17 14:08:19 +02:00
Dockerfile	First data	2026-04-17 14:08:19 +02:00
README.md	First data	2026-04-17 14:08:19 +02:00

README.md

OPNsense MCP Docker Setup

This folder packages opnsense-mcp-server behind an HTTP MCP gateway for local Docker use.

Files

Dockerfile installs the published npm package and supergateway.
compose.yml defines a single long-running opnsense-mcp HTTP service.
.env.example shows the required and optional environment variables.

Usage

Create .env from .env.example. If you want SSH features with key auth, set HOST_SSH_KEY_PATH to a real host path and keep OPNSENSE_SSH_KEY_PATH=/run/secrets/opnsense_ssh_key.

Build and start the service:

docker compose -f compose.yml up -d --build

Connect your MCP client to the Streamable HTTP endpoint:
```
http://localhost:8811/mcp
```
Check service health if needed:
```
docker compose -f compose.yml ps
```

This avoids duplicate one-off containers because the intended workflow uses a single named service with docker compose up, not docker compose run.