33 lines
No EOL
998 B
Markdown
33 lines
No EOL
998 B
Markdown
# 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
|
|
|
|
1. 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`.
|
|
2. Build and start the service:
|
|
|
|
```bash
|
|
docker compose -f compose.yml up -d --build
|
|
```
|
|
|
|
3. Connect your MCP client to the Streamable HTTP endpoint:
|
|
|
|
```bash
|
|
http://localhost:8811/mcp
|
|
```
|
|
|
|
4. Check service health if needed:
|
|
|
|
```bash
|
|
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`. |