mirror of
https://github.com/b3nw/nginx-proxy-manager-mcp.git
synced 2026-05-19 23:35:47 -05:00
chore: Use pre-built Docker image from GHCR
- Update compose.yaml to use ghcr.io/b3nw/nginx-proxy-manager-mcp:latest - Add Docker quick start section to README - Users can now deploy without cloning the repo
This commit is contained in:
27
README.md
27
README.md
@@ -2,7 +2,32 @@
|
|||||||
|
|
||||||
MCP server for [Nginx Proxy Manager](https://nginxproxymanager.com/) - manage your reverse proxy through AI assistants.
|
MCP server for [Nginx Proxy Manager](https://nginxproxymanager.com/) - manage your reverse proxy through AI assistants.
|
||||||
|
|
||||||
## Installation
|
## Quick Start (Docker)
|
||||||
|
|
||||||
|
The easiest way to run the NPM MCP server - no cloning required!
|
||||||
|
|
||||||
|
```bash
|
||||||
|
# Download the compose file
|
||||||
|
curl -O https://raw.githubusercontent.com/b3nw/nginx-proxy-manager-mcp/main/compose.yaml
|
||||||
|
|
||||||
|
# Edit the environment variables, then start
|
||||||
|
docker compose up -d
|
||||||
|
```
|
||||||
|
|
||||||
|
Or run directly:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
docker run -d \
|
||||||
|
--name npm-mcp \
|
||||||
|
-p 8000:8000 \
|
||||||
|
-e NPM_API_URL=http://your-npm:81/api \
|
||||||
|
-e NPM_IDENTITY=admin@example.com \
|
||||||
|
-e NPM_SECRET=yourpassword \
|
||||||
|
-e NPM_MCP_TRANSPORT=http \
|
||||||
|
ghcr.io/b3nw/nginx-proxy-manager-mcp:latest
|
||||||
|
```
|
||||||
|
|
||||||
|
## Installation (Local)
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
# Using uv (recommended)
|
# Using uv (recommended)
|
||||||
|
|||||||
@@ -1,9 +1,8 @@
|
|||||||
# Example Docker Compose configuration for NPM MCP Server
|
# Docker Compose configuration for NPM MCP Server
|
||||||
# This runs the MCP server in HTTP mode, suitable for remote AI agents
|
|
||||||
|
|
||||||
services:
|
services:
|
||||||
npm-mcp:
|
npm-mcp:
|
||||||
build: .
|
image: ghcr.io/b3nw/nginx-proxy-manager-mcp:latest
|
||||||
container_name: npm-mcp
|
container_name: npm-mcp
|
||||||
restart: unless-stopped
|
restart: unless-stopped
|
||||||
ports:
|
ports:
|
||||||
@@ -40,7 +39,7 @@ services:
|
|||||||
# - npm_letsencrypt:/etc/letsencrypt
|
# - npm_letsencrypt:/etc/letsencrypt
|
||||||
#
|
#
|
||||||
# npm-mcp:
|
# npm-mcp:
|
||||||
# build: .
|
# image: ghcr.io/b3nw/nginx-proxy-manager-mcp:latest
|
||||||
# environment:
|
# environment:
|
||||||
# - NPM_API_URL=http://nginx-proxy-manager:81/api
|
# - NPM_API_URL=http://nginx-proxy-manager:81/api
|
||||||
# - NPM_IDENTITY=admin@example.com
|
# - NPM_IDENTITY=admin@example.com
|
||||||
|
|||||||
Reference in New Issue
Block a user