Skip to content

Commit 933a443

Browse files
authored
Merge pull request #199 from englishm-cloudflare/me/readme-update-protocol-support
2 parents d78a063 + ff21e7d commit 933a443

2 files changed

Lines changed: 16 additions & 16 deletions

File tree

README.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,11 @@ This codebase was originally created by [Luke Curley (@kixelated)](https://githu
88
99
## Protocol Support
1010

11-
The `main` branch targets **draft-16** of the MoQT specification. For draft-07 compatibility (used in [Cloudflare's current production deployment](https://developers.cloudflare.com/moq/)), see the [`draft-ietf-moq-transport-07`](https://github.com/cloudflare/moq-rs/tree/draft-ietf-moq-transport-07) branch.
11+
The `main` branch targets **draft-16** of the MoQT specification and is the basis for Cloudflare's production deployment. Cloudflare currently runs draft-14 and draft-16 relays globally. See the [Cloudflare MoQ developer docs](https://developers.cloudflare.com/moq/) for endpoint URLs, provisioning, and a full feature matrix.
12+
13+
Other branches:
14+
- [`draft-ietf-moq-transport-14`](https://github.com/cloudflare/moq-rs/tree/draft-ietf-moq-transport-14) — draft-14 maintenance branch
15+
- [`draft-18-dev`](https://github.com/cloudflare/moq-rs/tree/draft-18-dev) — early draft-18 development
1216

1317
### What's Included
1418

@@ -29,16 +33,12 @@ This repository provides:
2933
- Both stream ("subgroup") and datagram delivery modes
3034

3135
**Not Supported:**
32-
- FETCH (Not Soon)
36+
- FETCH
37+
- GOAWAY
3338

3439
## Interoperability
3540

36-
A public relay instance running the latest `main` branch is available for interop testing at:
37-
```
38-
https://interop-relay.cloudflare.mediaoverquic.com:443
39-
```
40-
41-
As an implementation targeting the IETF specification, this codebase should be compatible with other implementations targeting the same draft version. See the [moq-wg/moq-transport wiki](https://github.com/moq-wg/moq-transport/wiki/Interop) for a list of other implementations.
41+
This codebase is compatible with other MoQT implementations targeting the same draft version. See the [moq-wg/moq-transport wiki](https://github.com/moq-wg/moq-transport/wiki/Interop) for a list of implementations, and the [moq-interop-runner](https://github.com/englishm/moq-interop-runner) for interop test tooling and a registry of public relay endpoints across draft versions.
4242

4343
For streaming format compatibility:
4444
- **[video-dev/moq-js](https://github.com/video-dev/moq-js)**: A TypeScript player implementation compatible with moq-pub's fMP4 output. Check draft version compatibility when selecting branches.

deploy/MLOG_SETUP.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -6,13 +6,13 @@ Where QUIC qlog (see [QLOG_SETUP.md](QLOG_SETUP.md)) captures transport-layer ev
66

77
## Quick Start: Verify Your Messages Reached the Relay
88

9-
This walkthrough uses `moq-test-client` against the public interop relay to demonstrate the basics. You can adapt the same technique for your own client.
9+
This walkthrough uses `moq-test-client` against a public interop relay to demonstrate the basics. The URL below is an example — check the [moq-interop-runner registry](https://github.com/englishm/moq-interop-runner/blob/main/implementations.json) for current endpoints. You can adapt the same technique for your own relay.
1010

1111
### Step 1: Run a test
1212

1313
```bash
1414
cargo run --bin moq-test-client -- \
15-
--relay https://interop-relay.cloudflare.mediaoverquic.com:443 \
15+
--relay https://draft-18-interop.cloudflare.mediaoverquic.com:443 \
1616
--tls-disable-verify \
1717
--test setup-only
1818
```
@@ -32,7 +32,7 @@ ok 1 - setup-only
3232
### Step 3: Fetch your mlog
3333

3434
```bash
35-
curl https://interop-relay.cloudflare.mediaoverquic.com:443/mlog/22c73802597dcd91ef662a3cd67a03e0
35+
curl https://draft-18-interop.cloudflare.mediaoverquic.com:443/mlog/22c73802597dcd91ef662a3cd67a03e0
3636
```
3737

3838
### Step 4: Read the results
@@ -58,7 +58,7 @@ The simplest test: connect, exchange CLIENT_SETUP/SERVER_SETUP, disconnect.
5858

5959
```bash
6060
cargo run --bin moq-test-client -- \
61-
--relay https://interop-relay.cloudflare.mediaoverquic.com:443 \
61+
--relay https://draft-18-interop.cloudflare.mediaoverquic.com:443 \
6262
--tls-disable-verify \
6363
--test setup-only
6464
```
@@ -106,7 +106,7 @@ After SETUP, announce a namespace and verify the relay accepts it.
106106

107107
```bash
108108
cargo run --bin moq-test-client -- \
109-
--relay https://interop-relay.cloudflare.mediaoverquic.com:443 \
109+
--relay https://draft-18-interop.cloudflare.mediaoverquic.com:443 \
110110
--tls-disable-verify \
111111
--test publish-namespace-only
112112
```
@@ -156,7 +156,7 @@ This test uses two connections: a publisher and a subscriber. The test client re
156156

157157
```bash
158158
cargo run --bin moq-test-client -- \
159-
--relay https://interop-relay.cloudflare.mediaoverquic.com:443 \
159+
--relay https://draft-18-interop.cloudflare.mediaoverquic.com:443 \
160160
--tls-disable-verify \
161161
--test publish-namespace-subscribe
162162
```
@@ -176,10 +176,10 @@ Fetch both mlogs to see each side of the exchange:
176176

177177
```bash
178178
# Publisher's view
179-
curl https://interop-relay.cloudflare.mediaoverquic.com:443/mlog/71d4b5eb1a807779af03331c330d5fa9
179+
curl https://draft-18-interop.cloudflare.mediaoverquic.com:443/mlog/71d4b5eb1a807779af03331c330d5fa9
180180

181181
# Subscriber's view
182-
curl https://interop-relay.cloudflare.mediaoverquic.com:443/mlog/08d0b03ede133f0839435bff64ed2fc5
182+
curl https://draft-18-interop.cloudflare.mediaoverquic.com:443/mlog/08d0b03ede133f0839435bff64ed2fc5
183183
```
184184

185185
**Publisher mlog** (after SETUP):

0 commit comments

Comments
 (0)