bgpNotifiy/.env.example at master · pfoundation/bgpNotifiy · 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
# ============================================
# BGP Notifier Configuration
# ============================================
# Copy this file to .env and fill in the values

# --- Polling ---
# How often to poll BGP sessions (in minutes)
POLL_INTERVAL_MINUTES=3
# How often to re-send notifications for down sessions (in hours)
DOWN_RENOTIFY_HOURS=12
# Cooldown period before sending a session-down notification (in minutes).
# Suppresses notifications for transient flaps that recover within this window.
# Set to 0 to disable cooldown (notify immediately on first detection).
DOWN_COOLDOWN_MINUTES=30

# --- IXP Manager (IX-F Member Export) ---
# Full URL to the IX-F Member Export v1.0 endpoint
IXF_EXPORT_URL=http://10.100.90.239/api/v4/member-export/ixf/1.0?ignore_missing_ixfid=1
IXP_MANAGER_API_KEY=your-api-key-here

# --- Routers ---
# Path to routers.json config file (inside container)
ROUTERS_CONFIG_PATH=/app/config/routers.json

# --- NOC Contact ---
# Email address for your NOC (receives all notifications + server alerts)
NOC_EMAIL=noc@openix.ong

# --- SMTP (Mailgun) ---
SMTP_HOST=smtp.mailgun.org
SMTP_PORT=587
SMTP_USER=postmaster@mg.example.com
SMTP_PASS=your-smtp-password
SMTP_FROM=bgp-monitor@openix.ong
# Reply-To header on all outgoing emails (optional, omitted if not set)
# SMTP_REPLY_TO=noc@openix.ong
# Always CC this address on every notification (optional, omitted if not set)
# SMTP_CC=alerts@openix.ong

# --- Server Thresholds ---
# Consecutive failed polls before sending a server-down notification (default: 1)
# SERVER_DOWN_THRESHOLD=3
# Consecutive successful polls before sending a server-up notification (default: 1)
# SERVER_UP_THRESHOLD=3

# --- SSH ---
# User for SSH connections to Bird servers
SSH_USER=monitor
# Path to SSH private key (inside container: /app/ssh/id_ed25519)
SSH_KEY_PATH=/app/ssh/id_ed25519
SSH_PORT=22

# --- Database ---
# SQLite database path (inside container: /app/data/bgpnotifier.db)
DB_PATH=/app/data/bgpnotifier.db

# --- Cache ---
# How long to cache IXP Manager member data (in minutes)
IXP_CACHE_TTL_MINUTES=15