Skip to content

Commit cc3c8d8

Browse files
committed
docs: add Docker Hub deployment instructions with host network
- Add instructions for running from Docker Hub registry - Use host network mode for simplified Kong connectivity - Remove username/password auth from basic examples - Include all environment variables from server.sh script - Keep Kong Enterprise API token as separate option
1 parent a791ffc commit cc3c8d8

File tree

1 file changed

+75
-7
lines changed

1 file changed

+75
-7
lines changed

README.md

Lines changed: 75 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -222,7 +222,75 @@ isort src/ tests/
222222

223223
## Docker Deployment
224224

225-
### Building the Docker Image
225+
### Running from Docker Hub
226+
227+
The Kong Rate Limiter MCP Server is available on Docker Hub as `shibbirmcc/kong-ratelimiter-mcp-server`.
228+
229+
#### Quick Start with Docker Hub
230+
231+
```bash
232+
# Pull and run the latest image with host network
233+
docker run --network host shibbirmcc/kong-ratelimiter-mcp-server
234+
235+
# Run with a specific version
236+
docker run --network host shibbirmcc/kong-ratelimiter-mcp-server:latest
237+
238+
# Run in detached mode with a custom name
239+
docker run -d --network host --name kong-mcp shibbirmcc/kong-ratelimiter-mcp-server
240+
```
241+
242+
#### Running with Environment Variables
243+
244+
Configure the server using environment variables to connect to your Kong instance:
245+
246+
```bash
247+
# Basic configuration (Kong without authentication)
248+
docker run -d --network host \
249+
--name kong-mcp \
250+
-e KONG_ADMIN_URL=http://localhost:8001 \
251+
shibbirmcc/kong-ratelimiter-mcp-server
252+
253+
# Custom port configuration
254+
docker run -d --network host \
255+
--name kong-mcp \
256+
-e HOST=127.0.0.1 \
257+
-e FASTMCP_PORT=8080 \
258+
-e KONG_ADMIN_URL=http://localhost:8001 \
259+
shibbirmcc/kong-ratelimiter-mcp-server
260+
261+
# Full configuration with all options
262+
docker run -d --network host \
263+
--name kong-mcp \
264+
-e HOST=0.0.0.0 \
265+
-e FASTMCP_PORT=8080 \
266+
-e KONG_ADMIN_URL=http://localhost:8001 \
267+
-e KONG_TIMEOUT=45.0 \
268+
-e KONG_VERIFY_SSL=false \
269+
shibbirmcc/kong-ratelimiter-mcp-server
270+
271+
# Using a different port
272+
docker run -d --network host \
273+
--name kong-mcp \
274+
-e FASTMCP_PORT=9000 \
275+
-e KONG_ADMIN_URL=http://localhost:8001 \
276+
shibbirmcc/kong-ratelimiter-mcp-server
277+
```
278+
279+
#### Kong Enterprise Edition with API Token
280+
281+
If you're using Kong Enterprise Edition with API token authentication:
282+
283+
```bash
284+
docker run -d --network host \
285+
--name kong-mcp \
286+
-e KONG_ADMIN_URL=http://localhost:8001 \
287+
-e KONG_API_TOKEN=your-api-token \
288+
shibbirmcc/kong-ratelimiter-mcp-server
289+
```
290+
291+
### Building the Docker Image Locally
292+
293+
If you want to build the image locally instead of using Docker Hub:
226294

227295
```bash
228296
# Build the image
@@ -232,17 +300,17 @@ docker build -t kong-mcp-server .
232300
docker build -t kong-mcp-server:0.1.2 .
233301
```
234302

235-
### Running with Docker
303+
### Running Locally Built Image
236304

237305
```bash
238-
# Run the container
239-
docker run -p 8080:8080 kong-mcp-server
306+
# Run the container with host network
307+
docker run --network host kong-mcp-server
240308

241309
# Run in detached mode
242-
docker run -d -p 8080:8080 --name kong-mcp kong-mcp-server
310+
docker run -d --network host --name kong-mcp kong-mcp-server
243311

244-
# Run with environment variables (if needed)
245-
docker run -p 8080:8080 -e KONG_ADMIN_URL=http://kong:8001 kong-mcp-server
312+
# Run with environment variables
313+
docker run --network host -e KONG_ADMIN_URL=http://localhost:8001 kong-mcp-server
246314
```
247315

248316
### Docker Compose

0 commit comments

Comments
 (0)