diff --git a/README.md b/README.md index c709818..70dae3e 100644 --- a/README.md +++ b/README.md @@ -2,7 +2,32 @@ 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 # Using uv (recommended) diff --git a/compose.yaml b/compose.yaml index d70967b..d7798bc 100644 --- a/compose.yaml +++ b/compose.yaml @@ -1,9 +1,8 @@ -# Example Docker Compose configuration for NPM MCP Server -# This runs the MCP server in HTTP mode, suitable for remote AI agents +# Docker Compose configuration for NPM MCP Server services: npm-mcp: - build: . + image: ghcr.io/b3nw/nginx-proxy-manager-mcp:latest container_name: npm-mcp restart: unless-stopped ports: @@ -40,7 +39,7 @@ services: # - npm_letsencrypt:/etc/letsencrypt # # npm-mcp: -# build: . +# image: ghcr.io/b3nw/nginx-proxy-manager-mcp:latest # environment: # - NPM_API_URL=http://nginx-proxy-manager:81/api # - NPM_IDENTITY=admin@example.com