MoQ is under active development. APIs and protocols may change between releases.

Media over QUIC

Quick Start ​

The default demo starts a relay, publishes a test video, and opens the web client. Everything runs on your machine.

First, clone the repository:

bash
git clone https://github.com/moq-dev/moq
cd moq

With Nix ​

Nix is the recommended setup because it uses the tool versions pinned by the repository. Install Nix with flakes enabled, then run:

bash
nix develop --command just

With nix-direnv, entering the repository loads the development shell and the command becomes just.

Without Nix ​

Install these tools first:

Then install the workspace tools and start the demo:

bash
just install
just

Some optional targets need additional system libraries. GStreamer development packages are required for moq-gst; a C toolchain is required for libmoq; and the language bindings need their respective toolchains. The Nix development shell includes these dependencies.

Windows users should follow the Windows setup. Linux packages for running released binaries are covered in the Linux guide.

What starts ​

The default recipe runs three components:

  1. moq-relay routes broadcasts between publishers and subscribers.
  2. moq-cli publishes a test video through the relay.
  3. The web demo opens at localhost:5173.

The local relay uses a generated certificate and fingerprint verification. A public deployment needs a stable hostname, trusted TLS certificate, and an open UDP port. See production deployment.

Next steps ​