Skip to content

docs: update configuration documentation with latest options #74

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
hrntknr merged 2 commits into from
Aug 24, 2025
Merged

docs: update configuration documentation with latest options #74

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
342665a
docs: update configuration documentation with latest options
hrntknr Aug 24, 2025
6019383
docs: improve OAuth setup code block formatting
hrntknr Aug 24, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
23 changes: 13 additions & 10 deletions docs/docs/configuration.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,19 +34,21 @@ Complete reference for all MCP Auth Proxy configuration options.

#### Google OAuth

| Option | Environment Variable | Default | Description |
| ------------------------ | ---------------------- | ------- | ----------------------------------------------------- |
| `--google-client-id` | `GOOGLE_CLIENT_ID` | - | Google OAuth client ID |
| `--google-client-secret` | `GOOGLE_CLIENT_SECRET` | - | Google OAuth client secret |
| `--google-allowed-users` | `GOOGLE_ALLOWED_USERS` | - | Comma-separated list of allowed Google users (emails) |
| Option | Environment Variable | Default | Description |
| ----------------------------- | --------------------------- | ------- | ----------------------------------------------------- |
| `--google-client-id` | `GOOGLE_CLIENT_ID` | - | Google OAuth client ID |
| `--google-client-secret` | `GOOGLE_CLIENT_SECRET` | - | Google OAuth client secret |
| `--google-allowed-users` | `GOOGLE_ALLOWED_USERS` | - | Comma-separated list of allowed Google users (emails) |
| `--google-allowed-workspaces` | `GOOGLE_ALLOWED_WORKSPACES` | - | Comma-separated list of allowed Google workspaces |

#### GitHub OAuth

| Option | Environment Variable | Default | Description |
| ------------------------ | ---------------------- | ------- | -------------------------------------------------------- |
| `--github-client-id` | `GITHUB_CLIENT_ID` | - | GitHub OAuth client ID |
| `--github-client-secret` | `GITHUB_CLIENT_SECRET` | - | GitHub OAuth client secret |
| `--github-allowed-users` | `GITHUB_ALLOWED_USERS` | - | Comma-separated list of allowed GitHub users (usernames) |
| Option | Environment Variable | Default | Description |
| ------------------------ | ---------------------- | ------- | -------------------------------------------------------------------------------------------------------------------------------- |
| `--github-client-id` | `GITHUB_CLIENT_ID` | - | GitHub OAuth client ID |
| `--github-client-secret` | `GITHUB_CLIENT_SECRET` | - | GitHub OAuth client secret |
| `--github-allowed-users` | `GITHUB_ALLOWED_USERS` | - | Comma-separated list of allowed GitHub users (usernames) |
| `--github-allowed-orgs` | `GITHUB_ALLOWED_ORGS` | - | Comma-separated list of allowed GitHub organizations. You can also restrict access to specific teams using the format `Org:Team` |

#### Generic OIDC

Expand Down Expand Up @@ -74,5 +76,6 @@ Complete reference for all MCP Auth Proxy configuration options.
| ---------------------- | -------------------- | ------- | ----------------------------------------------------------------------------------------------------- |
| `--proxy-bearer-token` | `PROXY_BEARER_TOKEN` | - | Bearer token to add to Authorization header when proxying requests |
| `--proxy-headers` | `PROXY_HEADERS` | - | Comma-separated list of headers to add when proxying requests (format: Header1:Value1,Header2:Value2) |
| `--trusted-proxies` | `TRUSTED_PROXIES` | - | Comma-separated list of trusted proxies (IP addresses or CIDR ranges) |

For practical configuration examples including environment variables, Docker Compose, and Kubernetes deployments, see the [Configuration Examples](./examples.md) page.
6 changes: 6 additions & 0 deletions docs/docs/examples.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -37,6 +37,12 @@ services:
- GOOGLE_CLIENT_ID=your-google-client-id
- GOOGLE_CLIENT_SECRET=your-google-client-secret
- GOOGLE_ALLOWED_USERS=user1@example.com,user2@example.com
- GOOGLE_ALLOWED_WORKSPACES=workspace1.com,workspace2.com
- GITHUB_CLIENT_ID=your-github-client-id
- GITHUB_CLIENT_SECRET=your-github-client-secret
- GITHUB_ALLOWED_USERS=username1,username2
- GITHUB_ALLOWED_ORGS=org1,org2:team1
- TRUSTED_PROXIES=10.0.0.0/8,172.16.0.0/12,192.168.0.0/16
volumes:
- ./data:/data
command: ["npx", "-y", "@modelcontextprotocol/server-filesystem", "./"]
Expand Down
17 changes: 17 additions & 0 deletions docs/docs/oauth-setup.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,8 @@ Configure OAuth providers to enable secure authentication for your MCP server.

### 3. Configure MCP Auth Proxy

#### Allow specific users:

```bash
./mcp-auth-proxy \
--external-url https://{your-domain} \
Expand All @@ -40,6 +42,18 @@ Configure OAuth providers to enable secure authentication for your MCP server.
-- your-mcp-command
```

#### Allow entire Google Workspaces:

```bash
./mcp-auth-proxy \
--external-url https://{your-domain} \
--tls-accept-tos \
--google-client-id "your-google-client-id" \
--google-client-secret "your-google-client-secret" \
--google-allowed-workspaces "workspace1.com,workspace2.com" \
-- your-mcp-command
```

## GitHub OAuth Setup

### 1. Register OAuth App
Expand All @@ -60,6 +74,7 @@ Configure OAuth providers to enable secure authentication for your MCP server.
--github-client-id "your-github-client-id" \
--github-client-secret "your-github-client-secret" \
--github-allowed-users "username1,username2" \
--github-allowed-orgs "org1,org2:team1" \
-- your-mcp-command
```

Expand Down Expand Up @@ -141,10 +156,12 @@ All OAuth settings can be configured using environment variables:
export GOOGLE_CLIENT_ID="your-google-client-id"
export GOOGLE_CLIENT_SECRET="your-google-client-secret"
export GOOGLE_ALLOWED_USERS="user1@example.com,user2@example.com"
export GOOGLE_ALLOWED_WORKSPACES="workspace1.com,workspace2.com"

export GITHUB_CLIENT_ID="your-github-client-id"
export GITHUB_CLIENT_SECRET="your-github-client-secret"
export GITHUB_ALLOWED_USERS="username1,username2"
export GITHUB_ALLOWED_ORGS="org1,org2:team1"

export OIDC_CONFIGURATION_URL="https://provider.com/.well-known/openid-configuration"
export OIDC_CLIENT_ID="your-oidc-client-id"
Expand Down