Skip to content

Commit c8d2620

Browse files
apartsinclaude
andcommitted
Add docker pull install instructions and fix package name in CDK docs
- Add ghcr.io/apartsinprojects/modelmesh:latest pull instructions to all install sections: README, docs/index, ForAIAgent, ProxyGuide, ClaudeSkill - Fix CDK DeveloperGuide prerequisite: pip install modelmesh → modelmesh-lite - All 3 install methods now documented everywhere: pip, npm, docker pull Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
1 parent 00f8c6b commit c8d2620

File tree

6 files changed

+84
-17
lines changed

6 files changed

+84
-17
lines changed

ClaudeSkill/install.md

Lines changed: 21 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -56,20 +56,33 @@ pnpm add @nistrapa/modelmesh-core
5656

5757
## Docker Installation
5858

59+
**Pre-built image (fastest):**
60+
```bash
61+
docker pull ghcr.io/apartsinprojects/modelmesh:latest
62+
63+
# Run with inline env vars
64+
docker run -p 8080:8080 \
65+
-e OPENAI_API_KEY="sk-..." \
66+
ghcr.io/apartsinprojects/modelmesh:latest \
67+
--host 0.0.0.0 --port 8080
68+
69+
# Or with env file and config
70+
docker run -p 8080:8080 \
71+
--env-file .env \
72+
-v ./modelmesh.yaml:/app/modelmesh.yaml:ro \
73+
ghcr.io/apartsinprojects/modelmesh:latest \
74+
--config /app/modelmesh.yaml --host 0.0.0.0 --port 8080
75+
```
76+
77+
**From source (Docker Compose):**
5978
```bash
60-
# Clone and set up
6179
git clone https://github.com/ApartsinProjects/ModelMesh.git
6280
cd ModelMesh
63-
64-
# Create env file with API keys
65-
cp .env.example .env
66-
# Edit .env and fill in keys
67-
68-
# Build and run
81+
cp .env.example .env # add your API keys
6982
docker compose up --build
7083
```
7184

72-
Or build the image directly:
85+
**From source (Docker directly):**
7386
```bash
7487
docker build -t modelmesh-proxy .
7588
docker run -p 8080:8080 --env-file .env -v ./modelmesh.yaml:/app/modelmesh.yaml:ro modelmesh-proxy --config /app/modelmesh.yaml

README.md

Lines changed: 15 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -35,6 +35,12 @@ npm install @nistrapa/modelmesh-core
3535

3636
**Docker Proxy (any language):**
3737
```bash
38+
# Option A: Pull pre-built image from GitHub Container Registry
39+
docker pull ghcr.io/apartsinprojects/modelmesh:latest
40+
41+
# Option B: Build from source
42+
git clone https://github.com/ApartsinProjects/ModelMesh.git
43+
cd ModelMesh
3844
cp .env.example .env # add your API keys
3945
docker compose up --build
4046
# Proxy at http://localhost:8080 — speaks the OpenAI REST API
@@ -222,13 +228,18 @@ cd src/typescript && npm install && npm test
222228
## Docker
223229

224230
```bash
225-
# Quick start with Docker Compose
231+
# Pull pre-built image from GitHub Container Registry
232+
docker pull ghcr.io/apartsinprojects/modelmesh:latest
233+
234+
# Run with your API keys
235+
docker run -p 8080:8080 \
236+
-e OPENAI_API_KEY="sk-..." \
237+
ghcr.io/apartsinprojects/modelmesh:latest
238+
239+
# Or build from source with Docker Compose
226240
cp .env.example .env # then add your API keys
227241
docker compose up --build
228242

229-
# Or use the automation script
230-
./scripts/proxy-up.sh
231-
232243
# Test the running proxy
233244
curl http://localhost:8080/v1/models
234245
curl -X POST http://localhost:8080/v1/chat/completions \

docs/ForAIAgent.md

Lines changed: 19 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -263,18 +263,35 @@ The Docker proxy exposes the full OpenAI REST API. Any language/framework that c
263263
- Docker and Docker Compose installed
264264
- At least one API key
265265

266-
### Setup
266+
### Install
267+
268+
**Option A — Pre-built image (fastest):**
269+
```bash
270+
docker pull ghcr.io/apartsinprojects/modelmesh:latest
271+
```
267272

273+
**Option B — Build from source:**
268274
```bash
269275
git clone https://github.com/ApartsinProjects/ModelMesh.git
270276
cd ModelMesh
277+
```
278+
279+
### Setup
271280

281+
```bash
272282
# Create .env with your API keys
273283
cp .env.example .env
274284
# Edit .env and add your keys: OPENAI_API_KEY=sk-..., etc.
275285

276-
# Start the proxy
286+
# Start the proxy (from source)
277287
docker compose up --build
288+
289+
# Or run the pre-built image directly
290+
docker run -p 8080:8080 \
291+
-e OPENAI_API_KEY="sk-..." \
292+
-e ANTHROPIC_API_KEY="sk-ant-..." \
293+
ghcr.io/apartsinprojects/modelmesh:latest \
294+
--host 0.0.0.0 --port 8080
278295
```
279296

280297
The proxy runs on `http://localhost:8080`.

docs/cdk/DeveloperGuide.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ title: "CDK Developer Guide"
77

88
A tutorial-driven guide for using ModelMesh Lite, from the convenience layer (`modelmesh.create()`) through custom connectors built with the Connector Development Kit (CDK). Tutorials 0-1 cover the OpenAI-compatible convenience API, Tutorials 2-7 progress from zero-code configuration through full connector suites and automated testing, and Tutorial 8 provides a beginner-friendly walkthrough for new programmers.
99

10-
> **Prerequisites:** Tutorials 0-1 require only `pip install modelmesh` and an API key. Tutorials 2-7 assume familiarity with the [CDK Overview](Overview.html) and the [class hierarchy](Overview.html#class-hierarchy). Tutorial 8 is self-contained. Each tutorial references the relevant CDK reference documents inline.
10+
> **Prerequisites:** Tutorials 0-1 require only `pip install modelmesh-lite` and an API key. Tutorials 2-7 assume familiarity with the [CDK Overview](Overview.html) and the [class hierarchy](Overview.html#class-hierarchy). Tutorial 8 is self-contained. Each tutorial references the relevant CDK reference documents inline.
1111
1212
---
1313

docs/guides/ProxyGuide.md

Lines changed: 22 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -395,7 +395,27 @@ The proxy includes full CORS support (`Access-Control-Allow-Origin: *`) for brow
395395

396396
### Build and Run
397397

398-
**Using Docker Compose (recommended):**
398+
**Option A: Pull pre-built image from GHCR (fastest):**
399+
400+
```bash
401+
docker pull ghcr.io/apartsinprojects/modelmesh:latest
402+
403+
# Run with environment variables
404+
docker run -p 8080:8080 \
405+
-e OPENAI_API_KEY="sk-..." \
406+
-e ANTHROPIC_API_KEY="sk-ant-..." \
407+
ghcr.io/apartsinprojects/modelmesh:latest \
408+
--host 0.0.0.0 --port 8080
409+
410+
# Or run with config file and env file
411+
docker run -p 8080:8080 \
412+
--env-file .env \
413+
-v ./modelmesh.yaml:/app/modelmesh.yaml:ro \
414+
ghcr.io/apartsinprojects/modelmesh:latest \
415+
--config /app/modelmesh.yaml --host 0.0.0.0 --port 8080
416+
```
417+
418+
**Option B: Docker Compose (recommended for development):**
399419

400420
```bash
401421
# 1. Create .env with your API keys
@@ -418,7 +438,7 @@ docker compose logs -f
418438
docker compose down
419439
```
420440

421-
**Using Docker directly:**
441+
**Option C: Build Docker image locally:**
422442

423443
```bash
424444
# Build

docs/index.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -40,6 +40,12 @@ npm install @nistrapa/modelmesh-core
4040

4141
**Docker Proxy (any language):**
4242
```bash
43+
# Option A: Pull pre-built image from GitHub Container Registry
44+
docker pull ghcr.io/apartsinprojects/modelmesh:latest
45+
46+
# Option B: Build from source
47+
git clone https://github.com/ApartsinProjects/ModelMesh.git
48+
cd ModelMesh
4349
cp .env.example .env # add your API keys
4450
docker compose up --build
4551
# Proxy at http://localhost:8080 — speaks the OpenAI REST API

0 commit comments

Comments
 (0)