SVI/netbird
1
0
Fork 0
mirror of https://github.com/netbirdio/netbird.git synced 2026-05-15 04:32:40 -04:00
Code Issues 3.0k Packages Projects Releases 10 Wiki Activity

docker/container requirements #360

New Issue
Closed
opened 2025-11-20 05:10:10 -05:00 by saavagebueno · 1 comment
saavagebueno commented 2025-11-20 05:10:10 -05:00
Owner
Copy Link

Originally created by @lfarkas on GitHub (Jun 5, 2023).

in the docs there are 2 different docker command line:
docker run --network host --privileged --rm -d -e NB_SETUP_KEY=<SETUP KEY> -v netbird-client:/etc/netbird netbirdio/netbird:<TAG>
and the other is:
docker run --rm --name PEER_NAME --hostname PEER_NAME --cap-add=NET_ADMIN -d -e NB_SETUP_KEY=<SETUP KEY> -v netbird-client:/etc/netbird netbirdio/netbird:latest
there are a few problem with this docs:

  • why not use the same cmd line args in all case eg: --rm, --hostname, --name
  • why use --privileged in the other case --cap-add=NET_ADMIN
  • why use <TAG> and the other case latest

BUT the biggest problem is the totally inconsistent usage of required capabilities. in another page:
https://docs.netbird.io/how-to/examples#net-bird-client-in-docker use only --cap-add=NET_ADMIN for setup-key too.

Of course using the --privileged is the easiest way but probably not the most professional ones.
I debug netbird for a few hours and find the out the the real capabilities requirements are:

  • NET_ADMIN
  • NET_RAW
  • BPF

and AFAIS the

  • SYS_ADMIN is not required but does it true?
  • SYS_MODULE is required? if the kernel module not already loaded?
  • SYS_RAWIO is required?

it'd be useful if someone who is in charge can confirm it.
and then all docs can be updated.

Another good question does netbird use the /dev/net/tun device when running in a docker container? other wireguard based solution use tun device kernel interface.

Originally created by @lfarkas on GitHub (Jun 5, 2023). in the [docs](https://docs.netbird.io/how-to/getting-started#running-net-bird-in-docker) there are 2 different docker command line: `docker run --network host --privileged --rm -d -e NB_SETUP_KEY=<SETUP KEY> -v netbird-client:/etc/netbird netbirdio/netbird:<TAG>` and the other is: `docker run --rm --name PEER_NAME --hostname PEER_NAME --cap-add=NET_ADMIN -d -e NB_SETUP_KEY=<SETUP KEY> -v netbird-client:/etc/netbird netbirdio/netbird:latest` there are a few problem with this docs: - why not use the same cmd line args in all case eg: --rm, --hostname, --name - why use `--privileged` in the other case `--cap-add=NET_ADMIN` - why use `<TAG>` and the other case `latest` BUT the biggest problem is the totally inconsistent usage of required capabilities. in another page: https://docs.netbird.io/how-to/examples#net-bird-client-in-docker use only `--cap-add=NET_ADMIN` for setup-key too. Of course using the `--privileged` is the easiest way but probably not the most professional ones. I debug netbird for a few hours and find the out the the real capabilities requirements are: - NET_ADMIN - NET_RAW - BPF and AFAIS the - SYS_ADMIN is not required but does it true? - SYS_MODULE is required? if the kernel module not already loaded? - SYS_RAWIO is required? it'd be useful if someone who is in charge can confirm it. and then all docs can be updated. Another good question does netbird use the /dev/net/tun device when running in a docker container? other wireguard based solution use tun device kernel interface.
saavagebueno added the bugclient labels 2025-11-20 05:10:10 -05:00
saavagebueno commented 2025-11-20 05:10:11 -05:00
Author
Owner
Copy Link

@lfarkas commented on GitHub (Aug 2, 2023):

imho currenlty these are the requirements:

  • SYS_ADMIN
  • SYS_RESOURCE
  • NET_ADMIN
  • NET_RAW
  • BPF
@lfarkas commented on GitHub (Aug 2, 2023): imho currenlty these are the requirements: - SYS_ADMIN - SYS_RESOURCE - NET_ADMIN - NET_RAW - BPF
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 bug client
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#360
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?