Skip to content

Commit 8fca207

Browse files
committed
feat(docs): add repository options for SQL backends in configuration
1 parent 655c191 commit 8fca207

1 file changed

Lines changed: 20 additions & 0 deletions

File tree

docs/docs/configuration.md

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -93,6 +93,26 @@ You can use both exact matching and glob patterns for OIDC user authorization:
9393
| `--tls-listen` | `TLS_LISTEN` | `:443` | Address to listen on for TLS |
9494
| `--data-path` | `DATA_PATH` | `./data` | Path to the data directory |
9595

96+
### Repository Options
97+
98+
| Option | Environment Variable | Default | Description |
99+
| ----------------------- | --------------------- | ------- | --------------------------------------------------------------------------------------------------------------------- |
100+
| `--repository-backend` | `REPOSITORY_BACKEND` | `local` | Storage backend for OAuth state. Supported values: `local` (embedded BoltDB), `sqlite`, `postgres`, or `mysql`. |
101+
| `--repository-dsn` | `REPOSITORY_DSN` | - | Connection string passed directly to the SQL driver. Required when `--repository-backend` is `sqlite/postgres/mysql`. |
102+
103+
`local` uses an embedded BoltDB file under `--data-path`. SQL backends run migrations automatically via GORM; the DSN must be valid for the chosen driver (examples below). The deprecated value `sql` is no longer accepted—select the concrete driver instead.
104+
105+
```bash title="DSN examples"
106+
# sqlite
107+
--repository-backend sqlite --repository-dsn "file:data/mcp-auth.db?cache=shared&mode=rwc"
108+
109+
# postgres
110+
--repository-backend postgres --repository-dsn "postgres://user:pass@hostname:5432/database?sslmode=disable"
111+
112+
# mysql
113+
--repository-backend mysql --repository-dsn "user:pass@tcp(hostname:3306)/database?parseTime=true"
114+
```
115+
96116
### Proxy Options
97117

98118
| Option | Environment Variable | Default | Description |

0 commit comments

Comments
 (0)