This document provides a reference for configuring the EmberNet platform after installation.
General Settings
| Setting | Description | Default |
|---|
platform.name | Display name for this deployment | EmberNet |
platform.timezone | Default timezone for dashboards and logs | UTC |
platform.language | Default language | en |
platform.session_timeout | User session timeout | 30m |
Data Retention
Configure how long telemetry data is retained at each storage tier:
| Setting | Description | Default |
|---|
retention.hot | Hot tier retention (edge node) | 7d |
retention.warm | Warm tier retention (edge cluster) | 30d |
retention.cold | Cold tier retention (cloud storage) | 365d |
retention.aggregation_interval | Downsampling interval for warm/cold tiers | 1m |
Networking
| Setting | Description | Default |
|---|
network.mesh.enabled | Enable zero-trust mesh networking | true |
network.mesh.controller | Mesh controller endpoint | — |
network.mesh.enrollment_token | One-time enrollment token | — |
network.proxy.http | HTTP proxy for outbound connections | — |
network.proxy.https | HTTPS proxy for outbound connections | — |
network.dns.servers | Custom DNS servers | System default |
Telemetry Configuration
OPC UA
| Setting | Description | Default |
|---|
opcua.endpoint | OPC UA server endpoint URL | — |
opcua.security_mode | Security mode (None, Sign, SignAndEncrypt) | SignAndEncrypt |
opcua.security_policy | Security policy | Basic256Sha256 |
opcua.polling_interval | Data polling interval | 1s |
opcua.subscription_mode | Use subscription-based data change notifications | true |
MQTT
| Setting | Description | Default |
|---|
mqtt.broker | MQTT broker address | — |
mqtt.port | MQTT broker port | 1883 |
mqtt.tls.enabled | Enable TLS for MQTT connections | true |
mqtt.tls.port | MQTT TLS port | 8883 |
mqtt.topics | Topic subscriptions (array) | — |
mqtt.qos | Quality of Service level (0, 1, 2) | 1 |
Modbus
| Setting | Description | Default |
|---|
modbus.mode | Connection mode (tcp or rtu) | tcp |
modbus.host | Modbus device host/IP | — |
modbus.port | Modbus TCP port | 502 |
modbus.unit_id | Modbus unit/slave ID | 1 |
modbus.polling_interval | Polling interval | 1s |
SNMP
| Setting | Description | Default |
|---|
snmp.version | SNMP version (v2c or v3) | v3 |
snmp.community | Community string (v2c only) | — |
snmp.auth_protocol | Authentication protocol (v3) | SHA |
snmp.priv_protocol | Privacy protocol (v3) | AES |
snmp.polling_interval | Polling interval | 30s |
Alert Configuration
Alert Rules
Alert rules define conditions that trigger notifications:
| Setting | Description |
|---|
rules[].name | Alert rule name |
rules[].metric | Metric to evaluate |
rules[].condition | Condition expression (e.g., > 90) |
rules[].duration | How long condition must persist before firing |
rules[].severity | Severity level: info, warning, critical |
rules[].channels | Notification channels to dispatch to |
Notification Channels
| Channel | Configuration |
|---|
| Email | SMTP server, recipients, subject template |
| Webhook | URL, HTTP method, headers, payload template |
| SMS | Provider configuration, phone numbers |
| PagerDuty | Integration key, severity mapping |
Authentication
Local Authentication
| Setting | Description | Default |
|---|
auth.local.enabled | Enable local username/password auth | true |
auth.password.min_length | Minimum password length | 12 |
auth.password.require_uppercase | Require uppercase characters | true |
auth.password.require_special | Require special characters | true |
auth.mfa.enabled | Enable multi-factor authentication | false |
SSO / SAML
| Setting | Description |
|---|
auth.sso.enabled | Enable SSO authentication |
auth.sso.provider | SSO provider type (saml, oidc) |
auth.sso.metadata_url | Identity provider metadata URL |
auth.sso.entity_id | Service provider entity ID |
auth.sso.acs_url | Assertion consumer service URL |
Environment Variables
EmberNet can also be configured via environment variables. Environment variables take precedence over configuration files.
| Variable | Description |
|---|
EMBERNET_CONFIG_PATH | Path to configuration file |
EMBERNET_LOG_LEVEL | Log verbosity (debug, info, warn, error) |
EMBERNET_DATA_DIR | Data storage directory |
EMBERNET_MESH_TOKEN | Mesh enrollment token |
Next Steps