Skip to content

Add community package installation instructions for Linux - #918

Merged
TechHutTV merged 2 commits into
netbirdio:mainfrom
PizzaLovingNerd:community-packages
Aug 14, 2026
Merged

Add community package installation instructions for Linux#918
TechHutTV merged 2 commits into
netbirdio:mainfrom
PizzaLovingNerd:community-packages

Conversation

@PizzaLovingNerd

@PizzaLovingNerd PizzaLovingNerd commented Aug 12, 2026

Copy link
Copy Markdown
Collaborator

Summary

  • Add a dedicated community packages section to the Linux installation documentation.
  • Clarify that these packages are maintained by distributions and community repositories rather than NetBird.
  • Add installation and service instructions for:
    • Alpine Linux
    • ALT Linux Sisyphus
    • Arch Linux AUR and Chaotic-AUR
    • NixOS
    • openSUSE Tumbleweed
    • Solus
  • Document the correct package-specific service integrations, including Alpine's netbird-openrc package and Arch's netbird@main.service.
  • Add desktop package instructions where available.
  • Add a common post-install check to confirm that the CLI can reach the NetBird daemon before login.

Validation

The package installation and service instructions were validated in libvirt VMs against their respective repositories. The checks covered package provenance, CLI availability, service activation, daemon socket access, expected unauthenticated status, and desktop package payloads where applicable.

Documentation checks:

  • npm run lint:mdx
  • uvx --from codespell codespell src/pages/get-started/install/linux.mdx
  • git diff --check
  • npm run build
  • Inspected the generated Linux installation page

Summary by CodeRabbit

  • Documentation
    • Reorganized Linux installation guidance into a Community packages section.
    • Added installation instructions for Alpine, ALT Linux, Arch, NixOS, openSUSE Tumbleweed, and Solus.
    • Documented desktop package options and service setup where applicable.
    • Added instructions for verifying service status with netbird status.
    • Removed the obsolete standalone NixOS installation section.

@vercel

vercel Bot commented Aug 12, 2026

Copy link
Copy Markdown

@PizzaLovingNerd is attempting to deploy a commit to the NetBird GmbH Team on Vercel.

A member of the Team first needs to authorize it.

@PizzaLovingNerd
PizzaLovingNerd marked this pull request as ready for review August 12, 2026 01:01
@coderabbitai

coderabbitai Bot commented Aug 12, 2026

Copy link
Copy Markdown
Contributor

Review Change Stack

Warning

Review limit reached

@PizzaLovingNerd, you've reached your PR review limit, so we couldn't start this review.

Next review available in: 57 minutes

You've used all free OSS reviews for now. Wait for the free limit to reset to keep reviewing this public repository.

How can I continue?

After more reviews become available, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

To avoid repeated limits, reduce automatic review volume by pausing incremental auto-reviews earlier, using label-based review opt-in, excluding WIP or generated PR titles, or requesting reviews manually when the PR is ready. If your team needs uninterrupted high-volume reviews, an organization admin can enable usage-based reviews.

How do review limits work?

CodeRabbit enforces per-developer PR review limits for each organization. Most developers receive the normal plan review availability.

For paid Pro and Pro+ PR reviews, CodeRabbit uses adaptive limits for sustained high-volume activity. When a developer's recent PR review activity reaches the 95th percentile or higher among CodeRabbit users, additional reviews become available more gradually as earlier reviews age out of the rolling window.

Please refer docs for additional details.

Review details
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro Plus

Run ID: e26ede88-35f3-4e5e-a7dc-7d77e5e8ab98

📥 Commits

Reviewing files that changed from the base of the PR and between 054cfd9 and 661ab7d.

📒 Files selected for processing (1)
  • src/pages/get-started/install/linux.mdx

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro Plus

Run ID: 53dde3c0-733a-4a40-be1b-0fb49dd17068

📥 Commits

Reviewing files that changed from the base of the PR and between dc1fee0 and 054cfd9.

📒 Files selected for processing (1)
  • src/pages/get-started/install/linux.mdx

📝 Walkthrough

Walkthrough

The Linux installation guide removes the former NixOS section and adds community package instructions for six distributions. It also documents service verification with netbird status.

Changes

Linux community packages

Layer / File(s) Summary
Community package installation methods
src/pages/get-started/install/linux.mdx
The page adds community package guidance and installation instructions for Alpine, ALT Linux, Arch, NixOS, openSUSE Tumbleweed, and Solus. It includes desktop package and service setup steps where applicable.
Service verification instructions
src/pages/get-started/install/linux.mdx
The page adds netbird status checks, including pre-login daemon responses and Alpine root execution behavior.

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

Merge Risk: ⚪ Minimal · up to 054cf

This change adds Linux package installation documentation and service guidance without introducing runtime behavior changes; no actionable merge-blocking risk remains after normal checks and review.

Possibly related PRs

  • netbirdio/docs#793: Both changes update Linux installation documentation, including openSUSE instructions.
  • netbirdio/docs#897: Both changes update Alpine installation documentation.

Suggested reviewers: sunsetdrifter

Poem

A rabbit hops through packages bright,
Alpine and Arch now guide the flight.
NixOS joins with services in line,
netbird status says all is fine.
Six Linux paths, neatly shown—
A burrow of docs has grown!

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title clearly and concisely describes the main change: adding Linux community package installation instructions.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
✨ Finishing Touches 💡 1
🛠️ Fix failing CI checks 💡
  • Create stacked PR
  • Commit on current branch
🧪 Generate unit tests (beta)
  • Create PR with unit tests

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.

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Actionable comments posted: 1

🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

Inline comments:
In `@src/pages/get-started/install/linux.mdx`:
- Around line 315-319: Update the Alpine installation section around the netbird
package instructions to explicitly state that the packages require Alpine edge,
including the edge Community repository, or replace the steps with verified
supported stable-release instructions. Keep the install commands aligned with
the stated Alpine version and repository.
🪄 Autofix

Fix all unresolved CodeRabbit comments on this PR:

  • Push a commit to this branch (recommended)
  • Create a new PR with the fixes

ℹ️ Review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro Plus

Run ID: 8c509ba5-2c05-4b48-87b4-a5267c085b76

📥 Commits

Reviewing files that changed from the base of the PR and between 204c279 and dc1fee0.

📒 Files selected for processing (1)
  • src/pages/get-started/install/linux.mdx

Comment thread src/pages/get-started/install/linux.mdx
@vercel

vercel Bot commented Aug 14, 2026

Copy link
Copy Markdown

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated (UTC)
docs Ready Ready Preview Aug 14, 2026 11:12pm

Request Review

@TechHutTV
TechHutTV self-requested a review August 14, 2026 23:42
@TechHutTV
TechHutTV merged commit 538854e into netbirdio:main Aug 14, 2026
3 of 4 checks passed
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