From fa8965d197f8036b08eeeea767672e45e79d213e Mon Sep 17 00:00:00 2001 From: Vsevolod Strukchinsky Date: Mon, 29 Jun 2026 22:33:18 +0500 Subject: [PATCH] docs(relay): document WebTransport and remaining flags in usage 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 --- cmd/relay/README.md | 8 +++++++- 1 file changed, 7 insertions(+), 1 deletion(-) diff --git a/cmd/relay/README.md b/cmd/relay/README.md index f420d46..a1e4f23 100644 --- a/cmd/relay/README.md +++ b/cmd/relay/README.md @@ -9,7 +9,7 @@ No authentication — suitable for local development and testing. ## Usage ``` -relay [-addr host:port] [-cert file] [-key file] +relay [-addr host:port] [-cert file] [-key file] [-webtransport [-webtransport-path /moq]] ``` | Flag | Default | Description | @@ -17,6 +17,12 @@ relay [-addr host:port] [-cert file] [-key file] | `-addr` | `0.0.0.0:4433` | UDP address to listen on | | `-cert` | — | PEM certificate file. If omitted, an ephemeral self-signed cert is generated. | | `-key` | — | PEM private key file. Required when `-cert` is set. | +| `-webtransport` | `false` | Serve MOQT over WebTransport (HTTP/3) instead of raw QUIC. | +| `-webtransport-path` | `/moq` | HTTP/3 path for the WebTransport CONNECT (only used with `-webtransport`). | +| `-catalog-track-name` | `catalog` | Track name whose object cache uses `-catalog-ttl` instead of the default; empty disables the override. | +| `-catalog-ttl` | `0` | Per-object TTL for tracks matching `-catalog-track-name`; `0` means infinite retention (FIFO size cap still applies). | +| `-max-subscriptions` | `0` | Per-session cap on concurrent subscriptions (§13.1); `0` = unlimited. | +| `-max-namespace-requests` | `0` | Per-session cap on concurrent namespace requests (§13.7.1); `0` = unlimited. | ## Quick start