mediamtx docs

Documentation Community

Skill notes

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).

Step 1 — Know the page catalog

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).

Step 2 — Search first

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]: --id also accepts a heading keyword as fallback.

Fluxly profile Runtime and permissions are inferred by Fluxly static checks, not author declarations or runtime test results.
Domain
Documentation
Author-declared agents
No explicit declaration found; this is not inferred or tested compatibility
Static check
88 / 100 · heuristic scan, not runtime safety proof
Runtime evidence
Not run; no isolated runtime test evidence is currently recorded
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
Detected file/system behavior
  • Read-only
  • Write / modify
  • Shell exec
Network behavior
External requests
Install commands
None (reference only)

Heads up: Tool permissions are not declared; actual access depends on the runtime.

01
Step 1 — Know the page catalog

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`).

02
Step 2 — Search first

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

03
Step 3 — Read one section

When a hit surfaces `[§anchor]`: `--id` also accepts a heading keyword as fallback.

04
Step 4 — Fetch a whole page

Use sparingly — howto pages are compact enough to fetch whole when you actually need the full recipe: `--format json` for structured handoff.

05
Step 5 — Prime cache

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

Discussion

Powered by GitHub Discussions. Sign in with GitHub to comment, react, or subscribe.