Skip to content

Commit 4fc483f

Browse files
committed
Update documentation with fixed image tag
Signed-off-by: Mihai Criveti <[email protected]>
1 parent 5d5c690 commit 4fc483f

24 files changed

+83
-78
lines changed

docs/docs/deployment/compose.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ export COMPOSE_CMD="docker compose"
1818
## 🐳/🦭 Build the images
1919

2020
```bash
21-
docker pull ghcr.io/ibm/mcp-context-forge:latest
21+
docker pull ghcr.io/ibm/mcp-context-forge:0.5.0
2222
```
2323

2424
## 🐳/🦭 Build the images (when doing local development)
@@ -71,7 +71,7 @@ COMPOSE_ENGINE=podman make compose-up # force Podman
7171

7272
| Make target | Docker CLI | Podman built-in | podman-compose |
7373
| ----------------- | --------------------------------------------- | -------------------------------------------- | -------------------------------------------- |
74-
| `compose-up` | `docker compose -f podman-compose.yml up -d` | `podman compose -f podman-compose.yml up -d` | `podman-compose -f podman-compose.yml up -d` |
74+
| `compose-up` | `docker compose -f docker-compose.yml up -d` | `podman compose -f docker-compose.yml up -d` | `podman-compose -f docker-compose.yml up -d` |
7575
| `compose-restart` | `docker compose up -d --pull=missing --build` | idem | idem |
7676
| `compose-logs` | `docker compose logs -f` | `podman compose logs -f` | `podman-compose logs -f` |
7777
| `compose-ps` | `docker compose ps` | `podman compose ps` | `podman-compose ps` |
@@ -96,7 +96,7 @@ curl http://localhost:4444/health # {"status":"ok"}
9696

9797
## 🗄 Selecting a database
9898

99-
Uncomment one service block in `podman-compose.yml` and align `DATABASE_URL`:
99+
Uncomment one service block in `docker-compose.yml` and align `DATABASE_URL`:
100100

101101
| Service block | Connection string |
102102
| --------------------- | --------------------------------------------- |

docs/docs/deployment/container.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ docker run -d --name mcpgateway \
1818
-e AUTH_REQUIRED=true \
1919
-e DATABASE_URL=sqlite:///./mcp.db \
2020
--network=host \
21-
ghcr.io/ibm/mcp-context-forge:latest
21+
ghcr.io/ibm/mcp-context-forge:0.5.0
2222

2323
docker logs mcpgateway
2424
```

docs/docs/deployment/google-cloud-run.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ Google Cloud Run is an ideal platform for MCP Gateway due to its:
1616
You can deploy the public image directly:
1717

1818
```text
19-
ghcr.io/ibm/mcp-context-forge:latest
19+
ghcr.io/ibm/mcp-context-forge:0.5.0
2020
```
2121

2222
---
@@ -336,7 +336,7 @@ mcpgw=> \dt;
336336
Use the MCP Gateway container to generate a JWT token:
337337

338338
```bash
339-
docker run -it --rm ghcr.io/ibm/mcp-context-forge:latest \
339+
docker run -it --rm ghcr.io/ibm/mcp-context-forge:0.5.0 \
340340
python3 -m mcpgateway.utils.create_jwt_token -u admin --secret jwt-secret-key
341341
```
342342

docs/docs/deployment/local.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ This guide walks you through running MCP Gateway on your local machine using a v
99
The easiest way to start the server in development mode:
1010

1111
```bash
12-
make venv install serve
12+
make venv install-dev serve
1313
```
1414

1515
This does the following:
@@ -25,7 +25,8 @@ This does the following:
2525
If you want auto-reload on code changes:
2626

2727
```bash
28-
make run # or:
28+
make dev # hot-reload (Uvicorn) on :8000
29+
# or:
2930
./run.sh --reload --log debug
3031
```
3132

docs/docs/deployment/minikube.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
1. **Install Minikube and kubectl** (Docker or Podman driver required).
44
2. Start a local cluster with Ingress and DNS addons.
5-
3. Load the `ghcr.io/ibm/mcp-context-forge:latest` image into Minikube.
5+
3. Load the `ghcr.io/ibm/mcp-context-forge:0.5.0` image into Minikube.
66
4. Apply your Kubernetes manifests.
77
5. Access the Gateway at [http://gateway.local](http://gateway.local) or `127.0.0.1:80` via NGINX Ingress.
88

@@ -131,21 +131,21 @@ kubectl get pods -n ingress-nginx
131131
make minikube-image-load
132132
```
133133

134-
This target builds the `ghcr.io/ibm/mcp-context-forge:latest` image and loads it into Minikube.
134+
This target builds the `ghcr.io/ibm/mcp-context-forge:0.5.0` image and loads it into Minikube.
135135

136136
### Alternative methods
137137

138138
* **Pre-cache a remote image:**
139139

140140
```bash
141-
minikube cache add ghcr.io/ibm/mcp-context-forge:latest
141+
minikube cache add ghcr.io/ibm/mcp-context-forge:0.5.0
142142
minikube cache reload
143143
```
144144

145145
* **Load a local tarball:**
146146

147147
```bash
148-
docker save ghcr.io/ibm/mcp-context-forge:latest | minikube image load -
148+
docker save ghcr.io/ibm/mcp-context-forge:0.5.0 | minikube image load -
149149
```
150150

151151
---
@@ -282,7 +282,7 @@ curl http://gateway.local/health
282282
| ------------------- | ---------------------- | ------------------------------------------------------------ |
283283
| Pause cluster | `make minikube-stop` | `minikube stop -p mcpgw` |
284284
| Delete cluster | `make minikube-delete` | `minikube delete -p mcpgw` |
285-
| Remove cached image | - | `minikube cache delete ghcr.io/ibm/mcp-context-forge:latest` |
285+
| Remove cached image | - | `minikube cache delete ghcr.io/ibm/mcp-context-forge:0.5.0` |
286286

287287
---
288288

docs/docs/development/building.md

Lines changed: 8 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ Follow these instructions to set up your development environment, build the gate
66

77
## 🧩 Prerequisites
88

9-
- Python **≥ 3.10**
9+
- Python **≥ 3.11**
1010
- `make`
1111
- (Optional) Docker or Podman for container builds
1212

@@ -15,13 +15,13 @@ Follow these instructions to set up your development environment, build the gate
1515
## 🔧 One-Liner Setup (Recommended)
1616

1717
```bash
18-
make venv install serve
18+
make venv install-dev serve
1919
```
2020

2121
This will:
2222

2323
1. Create a virtual environment in `.venv/`
24-
2. Install Python dependencies including dev extras
24+
2. Install Python dependencies (including dev extras)
2525
3. Run the gateway using Gunicorn
2626

2727
---
@@ -47,12 +47,13 @@ This installs:
4747
You can run the gateway with:
4848

4949
```bash
50-
make serve # production-mode Gunicorn (http://localhost:4444)
51-
make run # dev-mode Uvicorn (reloads on change)
52-
./run.sh --reload # same as 'make run', with CLI flags
50+
make serve # production-mode (Gunicorn) on http://localhost:4444
51+
make dev # hot-reload (Uvicorn) on http://localhost:8000
52+
make run # wrapper over uvicorn; pass --reload to enable auto-reload
53+
./run.sh --reload # equivalent of 'make run' with explicit flags
5354
```
5455

55-
Use `make run` or `./run.sh` during development for auto-reload.
56+
Use `make dev` during development for auto-reload on port 8000.
5657

5758
---
5859

docs/docs/development/developer-onboarding.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@
77
## 🛠 Environment Setup
88

99
???+ check "System prerequisites"
10-
- [ ] Python ≥ 3.10
10+
- [ ] Python ≥ 3.11
1111
- [ ] Node.js and npm, npx (used for testing with `supergateway` and the HTML/JS Admin UI)
1212
- [ ] Docker, Docker Compose, and Podman
1313
- [ ] Make, GitHub CLI (`gh`), `curl`, `jq`, `openssl`

docs/docs/development/documentation.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ Follow this guide when you need to add or update markdown pages under `docs/` an
66

77
## 🧩 Prerequisites
88

9-
* **Python ≥ 3.10** (only for the initial virtual env - *not* required if you already have one)
9+
* **Python ≥ 3.11** (only for the initial virtual env - *not* required if you already have one)
1010
* `make` (GNU Make 4+)
1111
* (First-time only) **[`mkdocs-material`](https://squidfunk.github.io/mkdocs-material/)** and plugins are installed automatically by the *docs* `Makefile`.
1212
* One-time GitHub setup, e.g. [gitconfig setup](./github.md#16-personal-git-configuration-recommended)

docs/docs/faq/index.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@
1616
OCI image (Docker/Podman) - shares host network so localhost works:
1717

1818
```bash
19-
podman run --network=host -p 4444:4444 ghcr.io/ibm/mcp-context-forge:latest
19+
podman run --network=host -p 4444:4444 ghcr.io/ibm/mcp-context-forge:0.5.0
2020
```
2121

2222
???+ example "🗂️ What URLs are available for the admin interface and API docs?"
@@ -108,7 +108,7 @@
108108
Include a persistent volume with your container or Kubernetes deployment. Ex:
109109

110110
```bash
111-
docker run -v $(pwd)/data:/app ghcr.io/ibm/mcp-context-forge:latest
111+
docker run -v $(pwd)/data:/app ghcr.io/ibm/mcp-context-forge:0.5.0
112112
```
113113

114114
For production use, we recommend PostgreSQL. A Docker Compose target with PostgreSQL and Redis is provided.
@@ -224,9 +224,9 @@
224224
token=os.environ["MCPGATEWAY_BEARER_TOKEN"])
225225
```
226226

227-
???+ example "🦾 How do I connect GitHub's mcp-server-git via SuperGateway?"
227+
???+ example "🦾 How do I connect GitHub's mcp-server-git via Translate Bridge?"
228228
```bash
229-
npx -y supergateway --stdio "uvx mcp-server-git"
229+
python3 -m mcpgateway.translate --stdio "uvx mcp-server-git" --expose-sse --port 9001
230230
```
231231

232232
---

docs/docs/manage/logging-examples.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -108,7 +108,7 @@ LOG_FOLDER=logs
108108
# docker-compose.yml
109109
services:
110110
mcpgateway:
111-
image: ghcr.io/ibm/mcp-context-forge:latest
111+
image: ghcr.io/ibm/mcp-context-forge:0.5.0
112112
environment:
113113
- LOG_LEVEL=INFO
114114
# Default: logs to stdout/stderr only (recommended for containers)

0 commit comments

Comments
 (0)