Skip to content

moqtail/moqtail

Repository files navigation

MOQtail

Rust Checks JavaScript Checks License: Apache-2.0 GHCR Relay Image

Draft 14 Media-over-QUIC libraries and relay components.
Rust and TypeScript tooling for publishers, subscribers, demos, and relay deployments.

MOQtail

MOQtail is a Draft 14-compliant MOQT toolkit for building publisher, subscriber, and relay applications. The repository includes Rust and TypeScript libraries, reference clients, and a relay that can be run locally or pulled as a container image from GHCR.

Components

moqtail-ts

The TypeScript library targets browser and WebTransport-based MoQ applications.

Highlights:

  • Type-safe application APIs
  • WebTransport integration
  • Client-side development workflow with the demo app

Library documentation: libs/moqtail-ts/README.md

moqtail-rs

The Rust library provides the core protocol implementation and utilities used by the relay and other Rust applications in this workspace.

Library documentation: libs/moqtail-rs/README.md

Relay

The relay is the deployable Rust service that forwards MoQ messages between publishers and subscribers.

Local run:

cargo run -p relay -- --port 4433 --cert-file apps/relay/cert/cert.pem --key-file apps/relay/cert/key.pem

Container image:

docker run --rm \
	-p 4433:4433/udp \
	-v "$PWD/apps/relay/cert/cert.pem:/certs/cert.pem:ro" \
	-v "$PWD/apps/relay/cert/key.pem:/certs/key.pem:ro" \
	ghcr.io/moqtail/relay:latest

Release images are published to ghcr.io/moqtail/relay with latest and version tags from relay@* releases. Branch and commit SHA tags are also published for CI builds.

To build the image locally from the workspace root:

docker build -f apps/relay/Dockerfile -t moqtail-relay .

For local certificate generation and browser trust setup, see apps/relay/cert/README.md.

Getting Started

Prerequisites

Installation

git clone https://github.com/moqtail/moqtail.git
cd moqtail
npm install

Contributing

Contributions are welcome. Open an issue or submit a pull request for improvements, bug fixes, documentation, or interoperability work.

About

Draft 14-compliant MOQ Transport (MOQT) protocol libraries for publisher, subscriber and relay components, featuring real-time, live and on-demand demo applications using the LOC and CMSF formats.

Topics

Resources

License

Contributing

Stars

Watchers

Forks

Packages

 
 
 

Contributors