docs: migrate majestic config examples from yaml-cli to the HTTP API - #477
Merged
Conversation
Replace the deprecated `cli` / `yaml-cli` config-editing examples with Majestic's HTTP API, which applies a change to the running streamer and saves it to /etc/majestic.yaml in a single step (no `killall -HUP` needed): - single setting -> GET /api/v1/set?key=value - multiple settings -> pretty JSON heredoc POSTed to /api/v1/config, grouped the way the keys nest in the config file Verified the heredoc idiom on a hi3516ev300 (BusyBox v1.36.1 ash + curl 7.76.0): the POST applies live and persists, and the quoted <<'EOF' delimiter keeps %-format record paths intact byte-for-byte. Touches majestic-streamer, fpv-audio, fpv-mavfwd, howto-frigate-integration, device-foscam-x5, device-tapo-c110, firmware-sensor-install-sc223a, the tools index (marks yaml-cli deprecated for Majestic), and the ru/ action-camera, hiwatch-ds-i122, and rostelecom-ipc-hdw1230sp_v3 guides. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Migrates every Majestic configuration example in the wiki from the deprecated
cli/yaml-clifile-editing tool to Majestic's HTTP API. The API applies a change to the running streamer and saves it to/etc/majestic.yamlin a single step, so the oldkillall -HUP majesticreload step is no longer needed.Conventions used
curl 'http://localhost/api/v1/set?key=value'(dotted key, no leading dot)/api/v1/configvia a<<'EOF'heredoc, grouped the same way the keys nest in the config fileThe old
cli/yaml-cliidiom is called out as deprecated inmajestic-streamer.mdand the tools index.Verified on hardware
Ran the exact heredoc idiom on a hi3516ev300 (BusyBox v1.36.1
ash, curl 7.76.0):POST /api/v1/configwith a JSON body → applied live and persisted to/etc/majestic.yaml<<'EOF'delimiter preserves%,$, and backticks literally, so%Y-style record paths round-trip byte-for-byteFiles
majestic-streamer,fpv-audio,fpv-mavfwd,howto-frigate-integration,device-foscam-x5,device-tapo-c110,firmware-sensor-install-sc223a,menu-index, and the Russianaction-camera,hiwatch-ds-i122,rostelecom-ipc-hdw1230sp_v3guides.🤖 Generated with Claude Code