mediamtx-docs

Name: mediamtx-docs
Author: tomevault-io

Documentation Community

Repo stars 0
Author updated Live
Author repo skills-registry

Fluxly profile Facts only: domain, agents, trust score, runtime, permissions and network

Domain: Documentation
Compatible agents: Claude Code
Cursor
Cline
Codex
Windsurf
Gemini CLI

+20
Trust score: 88 / 100 · community maintained
Author / version / license: @tomevault-io · no license declared
Token usage: Moderate
Setup complexity: Manual integration
External API key: Not required
Operating systems: macOS · Docker
Runtime requirements: Python · Docker
Permissions: Read-only
Write / modify
Shell exec
Network behavior: External requests
Install commands: 26 variants

Profile is derived at build time from SKILL.md and install vectors. Subject to drift from author intent.

Heads up: 未限定 allowed-tools，默认拥有全部工具权限。

Output preview mediamtx-docs.preview

---
name: mediamtx-docs
description: > Use when this capability is needed. uv run ${CLAUDESKILLDIR}/scripts/mtxdocs.py list-pages Top…
category: documentation
runtime: Python / Docker
---

# mediamtx-docs output preview

## PART A: Task fit
- Use case: > Use when this capability is needed. uv run ${CLAUDESKILLDIR}/scripts/mtxdocs.py list-pages Top-level families: | Family | When to pick | | kickoff/* | Install, upgrade, first-run. | makes outbound network calls; runs on Python. Works with Claude Code, Cursor, Cline and 23 more..
- Inputs: target material, constraints, expected output, and acceptance criteria.
- Evidence boundary: follow “Quick start / When to use / Step 1 — Know the page catalog” and do not present inference as author intent.

## PART B: Execution result
- **01** The card summarizes the use case; runtime output centers on “> Use when this capability is needed. uv run ${CLAUDESKILLDIR}/scripts/mtxdocs.py list-pages Top-level families: | Family | When to pick | | kickoff/* | Install, upgrade, first-run. | makes outbound network calls; runs on Python. Works with Claude Code, Cursor, Cline and 23 more.”.
- **02** When the source has headings, the agent prioritizes “Quick start / When to use / Step 1 — Know the page catalog” so the result follows the author’s structure.
- **03** Typical output includes task judgment, concrete steps, required commands or file edits, validation, and follow-up options.
- **04** Risk context follows the fingerprint: read files, write/modify files, run shell commands; may access external network resources; usually needs no extra API key.

## Running Rules
- read files, write/modify files, run shell commands; may access external network resources; usually needs no extra API key.
- Validate with a small sample before expanding scope.
- Return the result, validation criteria, and next iteration options.

SKILL.md SKILL.md

---
name: mediamtx-docs
description: > Use when this capability is needed. uv run ${CLAUDESKILLDIR}/scripts/mtxdocs.py list-pages Top…
category: documentation
source: tomevault-io/skills-registry
---

# mediamtx-docs

## When to use
- > Use when this capability is needed. uv run ${CLAUDESKILLDIR}/scripts/mtxdocs.py list-pages Top-level families: | Fam…
- Use it when the task has clear inputs, repeatable steps, and validation criteria.

## What to provide
- Target material, scope, expected result, and forbidden changes.
- Whether network, commands, file writes, or external services are allowed.

## Execution rules
- Organize steps around “Quick start / When to use / Step 1 — Know the page catalog” and keep inference separate from source facts.
- read files, write/modify files, run shell commands; may access external network resources; usually needs no extra API key.
- Validate with a small sample before expanding the task.

## Output requirements
- Return the deliverable, key evidence, validation method, and next action.
- Mark missing information as unknown; do not invent commands, platforms, or dependencies.

Evidence boundary and execution chain

The author source anchors workflow facts; repository files anchor sources and commands; Fluxly only adds fit, limitations, and quality judgment.

skill "mediamtx-docs" {
  input      -> user goal + target files + boundaries + acceptance criteria
  context    -> Quick start / When to use / Step 1 — Know the page catalog
  rules      -> SKILL.md triggers / order / output contract
  runtime    -> Python / Docker | read files, write/modify files, run shell commands | may access external network resources
  guardrails -> usually needs no extra API key + small-sample validation + diff/log review
  output     -> copyable result + checklist + next iteration
}

Interpretation is structured for decision-making; original keeps the upstream SKILL.md unchanged.

Decide Fit First

Core job: > Use when this capability is needed. uv run ${CLAUDESKILLDIR}/scripts/mtxdocs.py list-pages Top-level families: | Family | When…
Best fit: Use it when the task has reusable inputs, steps, and validation criteria rather than a one-off answer.
Avoid forcing it: If the source lacks commands, platform support, or external-service evidence, keep those fields unknown instead of guessing.

Design Intent

Structure: The skill is organized around “Quick start”, “When to use”, “Step 1 — Know the page catalog”, “Step 2 — Search first”, showing how the author expects the agent to judge fit, collect context, and produce verifiable output.
Trigger evidence: Prioritize the author’s wording around when to use it, what context to collect, and what output shape to produce.
Evidence boundary: Author text states facts, repository files prove commands and paths, and Fluxly only adds fit, limits, and usage judgment.

How To Use It

Inputs: Provide target material, scope, expected result, forbidden changes, and validation method.
Invocation: Name mediamtx-docs directly; if the source includes slash commands, start with the command and then add task context.
Validation: Start small and check whether the result follows “Quick start / When to use / Step 1 — Know the page catalog” before expanding.

Boundaries And Review

Dependencies: It usually needs no extra API key, so start with a small validation task.
Permissions: Declared permissions include read / write / shell-exec; ask the agent to state file, command, and rollback boundaries before acting.
Quality bar: A useful result names the deliverable, evidence, and next action. Generic prose means the task needs tighter context.

MediaMTX Docs

Context: $ARGUMENTS

Quick start

Find a config key / API endpoint / feature: -> Step 2 (search --query <term>)
Read a how-to in full: -> Step 4 (fetch --page <publish/X or read/X>)
Read one section: -> Step 3 (section --page <page> --id <anchor>)
Prime cache for offline: -> Step 5 (index)

When to use

User asks "how do I push RTSP to MediaMTX?" or "how do I configure JWT auth?" or "what control-api endpoints exist?"
Need to verify a MediaMTX config key or CLI flag before recommending it.
Need the canonical mediamtx.org URL to cite.
Before wiring up a publisher/reader, confirm the protocol endpoint and default port (RTSP 8554, RTMP 1935, HLS 8888, WebRTC 8889, SRT 8890, API 9997, Metrics 9998, pprof 9999).
For the running-server wrapper + API calls, see the mediamtx-server skill.

Step 1 — Know the page catalog

uv run ${CLAUDE_SKILL_DIR}/scripts/mtxdocs.py list-pages

Top-level families:

Family	When to pick
`kickoff/*`	Install, upgrade, first-run.
`features/*`	Core concepts (publish, read, record, playback, auth, hooks, metrics).
`features/<proto>-specific-features`	Per-protocol options (`rtsp-specific-features`, `rtmp-specific-features`, `webrtc-specific-features`, `srt-specific-features`).
`features/configuration` + `features/control-api` + `features/logging` + `features/metrics`	Operational — the knobs you actually turn in production.
`references/configuration-file`	Authoritative list of every YAML option. Start here for config questions.
`references/control-api`	Authoritative list of every `/v3/*` endpoint.
`publish/<client>`	How to SEND a stream in via ffmpeg / gstreamer / OBS / Python / Go / Unity / etc.
`read/<client>`	How to PLAY a stream out via ffmpeg / gstreamer / VLC / OBS / browsers / etc.
`github-readme`, `github-mediamtx.yml`, `github-apidocs`	Raw upstream files — the ground truth when mediamtx.org is behind.

Read references/pages.md for the full catalog.

Step 2 — Search first

uv run ${CLAUDE_SKILL_DIR}/scripts/mtxdocs.py search --query "recordFormat" --limit 5
uv run ${CLAUDE_SKILL_DIR}/scripts/mtxdocs.py search --query "jwt" --page features/authentication
uv run ${CLAUDE_SKILL_DIR}/scripts/mtxdocs.py search --query "/v3/paths" --page references/control-api

Use --regex for anchored patterns. Each hit prints page:line, nearest heading, canonical URL, and ±3 lines of context.

Step 3 — Read one section

When a hit surfaces [§anchor]:

uv run ${CLAUDE_SKILL_DIR}/scripts/mtxdocs.py section --page features/authentication --id internal-users
uv run ${CLAUDE_SKILL_DIR}/scripts/mtxdocs.py section --page references/configuration-file --id paths

--id also accepts a heading keyword as fallback.

Step 4 — Fetch a whole page

Use sparingly — howto pages are compact enough to fetch whole when you actually need the full recipe:

uv run ${CLAUDE_SKILL_DIR}/scripts/mtxdocs.py fetch --page publish/ffmpeg
uv run ${CLAUDE_SKILL_DIR}/scripts/mtxdocs.py fetch --page read/web-browsers
uv run ${CLAUDE_SKILL_DIR}/scripts/mtxdocs.py fetch --page github-mediamtx.yml   # raw upstream YAML

--format json for structured handoff.

Step 5 — Prime cache

uv run ${CLAUDE_SKILL_DIR}/scripts/mtxdocs.py index

Fetches every known page (~70 URLs) at 0.3s each. Override cache dir via MEDIAMTX_DOCS_CACHE. Clear with clear-cache.

Gotchas

MediaMTX does NOT transcode — it remuxes only. If a publisher pushes HEVC into a path and a reader asks for WebRTC in the browser, the reader will FAIL (browsers don't universally support HEVC in WebRTC). The docs page features/remuxing-reencoding-compression is explicit: for transcoding, chain an external ffmpeg publisher. When in doubt, publish as H.264 + Opus.
The binary is now mediamtx (was rtsp-simple-server). Repo moved from aler9/rtsp-simple-server -> bluenviron/mediamtx. Old Docker tags and install scripts still float around the internet; ignore them.
Default ports you'll see quoted in docs: RTSP 8554, RTSPS 8322, RTMP 1935, RTMPS 1936, HLS 8888, WebRTC 8889, SRT 8890, Control API 9997, Metrics 9998, pprof 9999, Playback 9996. Each is a separate listener; disable any you don't need in mediamtx.yml.
Three auth backends, exclusive. internal (users in YAML under authInternalUsers), http (POST to an external endpoint), jwt (verify a bearer token via JWK URL or static secret). You can't mix them globally — but per-path permissions still apply. See features/authentication.
Auth actions: publish, read, playback, api, metrics, pprof. Default allowed users have all which is shorthand for the union. Lock down production before exposing port 9997.
Hooks fire on path events, not on connection events. runOnInit runs when the path is first registered, not when a client connects. runOnDemand is what you want for lazy pipelines. Read features/hooks.
always-available vs on-demand-publishing. Set sourceOnDemand: true to start source: only when readers appear (saves bandwidth). sourceOnDemandStartTimeout + sourceOnDemandCloseAfter control how long MediaMTX waits / keeps source alive after the last reader.
Control API lives at /v3/*, NOT /v2/* or /v1/*. Older tutorials reference v2; the v3 namespace is the current stable. Full endpoint list is on references/control-api.
HLS has two variants: "HLS" (standard, .ts segments, ~6s latency) and "Low-Latency HLS" (LL-HLS, fMP4 partial segments, ~2s latency). Configurable per path via hlsVariant.
WebRTC signalling is WHIP/WHEP over HTTP at http://<host>:8889/<path>/whip (publish) and .../whep (read). Default ICE servers + STUN config live at the global level; per-path overrides are NOT supported.
SRT uses the "stream ID" trick for path routing. srt://host:8890?streamid=publish:<path>:<user>:<pass> to publish; srt://host:8890?streamid=read:<path>:<user>:<pass> to read. Quotes required in most shells.
recordFormat: fmp4 is the default and what you want. MPEG-TS recording is deprecated for most cases because it can't seek.
Config file hot-reloads on SIGHUP, but some settings (listening ports, TLS certs) require a full restart. If a change "doesn't seem to take", restart the process.
Docs site pagination is Next.js SSR; anchors are Markdown-slugified headings (#internal-users, #authentication-methods). The section --id command accepts either the raw slug or a heading keyword.
Raw upstream YAML is the final authority. github-mediamtx.yml page returns the exact mediamtx.yml shipped in main with every default documented inline. When mediamtx.org lags a release, this is the ground truth.

Examples

Example 1 — "What do I put in mediamtx.yml to enable JWT auth?"

uv run ${CLAUDE_SKILL_DIR}/scripts/mtxdocs.py search --query "jwt" --page features/authentication --limit 5
uv run ${CLAUDE_SKILL_DIR}/scripts/mtxdocs.py section --page features/authentication --id jwt

Example 2 — "How do I publish with ffmpeg?"

uv run ${CLAUDE_SKILL_DIR}/scripts/mtxdocs.py fetch --page publish/ffmpeg

Example 3 — "What's the full list of control-api endpoints?"

uv run ${CLAUDE_SKILL_DIR}/scripts/mtxdocs.py fetch --page references/control-api

Example 4 — "What does `runOnDemandCloseAfter` default to?"

uv run ${CLAUDE_SKILL_DIR}/scripts/mtxdocs.py search --query "runOnDemandCloseAfter" --page github-mediamtx.yml --limit 3

(Upstream YAML has inline defaults — faster than the HTML docs here.)

Example 5 — "Record to disk, rotate every 15 min, keep 4 hours"

uv run ${CLAUDE_SKILL_DIR}/scripts/mtxdocs.py search --query "recordSegmentDuration" --page features/record
uv run ${CLAUDE_SKILL_DIR}/scripts/mtxdocs.py search --query "recordDeleteAfter" --page features/record

Example 6 — "WebRTC publish from a browser — what's the WHIP URL?"

uv run ${CLAUDE_SKILL_DIR}/scripts/mtxdocs.py fetch --page publish/web-browsers

Troubleshooting

Error: `unknown page: foo`

Cause: The name isn't in the catalog. Solution: Run list-pages. Common mistakes: using record instead of features/record; api instead of references/control-api.

Error: `urlopen error [SSL: CERTIFICATE_VERIFY_FAILED]`

Cause: System certificate store is out of date (usually macOS Python). Solution: Run /Applications/Python\ 3.x/Install\ Certificates.command or set SSL_CERT_FILE. Don't patch SSL verification off.

Search returns zero hits for a config key

Cause: Key might be new in main but not yet in the published docs. Solution: Search against the upstream YAML — search --query "<key>" --page github-mediamtx.yml. The upstream file is the source of truth.

Results look like broken-up tables

Cause: The HTML extractor flattens cell borders into pipes but can't reconstruct multi-line cells. Solution: The search-hit header prints the canonical URL. Open it directly in a browser for the authoritative view.

Cache stale after MediaMTX release

Solution: clear-cache then index. The GitHub fallback pages already track main — if you want a specific release tag, edit the github-* URLs in the script's PAGES dict (or fetch directly with urllib).

Reference docs

Full page catalog with protocol-to-page cross reference -> references/pages.md

Source: damionrashford/media-os — distributed by TomeVault.

Install command

One-click installPick a runner, click Copy, paste into your terminal, press enter

npx skills add tomevault-io/skills-registry/damionrashford--media-os--mediamtx-docs -y

Open general install guide

View skill source

Works with

Claude Code
Cursor
Cline
Codex
Windsurf
Gemini
OpenCode
Roo Code
AAide
+Augment
GitHub Copilot
OpenClaw
KKiro
Junie
WWarp
Goose
Trae
Kilo Code
OpenHands
Amp
Zencoder
CContinue
AIAider
CodeBuddy
CodeGeeX
Replit Agent

Security audit

88 / 100

Community

未声明 license/许可。
未声明 version。
未限定 allowed-tools，默认拥有全部工具权限。

Metadata

Source: github
tomevault-io/skills-registry
中文

More by @tomevault-io

Category & tags

Category Documentation