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

VPN documentation deprecated #397

New Issue
Closed
opened 2025-11-20 05:10:46 -05:00 by saavagebueno · 0 comments
saavagebueno commented 2025-11-20 05:10:46 -05:00
Owner
Copy Link

Originally created by @UncleJ4ck on GitHub (Jul 10, 2023).

Certain sections of the documentation, such as the one found at https://docs.netbird.io/about-netbird/faq#what-firewall-ports-should-i-open-to-use-net-bird, contain deprecated information regarding the usage of api.wiretrustee.com and firewall port management.

[What firewall ports should I open to use NetBird?](https://docs.netbird.io/about-netbird/faq#what-firewall-ports-should-i-open-to-use-net-bird)
[Incoming ports](https://docs.netbird.io/about-netbird/faq#incoming-ports)

NetBird's agent doesn't require any incoming port to be open; It negotiates the connection with the support of the signal and relay services.
[Outgoing ports](https://docs.netbird.io/about-netbird/faq#outgoing-ports)

NetBird usually won't need open ports, but sometimes you or your IT team needs to secure and verify all outgoing traffic, and that may affect how NetBird clients connect to the [control layer](https://docs.netbird.io/about-netbird/how-netbird-works) and negotiate the peer-to-peer connections.

Below is the list of NetBird hosted endpoints and ports they listen to:

    Management service:
    Endpoint: api.wiretrustee.com
    Port: TCP/443
    Signal service:
        Endpoint: signal2.wiretrustee.com
        Port: TCP/443
    Relay (TURN) service:
        Endpoint: turn.netbird.io
        Port range: UDP/5555-65535

[Why and what are the anonymous usage metrics?](https://docs.netbird.io/about-netbird/faq#why-and-what-are-the-anonymous-usage-metrics)
[Why we added metrics collection?](https://docs.netbird.io/about-netbird/faq#why-we-added-metrics-collection)

As an open-source project and business, making decisions based on data is essential. We will know our adoption rate, feature usage, and client type with anonymous metrics.

The collection is strict to our management system.

If the metric collection infringes any internal regulation or policy, it can be disabled by setting the flag --disable-anonymous-metrics=true to the management service startup command.
[What are the metrics being collected?](https://docs.netbird.io/about-netbird/faq#what-are-the-metrics-being-collected)

We are collecting the following metrics:

    Number of accounts
    Number of users
    Number of peers
    Number of active peers in the last 24 hours
    Number of peers per operating system
    Number of setup keys usage
    Number of peers activated by users
    Number of rules
    Number of groups
    Number of routes
    Number of nameservers
    Service uptime
    Service version
    Metrics generation time

[Metrics UUID](https://docs.netbird.io/about-netbird/faq#metrics-uuid)

We are using an installation ID for each management service which is generated once and stored in your management store database. It doesn't have any trace of any other private information, and it helps distinguish each deployment.
[Metrics pusher IP](https://docs.netbird.io/about-netbird/faq#metrics-pusher-ip)

We are not storing the pusher IP address; it gets discarded once the request is complete.
Originally created by @UncleJ4ck on GitHub (Jul 10, 2023). Certain sections of the documentation, such as the one found at https://docs.netbird.io/about-netbird/faq#what-firewall-ports-should-i-open-to-use-net-bird, contain deprecated information regarding the usage of api.wiretrustee.com and firewall port management. ``` [What firewall ports should I open to use NetBird?](https://docs.netbird.io/about-netbird/faq#what-firewall-ports-should-i-open-to-use-net-bird) [Incoming ports](https://docs.netbird.io/about-netbird/faq#incoming-ports) NetBird's agent doesn't require any incoming port to be open; It negotiates the connection with the support of the signal and relay services. [Outgoing ports](https://docs.netbird.io/about-netbird/faq#outgoing-ports) NetBird usually won't need open ports, but sometimes you or your IT team needs to secure and verify all outgoing traffic, and that may affect how NetBird clients connect to the [control layer](https://docs.netbird.io/about-netbird/how-netbird-works) and negotiate the peer-to-peer connections. Below is the list of NetBird hosted endpoints and ports they listen to: Management service: Endpoint: api.wiretrustee.com Port: TCP/443 Signal service: Endpoint: signal2.wiretrustee.com Port: TCP/443 Relay (TURN) service: Endpoint: turn.netbird.io Port range: UDP/5555-65535 [Why and what are the anonymous usage metrics?](https://docs.netbird.io/about-netbird/faq#why-and-what-are-the-anonymous-usage-metrics) [Why we added metrics collection?](https://docs.netbird.io/about-netbird/faq#why-we-added-metrics-collection) As an open-source project and business, making decisions based on data is essential. We will know our adoption rate, feature usage, and client type with anonymous metrics. The collection is strict to our management system. If the metric collection infringes any internal regulation or policy, it can be disabled by setting the flag --disable-anonymous-metrics=true to the management service startup command. [What are the metrics being collected?](https://docs.netbird.io/about-netbird/faq#what-are-the-metrics-being-collected) We are collecting the following metrics: Number of accounts Number of users Number of peers Number of active peers in the last 24 hours Number of peers per operating system Number of setup keys usage Number of peers activated by users Number of rules Number of groups Number of routes Number of nameservers Service uptime Service version Metrics generation time [Metrics UUID](https://docs.netbird.io/about-netbird/faq#metrics-uuid) We are using an installation ID for each management service which is generated once and stored in your management store database. It doesn't have any trace of any other private information, and it helps distinguish each deployment. [Metrics pusher IP](https://docs.netbird.io/about-netbird/faq#metrics-pusher-ip) We are not storing the pusher IP address; it gets discarded once the request is complete. ```
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
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#397
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?