SVI/netbird
1
0
Fork 0
mirror of https://github.com/netbirdio/netbird.git synced 2026-06-13 10:51:52 -04:00
Code Issues 3.0k Packages Projects Releases 10 Wiki Activity

Request for documentation improvement #753

New Issue
Open
opened 2025-11-20 05:17:01 -05:00 by saavagebueno · 1 comment
saavagebueno commented 2025-11-20 05:17:01 -05:00
Owner
Copy Link

Originally created by @andreklug on GitHub (Mar 29, 2024).

Hi Netbird team,

I have been playing around with Netbird and tried different installation scenarios to find the best option that suits my self hosting needs. In this process, I wish I had found some more information in the docs that would have saved me some headache and some points are still unclear to me.

  1. I installed the easy setup with zitadel on a VPS. Worked fine, I connected some Linux, Macos and iOS clients, but I'd prefer Authentik, in my own environment. So I purged the whole docker installation (images, volumes, everything in /opt/netbird/...) and started from scratch. When connecting to the new installation, all the old clients show up (some of them connected), and I can't find where this information is stored to get rid of them. Q: Where is client information stored, and how to reset it? What steps are needed to start from scratch without nuking the host?
  2. How to get around the "Add new peer to your network" page when calling /peers? It surely is useful to display the page when there are no clients at all, but this is the only page I can reach. Maybe instead of forcing users to that page, display a button to this page on the dashboard?
  3. I would like to understand the different options in setup.env (and the .json config files) better, but can't find them.
  4. I'm not at the point yet to give different authentik users different rights, but also don't see information about this in the Netbird (or Authentik) docs
  5. I tried to set up Netbird in a VM which requires reverse proxying. The nginx example assumes the installation of the reverse proxy and Netbird on the same VM (pointing to docker networks), but in reality you would run the reverse proxy standalone and for multiple services, so the Netbird installation is on another machine. I could now create two reverse proxies, one on the Netbird VM in addition? If that's intended, please write it in the docs. Only by accident I found the "trusted proxy" option in one of the .json files, but no matter which format I entered the reverse proxy IP, it was always throwing errors.
  6. Is there a bare metal install available or planned?
  7. When completely removing the netbird client, which files are stored where on each platform?

Thanks in advance for considering my feedback.

Originally created by @andreklug on GitHub (Mar 29, 2024). Hi Netbird team, I have been playing around with Netbird and tried different installation scenarios to find the best option that suits my self hosting needs. In this process, I wish I had found some more information in the docs that would have saved me some headache and some points are still unclear to me. 1. I installed the easy setup with zitadel on a VPS. Worked fine, I connected some Linux, Macos and iOS clients, but I'd prefer Authentik, in my own environment. So I purged the whole docker installation (images, volumes, everything in /opt/netbird/...) and started from scratch. When connecting to the new installation, all the old clients show up (some of them connected), and I can't find where this information is stored to get rid of them. Q: Where is client information stored, and how to reset it? What steps are needed to start from scratch without nuking the host? 2. How to get around the "Add new peer to your network" page when calling /peers? It surely is useful to display the page when there are no clients at all, but this is the only page I can reach. Maybe instead of forcing users to that page, display a button to this page on the dashboard? 3. I would like to understand the different options in setup.env (and the .json config files) better, but can't find them. 4. I'm not at the point yet to give different authentik users different rights, but also don't see information about this in the Netbird (or Authentik) docs 5. I tried to set up Netbird in a VM which requires reverse proxying. The nginx example assumes the installation of the reverse proxy and Netbird on the same VM (pointing to docker networks), but in reality you would run the reverse proxy standalone and for multiple services, so the Netbird installation is on another machine. I could now create two reverse proxies, one on the Netbird VM in addition? If that's intended, please write it in the docs. Only by accident I found the "trusted proxy" option in one of the .json files, but no matter which format I entered the reverse proxy IP, it was always throwing errors. 6. Is there a bare metal install available or planned? 7. When completely removing the netbird client, which files are stored where on each platform? Thanks in advance for considering my feedback.
saavagebueno added the enhancementdocumentationfeature-request labels 2025-11-20 05:17:01 -05:00
saavagebueno commented 2025-11-20 05:17:01 -05:00
Author
Owner
Copy Link

@Luccifer commented on GitHub (Apr 12, 2024):

Got almost the same pain and loosen time, found trusted proxies as well, but nothing actually helps on 5th point
and always got [Error] Fetch API cannot load https://site:33073/api/users due to access control checks.
Checked every setting and variable, all is by the book, definitely need some refactoring on tutorials

@Luccifer commented on GitHub (Apr 12, 2024): Got almost the same pain and loosen time, found trusted proxies as well, but nothing actually helps on 5th point and always got [Error] Fetch API cannot load https://site:33073/api/users due to access control checks. Checked every setting and variable, all is by the book, definitely need some refactoring on tutorials
Sign in to join this conversation.
No Branch/Tag Specified
Branches Tags
Labels
Clear labels
2021 Q4
2022 Q1
2022 Q1
accessibility
acl
agent
agent
Android
Android
api
authentik
automation
azure
battery-usage
bug
cache
client
client-ui
cloud
cloud-only
cloudflare
community
compatibility
config-idp
config-issue
connection
contribution
coturn
cross-vpn
dashboard
data-usage
distribution
dns
docker
documentation
duplicate
enhancement
enhancement
event-stream
feature-request
freebsd
getting-started
go
good first issue
gui
help wanted
home-assistant
idp
inconsistency
integration
integrations
ios
ipv6
jwt
k8s
keycloak
linux
login
macos
management-service
missing-docs
mobile
moved-internal
needs-review
netbird-ui
networking
new-platform
nginx
notification
okta
openwrt
packaging
peer-management
peer-management
peer-management
performance
postgres
posture-checks
psk
pull-request
Mirrored from GitHub Pull Request
 question
refactor
relay
release
rfc
routes
security
security-related
self-hosting
server
signal
sleep-issue
ssh
ssl
status
store
synology
system-compatibility-issue
test-suite
third-party-integration
triage
triage-needed
troubleshooting
UX
waiting-feedback
windows
wontfix
zitadel
No Label documentation enhancement feature-request
Milestone
No items
No Milestone
Projects
Clear projects
No project
Assignees
Clear assignees
saavagebueno
No Assignees
1 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: SVI/netbird#753
Delete Branch "%!s()"

Deleting a branch is permanent. Although the deleted branch may continue to exist for a short time before it actually gets removed, it CANNOT be undone in most cases. Continue?