Skip to content

Commit c882b5a

Browse files
floatdropclaude
andauthored
docs(relay): document WebTransport and remaining flags in usage (#37)
The Usage section only listed -addr/-cert/-key, omitting -webtransport and -webtransport-path (referenced later in the interop section) plus the catalog and per-session cap flags. Round out the flag table to match cmd/relay/main.go. Co-authored-by: Claude Opus 4.8 <noreply@anthropic.com>
1 parent ebc489c commit c882b5a

1 file changed

Lines changed: 7 additions & 1 deletion

File tree

cmd/relay/README.md

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,14 +9,20 @@ No authentication — suitable for local development and testing.
99
## Usage
1010

1111
```
12-
relay [-addr host:port] [-cert file] [-key file]
12+
relay [-addr host:port] [-cert file] [-key file] [-webtransport [-webtransport-path /moq]]
1313
```
1414

1515
| Flag | Default | Description |
1616
|------|---------|-------------|
1717
| `-addr` | `0.0.0.0:4433` | UDP address to listen on |
1818
| `-cert` || PEM certificate file. If omitted, an ephemeral self-signed cert is generated. |
1919
| `-key` || PEM private key file. Required when `-cert` is set. |
20+
| `-webtransport` | `false` | Serve MOQT over WebTransport (HTTP/3) instead of raw QUIC. |
21+
| `-webtransport-path` | `/moq` | HTTP/3 path for the WebTransport CONNECT (only used with `-webtransport`). |
22+
| `-catalog-track-name` | `catalog` | Track name whose object cache uses `-catalog-ttl` instead of the default; empty disables the override. |
23+
| `-catalog-ttl` | `0` | Per-object TTL for tracks matching `-catalog-track-name`; `0` means infinite retention (FIFO size cap still applies). |
24+
| `-max-subscriptions` | `0` | Per-session cap on concurrent subscriptions (§13.1); `0` = unlimited. |
25+
| `-max-namespace-requests` | `0` | Per-session cap on concurrent namespace requests (§13.7.1); `0` = unlimited. |
2026

2127
## Quick start
2228

0 commit comments

Comments
 (0)