extern/netbird
1
0
Fork 0
mirror of https://github.com/netbirdio/netbird.git synced 2025-06-20 09:47:49 +02:00
Code Issues Packages Projects Releases Wiki Activity

Organize example setup.env with sections (#928)

Browse Source
This commit is contained in:
Maycon Santos 2023-06-05 09:21:52 +02:00 committed by GitHub
parent 8817765aeb
commit 511f0a00be
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 22 additions and 15 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

37
infrastructure_files/setup.env.example
View File

@ -15,19 +15,6 @@ NETBIRD_AUTH_CLIENT_ID=""
# NETBIRD_AUTH_USER_ID_CLAIM="" # NETBIRD_AUTH_USER_ID_CLAIM=""
# indicates whether to use Auth0 or not: true or false # indicates whether to use Auth0 or not: true or false
NETBIRD_USE_AUTH0="false" NETBIRD_USE_AUTH0="false"
NETBIRD_AUTH_DEVICE_AUTH_PROVIDER="none"
NETBIRD_AUTH_DEVICE_AUTH_CLIENT_ID=""
# Some IDPs requires different audience, scopes and to use id token for device authorization flow
# you can customize here:
NETBIRD_AUTH_DEVICE_AUTH_AUDIENCE=$NETBIRD_AUTH_AUDIENCE
NETBIRD_AUTH_DEVICE_AUTH_SCOPE="openid"
NETBIRD_AUTH_DEVICE_AUTH_USE_ID_TOKEN=false
eg. zitadel, auth0, azure, keycloak
NETBIRD_MGMT_IDP="none"
# Some IDPs requires different client id and client secret for management api
NETBIRD_IDP_MGMT_CLIENT_ID=$NETBIRD_AUTH_CLIENT_ID
NETBIRD_IDP_MGMT_CLIENT_SECRET=""
# if your IDP provider doesn't support fragmented URIs, configure custom # if your IDP provider doesn't support fragmented URIs, configure custom
# redirect and silent redirect URIs, these will be concatenated into your NETBIRD_DOMAIN domain. # redirect and silent redirect URIs, these will be concatenated into your NETBIRD_DOMAIN domain.
# NETBIRD_AUTH_REDIRECT_URI="/peers" # NETBIRD_AUTH_REDIRECT_URI="/peers"
@ -35,7 +22,25 @@ NETBIRD_IDP_MGMT_CLIENT_SECRET=""
# Updates the preference to use id tokens instead of access token on dashboard # Updates the preference to use id tokens instead of access token on dashboard
# Okta and Gitlab IDPs can benefit from this # Okta and Gitlab IDPs can benefit from this
# NETBIRD_TOKEN_SOURCE="idToken" # NETBIRD_TOKEN_SOURCE="idToken"
# -------------------------------------------
# OIDC Device Authorization Flow
# -------------------------------------------
NETBIRD_AUTH_DEVICE_AUTH_PROVIDER="none"
NETBIRD_AUTH_DEVICE_AUTH_CLIENT_ID=""
# Some IDPs requires different audience, scopes and to use id token for device authorization flow
# you can customize here:
NETBIRD_AUTH_DEVICE_AUTH_AUDIENCE=$NETBIRD_AUTH_AUDIENCE
NETBIRD_AUTH_DEVICE_AUTH_SCOPE="openid"
NETBIRD_AUTH_DEVICE_AUTH_USE_ID_TOKEN=false
# -------------------------------------------
# IDP Management
# -------------------------------------------
# eg. zitadel, auth0, azure, keycloak
NETBIRD_MGMT_IDP="none"
# Some IDPs requires different client id and client secret for management api
NETBIRD_IDP_MGMT_CLIENT_ID=$NETBIRD_AUTH_CLIENT_ID
NETBIRD_IDP_MGMT_CLIENT_SECRET=""
# NETBIRD_IDP_MGMT_EXTRA_ variables. See https://docs.netbird.io/selfhosted/identity-providers for more information about your IDP of choice.
# ------------------------------------------- # -------------------------------------------
# Letsencrypt # Letsencrypt
# ------------------------------------------- # -------------------------------------------
@ -44,7 +49,9 @@ NETBIRD_IDP_MGMT_CLIENT_SECRET=""
NETBIRD_DISABLE_LETSENCRYPT=false NETBIRD_DISABLE_LETSENCRYPT=false
# e.g. hello@mydomain.com # e.g. hello@mydomain.com
NETBIRD_LETSENCRYPT_EMAIL="" NETBIRD_LETSENCRYPT_EMAIL=""
# -------------------------------------------
# Extra settings
# -------------------------------------------
# Disable anonymous metrics collection, see more information at https://netbird.io/docs/FAQ/metrics-collection # Disable anonymous metrics collection, see more information at https://netbird.io/docs/FAQ/metrics-collection
NETBIRD_DISABLE_ANONYMOUS_METRICS=false NETBIRD_DISABLE_ANONYMOUS_METRICS=false
# DNS DOMAIN configures the domain name used for peer resolution. By default it is netbird.selfhosted # DNS DOMAIN configures the domain name used for peer resolution. By default it is netbird.selfhosted