mirror of
https://github.com/netbirdio/netbird.git
synced 2024-11-21 15:43:12 +01:00
0c039274a4
This update adds new relay integration for NetBird clients. The new relay is based on web sockets and listens on a single port. - Adds new relay implementation with websocket with single port relaying mechanism - refactor peer connection logic, allowing upgrade and downgrade from/to P2P connection - peer connections are faster since it connects first to relay and then upgrades to P2P - maintains compatibility with old clients by not using the new relay - updates infrastructure scripts with new relay service
106 lines
4.5 KiB
Plaintext
106 lines
4.5 KiB
Plaintext
## example file, you can copy this file to setup.env and update its values
|
|
##
|
|
|
|
# Image tags
|
|
# you can force specific tags for each component; will be set to latest if empty
|
|
NETBIRD_DASHBOARD_TAG=""
|
|
NETBIRD_SIGNAL_TAG=""
|
|
NETBIRD_MANAGEMENT_TAG=""
|
|
COTURN_TAG=""
|
|
NETBIRD_RELAY_TAG=""
|
|
|
|
# Dashboard domain. e.g. app.mydomain.com
|
|
NETBIRD_DOMAIN=""
|
|
|
|
# TURN server domain. e.g. turn.mydomain.com
|
|
# if not specified it will assume NETBIRD_DOMAIN
|
|
NETBIRD_TURN_DOMAIN=""
|
|
|
|
# TURN server public IP address
|
|
# required for a connection involving peers in
|
|
# the same network as the server and external peers
|
|
# usually matches the IP for the domain set in NETBIRD_TURN_DOMAIN
|
|
NETBIRD_TURN_EXTERNAL_IP=""
|
|
|
|
# -------------------------------------------
|
|
# OIDC
|
|
# e.g., https://example.eu.auth0.com/.well-known/openid-configuration
|
|
# -------------------------------------------
|
|
NETBIRD_AUTH_OIDC_CONFIGURATION_ENDPOINT=""
|
|
# The default setting is to transmit the audience to the IDP during authorization. However,
|
|
# if your IDP does not have this capability, you can turn this off by setting it to false.
|
|
#NETBIRD_DASH_AUTH_USE_AUDIENCE=false
|
|
NETBIRD_AUTH_AUDIENCE=""
|
|
# e.g. netbird-client
|
|
NETBIRD_AUTH_CLIENT_ID=""
|
|
# indicates the scopes that will be requested to the IDP
|
|
NETBIRD_AUTH_SUPPORTED_SCOPES=""
|
|
# NETBIRD_AUTH_CLIENT_SECRET is required only by Google workspace.
|
|
# NETBIRD_AUTH_CLIENT_SECRET=""
|
|
# if you want to use a custom claim for the user ID instead of 'sub', set it here
|
|
# NETBIRD_AUTH_USER_ID_CLAIM=""
|
|
# indicates whether to use Auth0 or not: true or false
|
|
NETBIRD_USE_AUTH0="false"
|
|
# 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.
|
|
# NETBIRD_AUTH_REDIRECT_URI="/peers"
|
|
# NETBIRD_AUTH_SILENT_REDIRECT_URI="/add-peers"
|
|
# Updates the preference to use id tokens instead of access token on dashboard
|
|
# Okta and Gitlab IDPs can benefit from this
|
|
# 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
|
|
# -------------------------------------------
|
|
# OIDC PKCE Authorization Flow
|
|
# -------------------------------------------
|
|
# Comma separated port numbers. if already in use, PKCE flow will choose an available port from the list as an alternative
|
|
# eg. 53000,54000
|
|
NETBIRD_AUTH_PKCE_REDIRECT_URL_PORTS="53000"
|
|
# -------------------------------------------
|
|
# 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=""
|
|
# Required when setting up with Keycloak "https://<YOUR_KEYCLOAK_HOST_AND_PORT>/admin/realms/netbird"
|
|
# NETBIRD_IDP_MGMT_EXTRA_ADMIN_ENDPOINT=
|
|
# With some IDPs may be needed enabling automatic refresh of signing keys on expire
|
|
# NETBIRD_MGMT_IDP_SIGNKEY_REFRESH=false
|
|
# NETBIRD_IDP_MGMT_EXTRA_ variables. See https://docs.netbird.io/selfhosted/identity-providers for more information about your IDP of choice.
|
|
# -------------------------------------------
|
|
# Letsencrypt
|
|
# -------------------------------------------
|
|
# Disable letsencrypt
|
|
# if disabled, cannot use HTTPS anymore and requires setting up a reverse-proxy to do it instead
|
|
NETBIRD_DISABLE_LETSENCRYPT=false
|
|
# e.g. hello@mydomain.com
|
|
NETBIRD_LETSENCRYPT_EMAIL=""
|
|
# -------------------------------------------
|
|
# Extra settings
|
|
# -------------------------------------------
|
|
# Disable anonymous metrics collection, see more information at https://netbird.io/docs/FAQ/metrics-collection
|
|
NETBIRD_DISABLE_ANONYMOUS_METRICS=false
|
|
# DNS DOMAIN configures the domain name used for peer resolution. By default it is netbird.selfhosted
|
|
NETBIRD_MGMT_DNS_DOMAIN=netbird.selfhosted
|
|
|
|
# -------------------------------------------
|
|
# Relay settings
|
|
# -------------------------------------------
|
|
# Relay server domain. e.g. relay.mydomain.com
|
|
# if not specified it will assume NETBIRD_DOMAIN
|
|
NETBIRD_RELAY_DOMAIN=""
|
|
|
|
# Relay server connection port. If none is supplied
|
|
# it will default to 33080
|
|
NETBIRD_RELAY_PORT=""
|