Skip to content

Commit bf87f96

Browse files
committed
readme: update docker compose instructions
1 parent 1deb298 commit bf87f96

File tree

2 files changed

+10
-7
lines changed

2 files changed

+10
-7
lines changed

README.md

Lines changed: 9 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -50,14 +50,14 @@ MCPJungle is a single source-of-truth registry for all [Model Context Protocol](
5050

5151
# Quickstart guide
5252
This quickstart guide will show you how to:
53-
1. Start the MCPJungle server locally using docker-compose
53+
1. Start the MCPJungle server locally using `docker compose`
5454
2. Register a simple MCP server in mcpjungle
5555
3. Connect your Claude to mcpjungle to access your MCP tools
5656

5757
## Start the server
5858
```bash
5959
curl -O https://raw.githubusercontent.com/mcpjungle/MCPJungle/refs/heads/main/docker-compose.yaml
60-
docker-compose up -d
60+
docker compose up -d
6161
```
6262

6363
## Register MCP servers
@@ -148,11 +148,13 @@ For running the MCPJungle server locally, docker compose is the recommended way:
148148
# mcpjungle will run in `development` mode by default.
149149
curl -O https://raw.githubusercontent.com/mcpjungle/MCPJungle/refs/heads/main/docker-compose.yaml
150150

151+
docker compose up -d
152+
151153
# docker-compose.prod.yaml is optimized for orgs deploying mcpjungle on a remote server for multiple users.
152154
# mcpjungle will run in `production` mode by default, which enables enterprise features.
153155
curl -O https://raw.githubusercontent.com/mcpjungle/MCPJungle/refs/heads/main/docker-compose.prod.yaml
154156

155-
docker-compose up -d
157+
docker compose -f docker-compose.prod.yaml up -d
156158
```
157159

158160
This will start the MCPJungle server along with a persistent Postgres database container.
@@ -164,7 +166,7 @@ curl http://localhost:8080/health
164166

165167
If you plan on registering stdio-based MCP servers that rely on `npx` or `uvx`, use mcpjungle's `stdio` tagged docker image instead.
166168
```bash
167-
MCPJUNGLE_IMAGE_TAG=latest-stdio docker-compose up -d
169+
MCPJUNGLE_IMAGE_TAG=latest-stdio docker compose up -d
168170
```
169171

170172
> [!NOTE]
@@ -232,7 +234,7 @@ You can register this MCP server with MCPJungle:
232234
mcpjungle register --name calculator --description "Provides some basic math tools" --url http://127.0.0.1:8000/mcp
233235
```
234236

235-
If you used docker-compose to run the server, and you're not on Linux, you will have to use `host.docker.internal` instead of your local loopback address.
237+
If you used docker compose to run the server, and you're not on Linux, you will have to use `host.docker.internal` instead of your local loopback address.
236238
```bash
237239
mcpjungle register --name calculator --description "Provides some basic math tools" --url http://host.docker.internal:8000/mcp
238240
```
@@ -513,8 +515,8 @@ mcpjungle start --prod
513515
export SERVER_MODE=production
514516
mcpjungle start
515517

516-
# this also works when running the server via docker-compose
517-
SERVER_MODE=production docker-compose up
518+
# Or use the production docker compose file as described above
519+
docker compose -f docker-compose.prod.yaml up -d
518520
```
519521

520522
By default, mcpjungle server runs in `development` mode which is ideal for individuals running it locally.

docker-compose.yaml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -26,6 +26,7 @@ services:
2626
environment:
2727
DATABASE_URL: postgres://mcpjungle:mcpjungle@db:5432/mcpjungle
2828
SERVER_MODE: ${SERVER_MODE:-development}
29+
OTEL_ENABLED: ${OTEL_ENABLED:-false}
2930
ports:
3031
- "8080:8080"
3132
depends_on:

0 commit comments

Comments
 (0)