docs(readme): clarify OAuth as optional, document CONTAINER env var
Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
This commit is contained in:
@@ -143,14 +143,16 @@ GITEA_REPO1_ALIAS=mygitea
|
|||||||
|----------|----------|---------|-------------|
|
|----------|----------|---------|-------------|
|
||||||
| `MASTER_API_KEY` | Recommended | Auto-generated | Master API key for admin access |
|
| `MASTER_API_KEY` | Recommended | Auto-generated | Master API key for admin access |
|
||||||
| `LOG_LEVEL` | No | `INFO` | Logging level (DEBUG, INFO, WARNING, ERROR) |
|
| `LOG_LEVEL` | No | `INFO` | Logging level (DEBUG, INFO, WARNING, ERROR) |
|
||||||
| `OAUTH_JWT_SECRET_KEY` | For OAuth | — | JWT signing secret for OAuth tokens |
|
| `OAUTH_JWT_SECRET_KEY` | For OAuth | — | JWT secret for ChatGPT auto-registration (not needed for Claude/Cursor) |
|
||||||
| `OAUTH_BASE_URL` | For OAuth | — | Public URL (e.g., `https://mcp.example.com`) |
|
| `OAUTH_BASE_URL` | For OAuth | — | Public URL of your server (not needed for Claude/Cursor) |
|
||||||
| `OAUTH_JWT_ALGORITHM` | No | `HS256` | JWT algorithm |
|
| `OAUTH_JWT_ALGORITHM` | No | `HS256` | JWT algorithm |
|
||||||
| `OAUTH_ACCESS_TOKEN_TTL` | No | `3600` | Access token TTL in seconds |
|
| `OAUTH_ACCESS_TOKEN_TTL` | No | `3600` | Access token TTL in seconds |
|
||||||
| `OAUTH_REFRESH_TOKEN_TTL` | No | `604800` | Refresh token TTL in seconds |
|
| `OAUTH_REFRESH_TOKEN_TTL` | No | `604800` | Refresh token TTL in seconds |
|
||||||
| `OAUTH_STORAGE_TYPE` | No | `json` | Token storage type |
|
| `OAUTH_STORAGE_TYPE` | No | `json` | Token storage type |
|
||||||
| `OAUTH_STORAGE_PATH` | No | `/app/data` | Data directory path |
|
| `OAUTH_STORAGE_PATH` | No | `/app/data` | Data directory path |
|
||||||
|
|
||||||
|
> **OAuth** is only needed for ChatGPT Remote MCP auto-registration. For Claude Desktop, Claude Code, Cursor, and VS Code — just use `MASTER_API_KEY` with Bearer token auth.
|
||||||
|
|
||||||
**Plugin Site Configuration** — Pattern: `{PLUGIN_TYPE}_{SITE_ID}_{KEY}`
|
**Plugin Site Configuration** — Pattern: `{PLUGIN_TYPE}_{SITE_ID}_{KEY}`
|
||||||
|
|
||||||
| Plugin | Required Keys | Optional Keys |
|
| Plugin | Required Keys | Optional Keys |
|
||||||
@@ -165,6 +167,8 @@ GITEA_REPO1_ALIAS=mygitea
|
|||||||
| `APPWRITE` | `URL`, `API_KEY`, `PROJECT_ID` | `ALIAS` |
|
| `APPWRITE` | `URL`, `API_KEY`, `PROJECT_ID` | `ALIAS` |
|
||||||
| `DIRECTUS` | `URL`, `TOKEN` | `ALIAS` |
|
| `DIRECTUS` | `URL`, `TOKEN` | `ALIAS` |
|
||||||
|
|
||||||
|
> **CONTAINER**: Docker container name of your WordPress site. Optional for WordPress (enables WP-CLI tools like cache flush, transient management). **Required** for WordPress Advanced (all 22 tools use WP-CLI). Find your container: `docker ps --filter name=wordpress`. Also requires Docker socket mount.
|
||||||
|
|
||||||
**Example** — Multiple WordPress sites:
|
**Example** — Multiple WordPress sites:
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
|
|||||||
Reference in New Issue
Block a user