Skip to content

[self-hosted] Add selfhosted scaling note#5769

Merged
braginini merged 1 commit intomainfrom
docs/add-selfhosted-sclaing-note
Apr 1, 2026
Merged

[self-hosted] Add selfhosted scaling note#5769
braginini merged 1 commit intomainfrom
docs/add-selfhosted-sclaing-note

Conversation

@braginini
Copy link
Copy Markdown
Collaborator

@braginini braginini commented Apr 1, 2026

Entire-Checkpoint: 7d03435efeeb

  • Adds a note after the "NETBIRD SETUP COMPLETE" output informing users that this setup is ideal for homelabs and smaller organizations
  • Points enterprise users to the commercial on-prem license and the self-hosted scaling guide

Describe your changes

Screenshot 2026-04-01 at 19 17 29

Issue ticket number and link

Stack

Checklist

  • Is it a bug fix
  • Is a typo/documentation fix
  • Is a feature enhancement
  • It is a refactor
  • Created tests that fail without the change (if possible)

By submitting this pull request, you confirm that you have read and agree to the terms of the Contributor License Agreement.

Documentation

Select exactly one:

Docs PR URL (required if "docs added" is checked)

Paste the PR link from https://github.com/netbirdio/docs here:

https://github.com/netbirdio/docs/pull/__

Summary by CodeRabbit

  • Documentation
    • Enhanced post-setup instruction formatting for improved clarity
    • Added guidance tailored for homelabs and smaller organizations
    • Included information on commercial on-premise licensing and scaling resources

Entire-Checkpoint: 7d03435efeeb
@braginini braginini requested review from jnfrati and shuuri-labs April 1, 2026 17:18
@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai bot commented Apr 1, 2026

📝 Walkthrough

Walkthrough

The changes modify the Traefik post-setup instruction output in the getting-started script by reorganizing conditional formatting for the WireGuard port section, adding new guidance text for homelabs and smaller organizations, and including recommendations for commercial on-premise licensing and scaling guidance.

Changes

Cohort / File(s) Summary
Shell Script Instructions
infrastructure_files/getting-started.sh
Adjusted conditional formatting for WireGuard 51820/udp port display based on ENABLE_PROXY flag; added guidance text for homelabs/smaller organizations and unconditional block recommending commercial on-prem licensing and scaling guidance; kept "NetBird Proxy:" instructions conditional on ENABLE_PROXY == "true".

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

Possibly related PRs

Suggested reviewers

  • mlsmaycon
  • lixmal

Poem

🐰 In scripts where instructions dwell,
Formatting fine-tuned to tell,
Of ports and guides for labs so small,
And wisdom shared with one and all!

🚥 Pre-merge checks | ✅ 2 | ❌ 1

❌ Failed checks (1 inconclusive)

Check name Status Explanation Resolution
Description check ❓ Inconclusive The PR description provides a clear summary of changes and includes the required checklist, but lacks issue ticket details and contains conflicting documentation guidance. Clarify the documentation status: the 'Documentation not needed' checkbox is marked, but a docs PR URL (678) is referenced. Provide an issue ticket number or link if this addresses a specific issue.
✅ Passed checks (2 passed)
Check name Status Explanation
Docstring Coverage ✅ Passed Docstring coverage is 100.00% which is sufficient. The required threshold is 80.00%.
Title check ✅ Passed The title directly relates to the main change: adding a selfhosted scaling note to the setup output, which is the primary objective shown in the PR description screenshot.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
📝 Generate docstrings
  • Create stacked PR
  • Commit on current branch
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch docs/add-selfhosted-sclaing-note

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.

@sonarqubecloud
Copy link
Copy Markdown

sonarqubecloud bot commented Apr 1, 2026

Copy link
Copy Markdown
Contributor

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

Caution

Some comments are outside the diff and can’t be posted inline due to platform limitations.

⚠️ Outside diff range comments (1)
infrastructure_files/getting-started.sh (1)

1155-1175: ⚠️ Potential issue | 🟠 Major

Fix broken documentation URL before merging.

The scaling guide URL is returning a 404 error:

  • https://docs.netbird.io/scaling-your-self-hosted-deployment → HTTP 404 Not Found

The code directs users to this non-existent page, which breaks the intended guidance flow. Verify the correct documentation path and update the URL to point to the actual scaling guide. The commercial license URL (https://netbird.io/pricing) is reachable and valid.

🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.

In `@infrastructure_files/getting-started.sh` around lines 1155 - 1175, The
scaling guide URL string echo "  Scaling guide:     
https://docs.netbird.io/scaling-your-self-hosted-deployment" is pointing to a
404; locate that echo in the script (near the block that prints deployment
guidance alongside the commercial license echo) and replace the broken URL with
the correct docs path after verifying the actual scaling/self-hosting guide URL
on docs.netbird.io, keeping the same echo formatting; ensure any other
occurrences of the old URL are updated and run a quick curl/check to confirm the
new URL returns 200.
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.

Outside diff comments:
In `@infrastructure_files/getting-started.sh`:
- Around line 1155-1175: The scaling guide URL string echo "  Scaling guide:    
https://docs.netbird.io/scaling-your-self-hosted-deployment" is pointing to a
404; locate that echo in the script (near the block that prints deployment
guidance alongside the commercial license echo) and replace the broken URL with
the correct docs path after verifying the actual scaling/self-hosting guide URL
on docs.netbird.io, keeping the same echo formatting; ensure any other
occurrences of the old URL are updated and run a quick curl/check to confirm the
new URL returns 200.

ℹ️ Review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: 83d517a9-c2dd-4db8-a2ea-5c566d6808e8

📥 Commits

Reviewing files that changed from the base of the PR and between d97fe84 and ff8263c.

📒 Files selected for processing (1)
  • infrastructure_files/getting-started.sh

@braginini braginini changed the title Add selfhosted scaling note [selfhosted] Add selfhosted scaling note Apr 1, 2026
@braginini braginini changed the title [selfhosted] Add selfhosted scaling note [self-hosted] Add selfhosted scaling note Apr 1, 2026
@braginini braginini merged commit aaf813f into main Apr 1, 2026
47 of 51 checks passed
@braginini braginini deleted the docs/add-selfhosted-sclaing-note branch April 1, 2026 17:23
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.

3 participants