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

Include a Docker Compose file suitable for QNAP QTS #1367

New Issue
Open
opened 2025-11-20 05:29:07 -05:00 by saavagebueno · 0 comments
saavagebueno commented 2025-11-20 05:29:07 -05:00
Owner
Copy Link

Originally created by @trbutler on GitHub (Oct 25, 2024).

Is your feature request related to a problem? Please describe.
QNAP NASes have RAM disk root drive that clears after every reboot, so the Synology installation instructions don't work for QNAP. This seems akin to the issue that motivates the HomeAssistant add-on. Like that add-on, a Docker container for the client helps resolve this issue, since the YAML file can be placed within Container Station.

Describe the solution you'd like
I've worked out a Docker compose file that makes Netbird work within QNAP, although I haven't figured out how to make Network routes work yet. This isn't identical to the HA docker compose file since I'd started working on this before I found it and, more importantly, that one seems to have some HA-specific requirements.

Errata I've been unable to solve so far:

  • While the NAS's IP address gets Netbird's DNS sitting on port 53, I haven't figure out how to gracefully integrate name resolution into QNAP's system yet.

  • The Netbird docker container doesn't seem to add the network routes to the system (either internal to the container or outside of it, since I'm using host networking), though they work if I add them manually, e.g. ip route add 192.168.4.0/22 dev wt0, etc.

services:
  netbird:
    image: netbirdio/netbird
    container_name: netbird
    hostname: netbird
    network_mode: "host"
    privileged: true
    cap_add:
      - NET_ADMIN
      - SYS_ADMIN
      - SYS_RESOURCE
      - NET_RAW
      - BPF
    environment:
      - NB_SETUP_KEY=[setup key]
      - NB_MANAGEMENT_URL=[server]
      - NB_HOSTNAME=madison
      - NB_ENABLE_ROSENPASS=1
      - NB_ROSENPASS_PERMISSIVE=1
    volumes:
      - netbird-client:/etc/netbird
    restart: unless-stopped

volumes:
  netbird-client:

Describe alternatives you've considered
I've participated in another issue about a native package for QNAP, although this is a lot less complicated, not requiring either keeping up with Netbird releases or an Entware package being added to the Netbird build system.

Originally created by @trbutler on GitHub (Oct 25, 2024). **Is your feature request related to a problem? Please describe.** QNAP NASes have RAM disk root drive that clears after every reboot, so the Synology installation instructions don't work for QNAP. This seems akin to the issue that motivates the [HomeAssistant add-on](https://github.com/netbirdio/addon-netbird). Like that add-on, a Docker container for the client helps resolve this issue, since the YAML file can be placed within Container Station. **Describe the solution you'd like** I've worked out a Docker compose file that makes Netbird work within QNAP, although I haven't figured out how to make Network routes work yet. This isn't identical to the HA docker compose file since I'd started working on this before I found it and, more importantly, that one seems to have some HA-specific requirements. Errata I've been unable to solve so far: * While the NAS's IP address gets Netbird's DNS sitting on port 53, I haven't figure out how to gracefully integrate name resolution into QNAP's system yet. * The Netbird docker container doesn't seem to add the network routes to the system (either internal to the container or outside of it, since I'm using host networking), though they work if I add them manually, e.g. `ip route add 192.168.4.0/22 dev wt0`, etc. ```` services: netbird: image: netbirdio/netbird container_name: netbird hostname: netbird network_mode: "host" privileged: true cap_add: - NET_ADMIN - SYS_ADMIN - SYS_RESOURCE - NET_RAW - BPF environment: - NB_SETUP_KEY=[setup key] - NB_MANAGEMENT_URL=[server] - NB_HOSTNAME=madison - NB_ENABLE_ROSENPASS=1 - NB_ROSENPASS_PERMISSIVE=1 volumes: - netbird-client:/etc/netbird restart: unless-stopped volumes: netbird-client: ```` **Describe alternatives you've considered** I've participated in another issue about [a native package for QNAP](https://github.com/netbirdio/netbird/issues/2748#issuecomment-2418989635), although this is a lot less complicated, not requiring either keeping up with Netbird releases _or_ an Entware package being added to the Netbird build system.
saavagebueno added the feature-request label 2025-11-20 05:29:07 -05:00
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 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#1367
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?