Skip to content

docs(relay): document WebTransport and remaining flags in usage #37

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
floatdrop merged 1 commit into from
Jun 29, 2026
Merged

docs(relay): document WebTransport and remaining flags in usage #37

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 7 additions & 1 deletion cmd/relay/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,14 +9,20 @@ 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 |
|------|---------|-------------|
| `-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

Expand Down