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

[PR #3696] fix: traefik relay accessibility #3877

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

Original Pull Request: https://github.com/netbirdio/netbird/pull/3696

State: closed
Merged: Yes

Describe your changes

  • Remove commented lines on traefik template compose file

  • Fix relay accessibility with traefik reverse proxy (I think my understanding is correct, but please feel free to correct me if I got it wrong)

    • Instructions here mentioned to update NETBIRD_MGMT_API_PORT and NETBIRD_SIGNAL_PORT to be reverse-proxy TLS-port but not NETBIRD_RELAY_PORT, which defaults to 33080.

    • management.json.tmpl has relay address as rel://$NETBIRD_RELAY_DOMAIN:$NETBIRD_RELAY_PORT so it will resolve to <netbird_domain>:33080 which in case of using traefik is not accessible. relay should be accessible on
      <netbird_domain>:<reverse-proxy TLS-port>/relay

    • Updating traefik template to use port 33080 for relay internally. and I will open another PR to update the docs as well to include NETBIRD_RELAY_PORT along NETBIRD_MGMT_API_PORT and NETBIRD_SIGNAL_PORT.

    • Introduce NETBIRD_RELAY_ENDPOINT and use it on compose + management template files with value

      • rel://$NETBIRD_RELAY_DOMAIN:$NETBIRD_RELAY_PORT when NETBIRD_DISABLE_LETSENCRYPT=false
      • rels://$NETBIRD_DOMAIN:$NETBIRD_SIGNAL_PORT/relay when NETBIRD_DISABLE_LETSENCRYPT=true

I encountered this setting up a self-hosted instance with traefik, is there a way to verify the changes with my instance?
I tested with running netbird status -d I got

...
Relays: 
  [stun:mydomain.example.com:3478] is Available
  [turn:mydomain.example.com:3478?transport=udp] is Available
  [rels://mydomain.example.com:443/relay] is Available
...

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)
  • Extended the README / documentation, if necessary
**Original Pull Request:** https://github.com/netbirdio/netbird/pull/3696 **State:** closed **Merged:** Yes --- ## Describe your changes - Remove commented lines on traefik template compose file - Fix relay accessibility with traefik reverse proxy (I think my understanding is correct, but please feel free to correct me if I got it wrong) - Instructions [here](https://github.com/netbirdio/docs/blob/main/src/pages/selfhosted/selfhosted-guide.mdx?plain=1#L155-L156) mentioned to update `NETBIRD_MGMT_API_PORT` and `NETBIRD_SIGNAL_PORT` to be `reverse-proxy TLS-port` but not `NETBIRD_RELAY_PORT`, which defaults to `33080`. - `management.json.tmpl` has relay address as `rel://$NETBIRD_RELAY_DOMAIN:$NETBIRD_RELAY_PORT` so it will resolve to `<netbird_domain>:33080` which in case of using traefik is not accessible. relay should be accessible on `<netbird_domain>:<reverse-proxy TLS-port>/relay` - Updating traefik template to use port `33080` for relay internally. and I will open another PR to update the docs as well to include `NETBIRD_RELAY_PORT` along `NETBIRD_MGMT_API_PORT` and `NETBIRD_SIGNAL_PORT`. - Introduce `NETBIRD_RELAY_ENDPOINT` and use it on compose + management template files with value - `rel://$NETBIRD_RELAY_DOMAIN:$NETBIRD_RELAY_PORT` when `NETBIRD_DISABLE_LETSENCRYPT=false` - `rels://$NETBIRD_DOMAIN:$NETBIRD_SIGNAL_PORT/relay` when `NETBIRD_DISABLE_LETSENCRYPT=true` I encountered this setting up a self-hosted instance with traefik, is there a way to verify the changes with my instance? I tested with running `netbird status -d` I got ``` ... Relays: [stun:mydomain.example.com:3478] is Available [turn:mydomain.example.com:3478?transport=udp] is Available [rels://mydomain.example.com:443/relay] is Available ... ``` ### Checklist - [x] Is it a bug fix - [ ] Is a typo/documentation fix - [ ] Is a feature enhancement - [x] It is a refactor - [ ] Created tests that fail without the change (if possible) - [ ] Extended the README / documentation, if necessary
saavagebueno added the pull-request label 2025-11-20 08:07:15 -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 pull-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#3877
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?