mirror of
https://github.com/b3nw/nginx-proxy-manager-mcp.git
synced 2026-05-20 07: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.
|
||||
|
||||
## 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)
|
||||
|
||||
Reference in New Issue
Block a user