diff --git a/.github/workflows/docker.yml b/.github/workflows/docker.yml index 1eaa779ebf1..e2460ba7f31 100644 --- a/.github/workflows/docker.yml +++ b/.github/workflows/docker.yml @@ -4,12 +4,11 @@ on: push: tags: - 'moq-relay-v*' - - 'moq-clock-v*' - 'moq-cli-v*' - 'moq-token-cli-v*' env: - REGISTRY: docker.io/kixelated + REGISTRY: docker.io/moqdev jobs: deploy: diff --git a/doc/app/cli.md b/doc/app/cli.md index 586227f02fa..36376c28690 100644 --- a/doc/app/cli.md +++ b/doc/app/cli.md @@ -28,11 +28,11 @@ nix build github:moq-dev/moq#moq-cli ### Using Docker ```bash -docker pull kixelated/moq-cli -docker run -v "$(pwd)/video.mp4:/app/video.mp4:ro" kixelated/moq-cli publish /app/video.mp4 https://relay.example.com/anon/stream +docker pull moqdev/moq-cli +docker run -v "$(pwd)/video.mp4:/app/video.mp4:ro" moqdev/moq-cli publish /app/video.mp4 https://relay.example.com/anon/stream ``` -Multi-arch images (`linux/amd64` and `linux/arm64`) are published to [Docker Hub](https://hub.docker.com/r/kixelated/moq-cli). +Multi-arch images (`linux/amd64` and `linux/arm64`) are published to [Docker Hub](https://hub.docker.com/r/moqdev/moq-cli). ### From Source diff --git a/doc/app/relay/index.md b/doc/app/relay/index.md index 5f0938b9bdf..fe9616fb018 100644 --- a/doc/app/relay/index.md +++ b/doc/app/relay/index.md @@ -50,11 +50,11 @@ nix build github:moq-dev/moq#moq-relay ### Using Docker ```bash -docker pull kixelated/moq-relay -docker run -p 4443:4443/udp -v "$(pwd)/relay.toml:/app/relay.toml:ro" kixelated/moq-relay -- --config /app/relay.toml +docker pull moqdev/moq-relay +docker run -p 4443:4443/udp -v "$(pwd)/relay.toml:/app/relay.toml:ro" moqdev/moq-relay -- --config /app/relay.toml ``` -Multi-arch images (`linux/amd64` and `linux/arm64`) are published to [Docker Hub](https://hub.docker.com/r/kixelated/moq-relay). +Multi-arch images (`linux/amd64` and `linux/arm64`) are published to [Docker Hub](https://hub.docker.com/r/moqdev/moq-relay). ## Configuration diff --git a/doc/rs/crate/moq-token.md b/doc/rs/crate/moq-token.md index c567b12383e..43718cdbecb 100644 --- a/doc/rs/crate/moq-token.md +++ b/doc/rs/crate/moq-token.md @@ -50,11 +50,11 @@ nix build github:moq-dev/moq#moq-token-cli #### Using Docker ```bash -docker pull kixelated/moq-token-cli -docker run -v "$(pwd):/app" -w /app kixelated/moq-token-cli --key root.jwk generate +docker pull moqdev/moq-token-cli +docker run -v "$(pwd):/app" -w /app moqdev/moq-token-cli --key root.jwk generate ``` -Multi-arch images (`linux/amd64` and `linux/arm64`) are published to [Docker Hub](https://hub.docker.com/r/kixelated/moq-token-cli). +Multi-arch images (`linux/amd64` and `linux/arm64`) are published to [Docker Hub](https://hub.docker.com/r/moqdev/moq-token-cli). ## CLI Usage diff --git a/rs/moq-cli/README.md b/rs/moq-cli/README.md new file mode 100644 index 00000000000..3009e0d633e --- /dev/null +++ b/rs/moq-cli/README.md @@ -0,0 +1,32 @@ +# moq-cli + +A command-line tool for publishing and subscribing to media over MoQ. +It works with FFmpeg for encoding. + +## Install + +```bash +cargo install moq-cli +``` + +### Docker + +```bash +docker pull moqdev/moq-cli +``` + +Multi-arch images (`linux/amd64` and `linux/arm64`) are published to [Docker Hub](https://hub.docker.com/r/moqdev/moq-cli). + +## Usage + +### Publish a Video File + +```bash +moq-cli publish video.mp4 https://relay.example.com/anon/my-stream +``` + +### Publish from FFmpeg + +```bash +ffmpeg -i input.mp4 -f mpegts - | moq-cli publish - https://relay.example.com/anon/my-stream +``` diff --git a/rs/moq-relay/README.md b/rs/moq-relay/README.md index 217a76856a7..0aba55484e3 100644 --- a/rs/moq-relay/README.md +++ b/rs/moq-relay/README.md @@ -6,6 +6,20 @@ It's designed to be run in a datacenter, relaying media across multiple hops to The only argument is the path to a TOML configuration file. See [localhost.toml](../../demo/relay/localhost.toml) for an example configuration. +## Install + +```bash +cargo install moq-relay +``` + +### Docker + +```bash +docker pull moqdev/moq-relay +``` + +Multi-arch images (`linux/amd64` and `linux/arm64`) are published to [Docker Hub](https://hub.docker.com/r/moqdev/moq-relay). + ## HTTP Primarily for debugging, you can also connect to the relay via HTTP. diff --git a/rs/moq-token-cli/README.md b/rs/moq-token-cli/README.md index 84ffc389e90..8b8ae46936d 100644 --- a/rs/moq-token-cli/README.md +++ b/rs/moq-token-cli/README.md @@ -1,7 +1,21 @@ -# moq-token +# moq-token-cli A simple JWT-based authentication scheme for moq-relay. +## Install + +```bash +cargo install moq-token-cli +``` + +### Docker + +```bash +docker pull moqdev/moq-token-cli +``` + +Multi-arch images (`linux/amd64` and `linux/arm64`) are published to [Docker Hub](https://hub.docker.com/r/moqdev/moq-token-cli). + ## Quick Usage (symmetric keys) ```bash