will/flynn
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

docs: align gateway auth docs with config schema

Browse Source
This commit is contained in:
William Valentin
2026-02-15 11:22:59 -08:00
parent e159476d31
commit 4e28ca7c8f
3 changed files with 28 additions and 9 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/api/PROTOCOL.md
+3 -3
View File
@@ -115,7 +115,7 @@ Common close codes:
### Bearer Token Auth
If `gateway.auth.token` is configured, all WebSocket connections must provide authentication:
If `server.token` is configured, all WebSocket connections must provide authentication:
```javascript
const ws = new WebSocket('ws://localhost:18800', {
@@ -127,7 +127,7 @@ const ws = new WebSocket('ws://localhost:18800', {
### Tailscale Identity
If `gateway.auth.trustTailscaleIdentity` is enabled, connections from Tailscale are trusted based on the `Tailscale-User-Login` header.
If `server.tailscale_identity` is enabled, connections from Tailscale are trusted based on the `Tailscale-User-Login` header.
```javascript
// Automatic when connecting via Tailscale
@@ -136,7 +136,7 @@ If `gateway.auth.trustTailscaleIdentity` is enabled, connections from Tailscale
### HTTP Auth
If `gateway.auth.applyToHttp` is `true` (default when token is set), HTTP requests also require bearer token:
If `server.auth_http` is `true` (default: true), HTTP requests also require bearer token when `server.token` is set:
```javascript
fetch('http://localhost:18800/api/health', {