diff --git a/.env.example b/.env.example index 2248e07..e3d4e36 100644 --- a/.env.example +++ b/.env.example @@ -2,32 +2,28 @@ # Copy this file to .env and customize values # =================== -# Docker Image +# Data & Seed Directories # =================== -# Leave empty to build from local Dockerfile, or set to use a pre-built image: -# MESHCORE_IMAGE=ghcr.io/ipnet-mesh/meshcore-hub:latest -# MESHCORE_IMAGE=ghcr.io/ipnet-mesh/meshcore-hub:main -# MESHCORE_IMAGE=ghcr.io/ipnet-mesh/meshcore-hub:v1.0.0 -MESHCORE_IMAGE= - -# =================== -# Data Directory -# =================== - -# Base directory for all service data (collector DB, tags, members, etc.) +# Base directory for runtime data (database, etc.) # Default: ./data (relative to docker-compose.yml location) # Inside containers this is mapped to /data # # Structure: # ${DATA_HOME}/ -# ├── collector/ -# │ ├── meshcore.db # SQLite database -# │ └── tags.json # Node tags for import -# └── web/ -# └── members.json # Network members list +# └── meshcore.db # SQLite database DATA_HOME=./data +# Directory containing seed data files for import +# Default: ./seed (relative to docker-compose.yml location) +# Inside containers this is mapped to /seed +# +# Structure: +# ${SEED_HOME}/ +# ├── node_tags.yaml # Node tags for import +# └── members.yaml # Network members for import +SEED_HOME=./seed + # =================== # Common Settings # =================== @@ -35,12 +31,20 @@ DATA_HOME=./data # Logging level (DEBUG, INFO, WARNING, ERROR, CRITICAL) LOG_LEVEL=INFO -# MQTT Broker Settings (internal use) +# =================== +# MQTT Settings +# =================== + +# MQTT Broker connection (for interface/collector/api services) +# When using the local MQTT broker (--profile mqtt), use "mqtt" as host +# When using an external broker, set the hostname/IP +MQTT_HOST=mqtt +MQTT_PORT=1883 MQTT_USERNAME= MQTT_PASSWORD= MQTT_PREFIX=meshcore -# External MQTT port mapping +# External port mappings for local MQTT broker (--profile mqtt only) MQTT_EXTERNAL_PORT=1883 MQTT_WS_PORT=9001 @@ -58,6 +62,7 @@ SERIAL_PORT_SENDER=/dev/ttyUSB1 SERIAL_BAUD=115200 # Optional node address override (64-char hex string) +# Only set if you need to override the device's public key NODE_ADDRESS= NODE_ADDRESS_SENDER= @@ -84,25 +89,21 @@ WEB_PORT=8080 NETWORK_NAME=MeshCore Network NETWORK_CITY= NETWORK_COUNTRY= -NETWORK_LOCATION= # Radio configuration (comma-delimited) # Format: ,,,,, # Example: EU/UK Narrow,869.618MHz,62.5kHz,8,8,22dBm NETWORK_RADIO_CONFIG= +# Contact information NETWORK_CONTACT_EMAIL= NETWORK_CONTACT_DISCORD= +NETWORK_CONTACT_GITHUB= # Welcome text displayed on the homepage (plain text, optional) # If not set, a default welcome message is shown NETWORK_WELCOME_TEXT= -# Members file location (optional override) -# Default: ${DATA_HOME}/web/members.json -# Only set this if you want to use a different location -# MEMBERS_FILE=/custom/path/to/members.json - # =================== # Webhook Settings # ===================