docs: add OpenRTMP and NOALBS JSON statistics guide

[AlexanderWagnerDev]

What changed

• adds a task-focused guide at /guides/openrtmp-noalbs-json-stats/
• documents the released native OpenRTMP provider in NOALBS v2.19.0 and newer
• explains publish_key, play_key, and stats_key
• covers the native /stats?key=... JSON endpoint and /stats-nginx?key=... fallback
• includes a complete NOALBS configuration with bitrate and RTT triggers
• documents key redaction, Docker/internal host selection, and 401/404/502 troubleshooting
• links the guide from the guides landing page and adds it to sitemap.xml
• adds the new page to the website smoke test

Validation

• php -l guides/index.php
• php -l guides/openrtmp-noalbs-json-stats/index.php
• parsed sitemap.xml as XML
• parsed .github/workflows/site-checks.yml as YAML
• verified the native provider implementation against the NOALBS v2.19.0 tag
• verified the flat public JSON response against the current librtmp2-server implementation

Closes #4

---

^{Need help on this PR? Tag @codesmith with what you need. Autofix is disabled.}

Summary by CodeRabbit

• New Features

  • Added a guide explaining how to connect NOALBS to OpenRTMP JSON statistics.
  • Included setup instructions, configuration examples, security guidance, and troubleshooting tips.
  • Added the guide to the guides index with updated metadata and descriptions.

• Documentation

  • Added the new guide to the site sitemap.
  • Extended automated checks to verify the guide is publicly accessible.

[coderabbitai]

ℹ️ Recent review info

⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Free

Run ID: c8e741cc-f62c-495c-a281-7e8f9146ae97

📥 Commits

Reviewing files that changed from the base of the PR and between e333284 and 0d2aaeb.

📒 Files selected for processing (4)

• .github/workflows/site-checks.yml
• guides/index.php
• guides/openrtmp-noalbs-json-stats/index.php
• sitemap.xml

---

📝 Walkthrough

Walkthrough

Adds a published PHP guide for connecting NOALBS to OpenRTMP JSON statistics, links it from the guides index, adds sitemap metadata, and includes the new URL in public-page smoke tests.

Changes

NOALBS guide publication

Layer / File(s)	Summary
NOALBS statistics guide guides/openrtmp-noalbs-json-stats/index.php	Adds guide metadata, setup instructions, OpenRTMP and nginx-compatible configuration examples, networking and security guidance, troubleshooting sections, navigation, and shared layout includes.
Guide index listing guides/index.php	Expands guides-page metadata and adds a card linking to the NOALBS statistics guide.
Publication metadata and smoke test sitemap.xml, .github/workflows/site-checks.yml	Adds the guide to the sitemap, updates the guides timestamp, and checks the new public path during CI.

Estimated code review effort: 2 (Simple) | ~10 minutes

---

Note

🎁 Summarized by CodeRabbit Free

Your organization is on the Free plan. CodeRabbit will generate a high-level summary and a walkthrough for each pull request. For a comprehensive line-by-line review, please upgrade your subscription to CodeRabbit Pro by visiting https://app.coderabbit.ai/login.

_{Comment @coderabbitai help to get the list of available commands.}

[sonarqubecloud]

Quality Gate failed

Failed conditions
B Reliability Rating on New Code (required ≥ A)

See analysis details on SonarQube Cloud

Catch issues before they fail your Quality Gate with our IDE extension SonarQube for IDE

[qodo-code-review]

PR Summary by Qodo

Add NOALBS/OpenRTMP JSON statistics guide and wire it into site navigation

📝 Documentation 🧪 Tests ⚙️ Configuration changes 🕐 10-20 Minutes

AI Description

• Add a new guide for connecting NOALBS to OpenRTMP JSON stats endpoints.
• Link the guide from the guides landing page and include it in the sitemap.
• Extend the website smoke test to cover the new guide route.

Diagram

graph TD
  A["Guides landing"] --> B["New NOALBS stats guide"] --> C["Header/Footer includes"]
  D["Sitemap.xml"] --> B
  E["CI site-checks workflow"] --> F["Smoke-test routes"] --> B

  subgraph Legend
    direction LR
    _page["Page"] ~~~ _cfg["Config/Index"] ~~~ _ci["CI"]
  end

Loading

High-Level Assessment

The following are alternative approaches to this PR:

1. Auto-generate sitemap + smoke routes from guides directory

• ➕ Eliminates manual duplication across guides index, sitemap, and CI route lists
• ➕ Reduces risk of forgetting to add new guides to one of the discovery/validation locations
• ➖ Adds build-time logic (or runtime discovery) that may not fit a simple PHP/static workflow
• ➖ Requires defining metadata (title/description) in a machine-readable way for consistent generation

2. Centralize guide metadata in a single data file (JSON/PHP array)

• ➕ Single source of truth for cards, sitemap lastmod/changefreq, and test routes
• ➕ Keeps pages themselves focused on content
• ➖ Introduces a new content-maintenance step and conventions for contributors
• ➖ Still requires manual lastmod updates unless additional tooling is added

Recommendation: The PR’s approach is appropriate for the current site structure: add the guide, then wire it into the index, sitemap, and CI checks. If guide count grows, consider a single-source metadata approach (or generation) to avoid drift between navigation, sitemap, and smoke-test allowlists.

Files changed (4) +233 / -3

Tests (1) +1 / -0

site-checks.ymlInclude new guide route in CI smoke checks +1/-0

Include new guide route in CI smoke checks

• Adds the new /guides/openrtmp-noalbs-json-stats/ path to the list of URLs validated by the site-checks workflow.

.github/workflows/site-checks.yml

Documentation (2) +225 / -2

index.phpAdd NOALBS statistics guide card and refresh SEO copy +9/-2

Add NOALBS statistics guide card and refresh SEO copy

• Updates the guides landing page title/description to mention NOALBS. Adds a new guide card linking to the OpenRTMP/NOALBS JSON statistics guide.

guides/index.php

index.phpNew guide: OpenRTMP JSON stats integration with NOALBS +216/-0

New guide: OpenRTMP JSON stats integration with NOALBS

• Introduces a task-focused guide covering NOALBS v2.19.0+ native OpenRTMP provider setup, key usage (publish/play/stats), JSON endpoint fields, XML fallback configuration, host selection in Docker, and common HTTP/proxy troubleshooting.

guides/openrtmp-noalbs-json-stats/index.php

Other (1) +7 / -1

sitemap.xmlAdd new guide URL and update guides lastmod date +7/-1

Add new guide URL and update guides lastmod date

• Bumps the /guides/ lastmod date and adds a new sitemap entry for /guides/openrtmp-noalbs-json-stats/ with monthly change frequency.

sitemap.xml

[qodo-code-review]

Code Review by Qodo

🐞 Bugs (0) 📘 Rule violations (0) 📎 Requirement gaps (0)

Great, no issues found!

Qodo reviewed your code and found no material issues that require review