netbird icon indicating copy to clipboard operation
netbird copied to clipboard

Add documentation for environment variables used in docker

Open tedstriker opened this issue 1 year ago • 1 comments

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

tedstriker avatar Feb 19 '24 12:02 tedstriker

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 avatar Apr 22 '24 13:04 Zapfmeister