@@ -73,57 +73,40 @@ For a simpler approach to publish local MCP servers over OAuth, consider [MCP Wa
73731 . Go to the [ Register new GitHub App] ( https://github.com/settings/apps/new )
74742 . Set Authorization callback URL: ` {EXTERNAL_URL}/.auth/github/callback `
7575
76- ## 🚀 Installation & Usage
76+ ## 🚀 Usage
7777
78- ### Method 1: Direct Binary
78+ ### Method 1: Download Binary
7979
80- ``` bash
81- # Clone the repository
82- git clone https://github.com/sigbit/mcp-auth-proxy.git
83- cd mcp-auth-proxy
84-
85- # Build the binary
86- go build -o mcp-auth-proxy .
87-
88- # Run with environment variables
89- export GOOGLE_CLIENT_ID=" your-google-client-id"
90- export GOOGLE_CLIENT_SECRET=" your-google-client-secret"
91- 92- ./mcp-auth-proxy
93- ```
94-
95- ### Method 2: Command Line Arguments
80+ Download the latest binary from [ releases] ( https://github.com/sigbit/mcp-auth-proxy/releases ) and run with command line options:
9681
9782``` bash
9883./mcp-auth-proxy \
99- --external-url " https://your-domain.com" \
100- --proxy-url " http://your-mcp-server:8080" \
84+ --external-url " http://localhost:8081" \
85+ --proxy-url " http://localhost:8080" \
86+ --global-secret " $( openssl rand -hex 32) " \
10187 --google-client-id " your-google-client-id" \
10288 --google-client-secret " your-google-client-secret" \
103- 104- ```
105-
106- ### Method 3: Docker Compose (Recommended)
107-
108- 1 . Create a ` .env ` file in the ` example/ ` directory:
109-
110- ``` env
111- GLOBAL_SECRET=your-super-secret-key-here
112- GOOGLE_CLIENT_ID=your-google-client-id
113- GOOGLE_CLIENT_SECRET=your-google-client-secret
114- 115- GITHUB_CLIENT_ID=your-github-client-id
116- GITHUB_CLIENT_SECRET=your-github-client-secret
117- GITHUB_ALLOWED_USERS=username1,username2
89+ 90+ --github-client-id " your-github-client-id" \
91+ --github-client-secret " your-github-client-secret" \
92+ --github-allowed-users " username1,username2" \
93+ --password " changeme"
11894```
11995
120- 2 . Run with Docker Compose:
96+ ### Method 2: Docker
12197
12298``` bash
123- cd example/
124- docker compose up -d
99+ docker run --rm -p 8081:8081 --net=host \
100+ -e EXTERNAL_URL=http://localhost:8081 \
101+ -e PROXY_URL=http://localhost:8080 \
102+ -e GLOBAL_SECRET=$( openssl rand -hex 32) \
103+ -e GOOGLE_CLIENT_ID=" your-google-client-id" \
104+ -e GOOGLE_CLIENT_SECRET=" your-google-client-secret" \
105+ 106+ -e GITHUB_CLIENT_ID=" your-github-client-id" \
107+ -e GITHUB_CLIENT_SECRET=" your-github-client-secret" \
108+ -e GITHUB_ALLOWED_USERS=" username1,username2" \
109+ -e PASSWORD=changeme \
110+ -v ./data:/data \
111+ ghcr.io/sigbit/mcp-auth-proxy:latest
125112```
126-
127- This will start:
128- - MCP Auth Proxy on port 8081
129- - Playwright MCP server on port 8931 (as an example backend)
0 commit comments