@@ -15,7 +15,37 @@ A OAuth 2.1 authorization server that provides transparent authentication and au
1515
1616📖 ** [ View Detailed Architecture] ( ARCHITECTURE.md ) ** | 📚 ** [ Developer Guide] ( CLAUDE.md ) **
1717
18- ## Quick Start
18+ ## Quick Start with Docker (Recommended)
19+
20+ ### Pre-built Image
21+
22+ Use the pre-built Docker image from GitHub Container Registry:
23+
24+ ``` bash
25+ # Run with memory storage (development)
26+ docker run -p 8080:8080 \
27+ -v $( pwd) /config.yaml:/app/config.yaml \
28+ -e GOOGLE_CLIENT_ID=" your-google-client-id" \
29+ -e GOOGLE_CLIENT_SECRET=" your-google-client-secret" \
30+ ghcr.io/akshay5995/mcp-oauth-gateway:latest
31+ ```
32+
33+ ### Docker Compose (Full Stack)
34+
35+ ``` bash
36+ # Copy environment template
37+ cp .env.example .env
38+ # Edit .env with your OAuth credentials
39+
40+ # Start all services (gateway + Redis + demo calculator)
41+ docker-compose up -d
42+
43+ # Test the setup
44+ curl http://localhost:8080/health
45+ curl http://localhost:8080/calculator/mcp # Should return 401 with OAuth info
46+ ```
47+
48+ ## Local Development Setup
1949
2050### 1. Install Dependencies
2151
@@ -233,28 +263,15 @@ Services can use these headers for:
233263- Personalized responses
234264- User-specific data access
235265
236- ## Docker Deployment
237-
238- ### Pre-built Image (Recommended)
239-
240- Use the pre-built Docker image from GitHub Container Registry:
241-
242- ` ` ` bash
243- # Run with memory storage (development)
244- docker run -p 8080:8080 \
245- -v $(pwd)/config.yaml:/app/config.yaml \
246- -e GOOGLE_CLIENT_ID="your-google-client-id" \
247- -e GOOGLE_CLIENT_SECRET="your-google-client-secret" \
248- ghcr.io/akshay5995/mcp-oauth-gateway:latest
249- ```
266+ ## Advanced Docker Deployment
250267
251268### Build from Source
252269
253270` ` ` bash
254271# Build image locally
255272docker build -t mcp-oauth-gateway .
256273
257- # Run with memory storage (development)
274+ # Run with custom build
258275docker run -p 8080:8080 \
259276 -v $(pwd)/config.yaml:/app/config.yaml \
260277 -e GOOGLE_CLIENT_ID="your-google-client-id" \
@@ -318,37 +335,6 @@ docker run -p 8080:8080 \
318335 ghcr.io/akshay5995/mcp-oauth-gateway:latest
319336```
320337
321- ### Docker Compose Example
322-
323- ``` yaml
324- # docker-compose.yml
325- version : ' 3.8'
326- services :
327- mcp-gateway :
328- image : ghcr.io/akshay5995/mcp-oauth-gateway:latest
329- ports :
330- - " 8080:8080"
331- volumes :
332- - ./config.yaml:/app/config.yaml
333- environment :
334- - GOOGLE_CLIENT_ID=${GOOGLE_CLIENT_ID}
335- - GOOGLE_CLIENT_SECRET=${GOOGLE_CLIENT_SECRET}
336- - REDIS_PASSWORD=mypassword
337- depends_on :
338- - redis
339-
340- redis :
341- image : redis:alpine
342- command : redis-server --requirepass mypassword
343- ports :
344- - " 6379:6379"
345- ` ` `
346-
347- ` ` ` bash
348- # Start with Docker Compose
349- docker-compose up -d
350- ```
351-
352338## API Endpoints
353339
354340### OAuth 2.1 Endpoints
0 commit comments