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

Add documentation for environment variables used in docker #642

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

Originally created by @tedstriker on GitHub (Feb 19, 2024).

Is your feature request related to a problem? Please describe.
It's quite difficult to get craft a working docker-compose file without using https://github.com/netbirdio/netbird/releases/latest/download/getting-started-with-zitadel.sh
to generate example files and the scenario it creates is not the outcome I'm trying to achieve (don't want Zitadel, but I want to know how the services interact with each other)
On top of that I feel very uneasy to run a bash script just to install some docker containers.

Describe the solution you'd like
I'd prefer a properly documented docker installation route and a concise description what each environment variable

  • is used for
  • what values it takes
  • what it defaults to
  • and ideally an example
    • and the result of using that example

e.g.
just an example for the structure, because right now I'm guessing the meaning of the environment variable

Container Dashboard

NETBIRD_MGMT_API_ENDPOINT points to the management API exposed by the management container, which is necessary for providing the dashboard with information.
An URI scheme of http[s]://[manamgement_container_url]:[port] is expected. It defaults to http://management:33073
example: NETBIRD_MGMT_API_ENDPOINT=http://management:33073
this points to the API of the management container by using its docker internal DNS name of the service on the default port.

Describe alternatives you've considered
I considered not using netbird, because I'm not capable of setting it up in first place.

Additional context
no further context

Originally created by @tedstriker on GitHub (Feb 19, 2024). **Is your feature request related to a problem? Please describe.** It's quite difficult to get craft a working docker-compose file without using https://github.com/netbirdio/netbird/releases/latest/download/getting-started-with-zitadel.sh to generate example files and the scenario it creates is not the outcome I'm trying to achieve (don't want Zitadel, but I want to know how the services interact with each other) On top of that I feel very uneasy to run a bash script just to install some docker containers. **Describe the solution you'd like** I'd prefer a properly documented docker installation route and a concise description what each environment variable - is used for - what values it takes - what it defaults to - and ideally an example - and the result of using that example e.g. just an example for the structure, because right now I'm guessing the meaning of the environment variable ### Container Dashboard `NETBIRD_MGMT_API_ENDPOINT` points to the management API exposed by the management container, which is necessary for providing the dashboard with information. An URI scheme of `http[s]://[manamgement_container_url]:[port]` is expected. It defaults to `http://management:33073` example: `NETBIRD_MGMT_API_ENDPOINT=http://management:33073` this points to the API of the management container by using its docker internal DNS name of the service on the default port. **Describe alternatives you've considered** I considered not using netbird, because I'm not capable of setting it up in first place. **Additional context** no further context
saavagebueno added the feature-requestmanagement-serviceself-hosting labels 2025-11-20 05:15:10 -05:00
saavagebueno commented 2025-11-20 05:15:10 -05:00
Author
Owner
Copy Link

@Zapfmeister commented on GitHub (Apr 22, 2024):

If i see it correctly, there is also no differentiation in the variable NETBIRD_DOMAIN. It seems this variable is used for the netbird domain, as well as for the authentication domain, which usually is different from each other.

@Zapfmeister commented on GitHub (Apr 22, 2024): If i see it correctly, there is also no differentiation in the variable `NETBIRD_DOMAIN`. It seems this variable is used for the netbird domain, as well as for the authentication domain, which usually is different from each other.
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 management-service self-hosting
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#642
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?