Skip to content

README Linux addendum, MoQ Source setup#17

Merged
kixelated merged 1 commit intomoq-dev:masterfrom
davegullo:master
Dec 28, 2025
Merged

README Linux addendum, MoQ Source setup#17
kixelated merged 1 commit intomoq-dev:masterfrom
davegullo:master

Conversation

@davegullo
Copy link
Copy Markdown
Contributor

linux instructions, 4433 -> 4443, MoQ Source (experimental) guidance

@coderabbitai
Copy link
Copy Markdown

coderabbitai Bot commented Dec 27, 2025

Walkthrough

The README.md file has been updated with several documentation changes. The usage section is renamed to "Configuring MoQ Output Streaming." The MoQ server default development URL is updated from http://localhost:4433/anon to http://localhost:4443/anon in OBS Stream settings. A new manual configuration section titled "Manual MoQ Output Streaming Configuration" is added with example service.json files for Linux and macOS targeting port 4443. A new experimental "MoQ Source" subsection with step-by-step instructions is included. Additional minor updates include a watch link in the testing server example and build-environment table spacing adjustments.

Pre-merge checks and finishing touches

✅ Passed checks (3 passed)
Check name Status Explanation
Title check ✅ Passed The title accurately reflects the main changes: adding Linux instructions to the README and setting up MoQ Source. It's specific and directly corresponds to the changeset.
Description check ✅ Passed The description is directly related to the changeset, covering the three main aspects: Linux instructions, port change (4433→4443), and MoQ Source experimental guidance.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
✨ Finishing touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

Copy link
Copy Markdown

@coderabbitai coderabbitai Bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 1

🧹 Nitpick comments (1)
README.md (1)

93-93: Simplify wording: replace "prior to" with "before".

Line 93 uses "prior to," which can be simplified to the more concise "before" for better readability.

🔎 Proposed fix for wordiness
-For configuring via a file, prior to launching OBS you can add this to your OBS Profile directory (eg: "Untitled"):
+For configuring via a file, before launching OBS you can add this to your OBS Profile directory (eg: "Untitled"):
📜 Review details

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between b750b66 and d0051fe.

📒 Files selected for processing (1)
  • README.md
🧰 Additional context used
🪛 LanguageTool
README.md

[style] ~93-~93: ‘prior to’ might be wordy. Consider a shorter alternative.
Context: ...figuration For configuring via a file, prior to launching OBS you can add this to your ...

(EN_WORDINESS_PREMIUM_PRIOR_TO)

🔇 Additional comments (4)
README.md (4)

62-63: Linux build instructions are clear and well-placed.

The addition of Linux-specific plugin copy instructions alongside macOS provides helpful guidance for Linux users and aligns with the PR objective.


75-88: Section rename and port number update are consistent throughout.

The section rename to "Configuring MoQ Output Streaming" is more descriptive, and the port change from 4433 to 4443 is applied consistently. The addition of the watch link (line 85) is a nice UX enhancement for testing.


91-111: Manual configuration section adds helpful guidance with clear examples.

The new section with service.json examples for both Linux and macOS is well-structured and the port 4443 is consistent with the main instructions.


113-121: MoQ Source (experimental) section provides clear step-by-step guidance.

The experimental label is appropriate, and the instructions are clear. Ensure that the MoQ Source feature is sufficiently tested before moving it out of experimental status.

Comment thread README.md
@@ -96,6 +133,8 @@ RUST_LOG=debug RUST_BACKTRACE=1 OBS_LOG_LEVEL=debug ../obs-studio/build_macos/fr
| Ubuntu 24.04 | `pkg-config`
Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Potential issue | 🟡 Minor

Fix table formatting: missing closing pipe character.

Line 133 is missing the closing pipe (|) at the end of the row.

🔎 Proposed fix for table formatting
-| Ubuntu 24.04 | `pkg-config`
+| Ubuntu 24.04 | `pkg-config` |
📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
| Ubuntu 24.04 | `pkg-config`
| Ubuntu 24.04 | `pkg-config` |
🧰 Tools
🪛 markdownlint-cli2 (0.18.1)

133-133: Table pipe style
Expected: leading_and_trailing; Actual: leading_only; Missing trailing pipe

(MD055, table-pipe-style)

🤖 Prompt for AI Agents
In README.md around line 133, the Markdown table row "| Ubuntu 24.04 |
`pkg-config`" is missing the trailing closing pipe; add the final "|" to the end
of the row so the table cell is properly terminated (change it to "| Ubuntu
24.04 | `pkg-config` |").

@kixelated kixelated merged commit 232d9b1 into moq-dev:master Dec 28, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants