version: "3.4" services: netmaker: # The Primary Server for running Netmaker container_name: netmaker image: gravitl/netmaker:REPLACE_SERVER_IMAGE_TAG restart: on-failure volumes: # Volume mounts necessary for sql, coredns, and mqtt - dnsconfig:/root/config/dnsconfig - sqldata:/root/data - shared_certs:/etc/netmaker environment: # Necessary capabilities to set iptables when running in container BROKER_ENDPOINT: "wss://broker.NETMAKER_BASE_DOMAIN" # The domain/host IP indicating the mq broker address SERVER_NAME: "NETMAKER_BASE_DOMAIN" # The base domain of netmaker SERVER_HOST: "SERVER_PUBLIC_IP" # Set to public IP of machine. SERVER_HTTP_HOST: "api.NETMAKER_BASE_DOMAIN" # Overrides SERVER_HOST if set. Useful for making HTTP available via different interfaces/networks. NETCLIENT_AUTO_UPDATE: "enabled" # Enable auto update of netclient ? ENUM:- enabled,disabled | default: enabled SERVER_API_CONN_STRING: "api.NETMAKER_BASE_DOMAIN:443" COREDNS_ADDR: "SERVER_PUBLIC_IP" # Address of the CoreDNS server. Defaults to SERVER_HOST DNS_MODE: "on" # Enables DNS Mode, meaning all nodes will set hosts file for private dns settings. API_PORT: "8081" # 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. REST_BACKEND: "on" # Enables the REST backend (API running on API_PORT at SERVER_HTTP_HOST). Change to "off" to turn off. DISABLE_REMOTE_IP_CHECK: "off" # 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. TELEMETRY: "on" # Whether or not to send telemetry data to help improve Netmaker. Switch to "off" to opt out of sending telemetry. MASTER_KEY: "REPLACE_MASTER_KEY" # The admin master key for accessing the API. Change this in any production installation. CORS_ALLOWED_ORIGIN: "*" # 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 DISPLAY_KEYS: "on" # Show keys permanently in UI (until deleted) as opposed to 1-time display. DATABASE: "sqlite" # Database to use - sqlite, postgres, or rqlite NODE_ID: "netmaker-server-1" # used for HA - identifies this server vs other servers SERVER_BROKER_ENDPOINT: ""ws://mq:1883"" # 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. MQ_USERNAME: "REPLACE_MQ_USERNAME" # the username to set for MQ access MQ_PASSWORD: "REPLACE_MQ_PASSWORD" # the password to set for MQ access STUN_PORT: "3478" # the reachable port of STUN on the server VERBOSITY: "1" # logging verbosity level - 1, 2, or 3 # this section is for OAuth AUTH_PROVIDER: "" # "" CLIENT_ID: "" # "" CLIENT_SECRET: "" # "" FRONTEND_URL: "" # "https://dashboard." AZURE_TENANT: "" # "" OIDC_ISSUER: "" # https://oidc.yourprovider.com - URL of oidc provider DEFAULT_PROXY_MODE: "off" # if ON, all new clients will enable proxy by default if OFF, all new clients will disable proxy by default, if AUTO, stick with the existing logic for NAT detection TURN_SERVER_HOST: "turn.NETMAKER_BASE_DOMAIN" # domain for your turn server TURN_SERVER_API_HOST: "https://turnapi.NETMAKER_BASE_DOMAIN" # domain of the turn api server TURN_PORT: "3479" # port to access turn server TURN_USERNAME: "REPLACE_TURN_USERNAME" # the username to set for turn api access TURN_PASSWORD: "REPLACE_TURN_PASSWORD" # the password to set for turn api access USE_TURN: "true" #config for using turn, accepts either true/false ports: - "3478:3478/udp" # the stun port netmaker-ui: # The Netmaker UI Component container_name: netmaker-ui image: gravitl/netmaker-ui:REPLACE_UI_IMAGE_TAG depends_on: - netmaker links: - "netmaker:api" restart: always environment: BACKEND_URL: "https://api.NETMAKER_BASE_DOMAIN" # URL where UI will send API requests. Change based on SERVER_HOST, SERVER_HTTP_HOST, and API_PORT caddy: # The reverse proxy that manages traffic for Netmaker image: caddy:2.6.2 container_name: caddy restart: unless-stopped volumes: - /root/Caddyfile:/etc/caddy/Caddyfile # Config file for Caddy - caddy_data:/data - caddy_conf:/config ports: - "80:80" - "443:443" coredns: # The DNS Server. CoreDNS can be removed unless doing special advanced use cases container_name: coredns image: coredns/coredns command: -conf /root/dnsconfig/Corefile depends_on: - netmaker restart: always volumes: - dnsconfig:/root/dnsconfig mq: # the mqtt broker for netmaker container_name: mq image: eclipse-mosquitto:2.0.15-openssl depends_on: - netmaker restart: unless-stopped command: ["/mosquitto/config/wait.sh"] environment: MQ_PASSWORD: "REPLACE_MQ_PASSWORD" # must be same value as in netmaker env MQ_USERNAME: "REPLACE_MQ_USERNAME" # must be same value as in netmaker env volumes: - /root/mosquitto.conf:/mosquitto/config/mosquitto.conf - /root/wait.sh:/mosquitto/config/wait.sh - mosquitto_logs:/mosquitto/log ports: - "1883:1883" - "8883:8883" turn: container_name: turn image: gravitl/turnserver:v1.0.0 network_mode: "host" volumes: - turn_server:/etc/config environment: DEBUG_MODE: "off" VERBOSITY: "1" TURN_PORT: "3479" TURN_API_PORT: "8089" CORS_ALLOWED_ORIGIN: "*" TURN_SERVER_HOST: "turn.NETMAKER_BASE_DOMAIN" USERNAME: "REPLACE_TURN_USERNAME" PASSWORD: "REPLACE_TURN_PASSWORD" USE_TURN: "true" volumes: caddy_data: {} # runtime data for caddy caddy_conf: {} # configuration file for Caddy shared_certs: {} # netmaker certs generated for MQ comms - used by nodes/servers sqldata: {} # storage for embedded sqlite dnsconfig: {} # storage for coredns mosquitto_logs: {} # storage for mqtt logs turn_server: {}