mnm/.env.example at main · commitconfirm/mnm · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
# MNM - Modular Network Monitor
# Copy this file to .env and fill in your values
# All passwords will be auto-generated if left blank

# =============================================================================
# Core Settings
# =============================================================================
MNM_TIMEZONE=America/Boise
MNM_DOMAIN=localhost

# =============================================================================
# Nautobot Admin (used by bootstrap script)
# =============================================================================
MNM_ADMIN_USER=mnm-admin
MNM_ADMIN_PASSWORD=
[email protected]

# =============================================================================
# Nautobot
# =============================================================================
NAUTOBOT_SECRET_KEY=
NAUTOBOT_ALLOWED_HOSTS=*

# =============================================================================
# PostgreSQL
# =============================================================================
POSTGRES_USER=nautobot
POSTGRES_PASSWORD=
POSTGRES_DB=nautobot

# =============================================================================
# Redis
# =============================================================================
REDIS_PASSWORD=

# =============================================================================
# NAPALM — Network device read-only credentials (optional)
# =============================================================================
# NAUTOBOT_NAPALM_USERNAME=
# NAUTOBOT_NAPALM_PASSWORD=
# NAUTOBOT_NAPALM_TIMEOUT=30

# =============================================================================
# SNMP — Read-only community string for SNMP polling (Phase 2)
# =============================================================================
# SNMP_COMMUNITY=public
# SNMP_TARGETS=192.0.2.5

# =============================================================================
# gNMI — Streaming telemetry credentials (Phase 2)
# =============================================================================
# GNMI_USERNAME=
# GNMI_PASSWORD=

# =============================================================================
# Grafana (Phase 2)
# =============================================================================
# GRAFANA_ADMIN_PASSWORD=

# =============================================================================
# Prometheus Retention (Phase 2.5)
# =============================================================================
# PROMETHEUS_RETENTION_DAYS=365

# =============================================================================
# Performance Tuning
# =============================================================================
# MNM_SWEEP_CONCURRENCY=50        # Max concurrent TCP probes during sweep
# MNM_COLLECTION_CONCURRENCY=20   # Max concurrent SNMP walks during collection
# MNM_API_CONCURRENCY=10          # Max concurrent Nautobot API calls

# Anomaly detection — endpoints not seen in this many days are flagged as stale.
# Can also be set per-deployment by writing the "anomaly_stale_days" key to
# kv_config via POST /api/config.
# ANOMALY_STALE_DAYS=7

# Database maintenance — controls the daily prune background task that
# evicts old endpoint events, IP observations, orphaned watches, and
# stale sentinel rows from the controller's mnm_controller database.
# Set MNM_RETENTION_DAYS to match (or exceed) PROMETHEUS_RETENTION_DAYS so
# cross-referencing time ranges between Prometheus and the endpoint store
# always works.
# MNM_RETENTION_DAYS=365
# MNM_PRUNE_INTERVAL_HOURS=24

# =============================================================================
# Modular Polling — per-device, per-job-type collection intervals (seconds)
# =============================================================================
# These are defaults for new devices. Per-device overrides live in the
# device_polls table and can be changed via PUT /api/polling/config.
# MNM_POLL_ARP_INTERVAL=300
# MNM_POLL_MAC_INTERVAL=300
# MNM_POLL_DHCP_INTERVAL=600
# MNM_POLL_LLDP_INTERVAL=3600
# MNM_POLL_CHECK_INTERVAL=30

# =============================================================================
# Embedded AI Assistant (Phase 3)
# =============================================================================
# Local LLM via Ollama (default, self-contained)
# OLLAMA_MODEL=llama3.1:8b
#
# Optional: External API for higher quality (requires internet)
# ANTHROPIC_API_KEY=

# =============================================================================
# Cloud Connectors (Phase 4, all optional, all read-only)
# =============================================================================
# Juniper Mist
# MIST_API_TOKEN=
# MIST_BASE_URL=https://api.mist.com
# MIST_ORG_ID=

# Proxmox VE (read-only inventory + metrics + ZFS storage monitoring)
# Create an API token in Proxmox: Datacenter → Permissions → API Tokens.
# The user account should have the PVEAuditor role (read-only) at the
# Datacenter level so the connector can see all nodes/VMs/storage.
# PROXMOX_HOST=https://192.0.2.10:8006
# PROXMOX_TOKEN_ID=mnm-monitor@pve!mnm-token
# PROXMOX_TOKEN_SECRET=00000000-0000-0000-0000-000000000000
# PROXMOX_VERIFY_SSL=false
# PROXMOX_INTERVAL_SECONDS=300