2023-05-16 19:00:16 +08:00
|
|
|
# Email used for SSL certificates
|
|
|
|
|
NM_EMAIL=
|
|
|
|
|
# The base domain of netmaker
|
|
|
|
|
NM_DOMAIN=
|
|
|
|
|
# Public IP of machine
|
|
|
|
|
SERVER_HOST=
|
|
|
|
|
# The admin master key for accessing the API. Change this in any production installation.
|
|
|
|
|
MASTER_KEY=
|
|
|
|
|
# The username to set for MQ access
|
|
|
|
|
MQ_USERNAME=
|
|
|
|
|
# The password to set for MQ access
|
|
|
|
|
MQ_PASSWORD=
|
|
|
|
|
INSTALL_TYPE=
|
2023-07-13 10:53:34 +08:00
|
|
|
NETMAKER_TENANT_ID=
|
2023-05-16 19:00:16 +08:00
|
|
|
LICENSE_KEY=
|
|
|
|
|
SERVER_IMAGE_TAG=
|
|
|
|
|
UI_IMAGE_TAG=
|
|
|
|
|
# used for HA - identifies this server vs other servers
|
2023-09-20 20:32:08 +08:00
|
|
|
NODE_ID=netmaker-server-1
|
|
|
|
|
METRICS_EXPORTER=off
|
|
|
|
|
PROMETHEUS=off
|
2023-05-16 19:00:16 +08:00
|
|
|
# Enables DNS Mode, meaning all nodes will set hosts file for private dns settings
|
2023-09-20 20:32:08 +08:00
|
|
|
DNS_MODE=on
|
2023-05-16 19:00:16 +08:00
|
|
|
# Enable auto update of netclient ? ENUM:- enabled,disabled | default=enabled
|
2023-09-20 20:32:08 +08:00
|
|
|
NETCLIENT_AUTO_UPDATE=enabled
|
2023-05-16 19:00:16 +08:00
|
|
|
# The HTTP API port for Netmaker. Used for API calls / communication from front end.
|
|
|
|
|
# If changed, need to change port of BACKEND_URL for netmaker-ui.
|
2023-09-20 20:32:08 +08:00
|
|
|
API_PORT=8081
|
|
|
|
|
EXPORTER_API_PORT=8085
|
2023-05-16 19:00:16 +08:00
|
|
|
# The "allowed origin" for API requests. Change to restrict where API requests can come from with comma-separated
|
|
|
|
|
# URLs. ex:- https://dashboard.netmaker.domain1.com,https://dashboard.netmaker.domain2.com
|
2023-09-20 20:32:08 +08:00
|
|
|
CORS_ALLOWED_ORIGIN=*
|
2023-05-16 19:00:16 +08:00
|
|
|
# Show keys permanently in UI (until deleted) as opposed to 1-time display.
|
2023-09-20 20:32:08 +08:00
|
|
|
DISPLAY_KEYS=on
|
2023-05-16 19:00:16 +08:00
|
|
|
# Database to use - sqlite, postgres, or rqlite
|
2023-09-20 20:32:08 +08:00
|
|
|
DATABASE=sqlite
|
2023-05-16 19:00:16 +08:00
|
|
|
# The address of the mq server. If running from docker compose it will be "mq". Otherwise, need to input address.
|
|
|
|
|
# If using "host networking", it will find and detect the IP of the mq container.
|
2023-09-20 20:32:08 +08:00
|
|
|
# For EMQX websockets use `SERVER_BROKER_ENDPOINT=ws://mq:8083/mqtt`
|
|
|
|
|
SERVER_BROKER_ENDPOINT=ws://mq:1883
|
2023-05-16 19:00:16 +08:00
|
|
|
# Logging verbosity level - 1, 2, or 3
|
2023-09-20 20:32:08 +08:00
|
|
|
VERBOSITY=1
|
|
|
|
|
DEBUG_MODE=off
|
2023-05-16 19:00:16 +08:00
|
|
|
# Enables the REST backend (API running on API_PORT at SERVER_HTTP_HOST).
|
2023-09-20 20:32:08 +08:00
|
|
|
REST_BACKEND=on
|
2023-05-16 19:00:16 +08:00
|
|
|
# If turned "on", Server will not set Host based on remote IP check.
|
|
|
|
|
# This is already overridden if SERVER_HOST is set. Turned "off" by default.
|
2023-09-20 20:32:08 +08:00
|
|
|
DISABLE_REMOTE_IP_CHECK=off
|
2023-05-16 19:00:16 +08:00
|
|
|
# Whether or not to send telemetry data to help improve Netmaker. Switch to "off" to opt out of sending telemetry.
|
2023-09-20 20:32:08 +08:00
|
|
|
TELEMETRY=on
|
2023-05-16 19:00:16 +08:00
|
|
|
###
|
|
|
|
|
#
|
|
|
|
|
# OAuth section
|
|
|
|
|
#
|
|
|
|
|
###
|
|
|
|
|
# "<azure-ad|github|google|oidc>"
|
|
|
|
|
AUTH_PROVIDER=
|
|
|
|
|
# "<client id of your oauth provider>"
|
|
|
|
|
CLIENT_ID=
|
|
|
|
|
# "<client secret of your oauth provider>"
|
|
|
|
|
CLIENT_SECRET=
|
|
|
|
|
# "https://dashboard.<netmaker base domain>"
|
|
|
|
|
FRONTEND_URL=
|
|
|
|
|
# "<only for azure, you may optionally specify the tenant for the OAuth>"
|
|
|
|
|
AZURE_TENANT=
|
|
|
|
|
# https://oidc.yourprovider.com - URL of oidc provider
|
|
|
|
|
OIDC_ISSUER=
|
2023-10-02 12:57:58 +08:00
|
|
|
# Duration of JWT token validity in seconds
|
|
|
|
|
JWT_VALIDITY_DURATION=43200
|
|
|
|
|
# Auto disable a user's connecteds clients bassed on JWT token expiration
|
2024-01-11 14:32:55 +08:00
|
|
|
RAC_AUTO_DISABLE=true
|
2023-12-05 16:01:35 +08:00
|
|
|
# if turned on data will be cached on to improve performance significantly (IMPORTANT: If HA set to `false` )
|
2024-01-11 14:32:55 +08:00
|
|
|
CACHING_ENABLED=true
|
