grabowski
777b230baf
CI / Format & lint (push) Successful in 11s
Security / Static analysis (push) Successful in 12s
CI / Test suite (push) Successful in 18s
Docs / Validate documentation (push) Successful in 11s
Security / Dependency vulnerabilities (push) Successful in 1m30s
Security / License report (push) Successful in 47s
Anyone can now get push alerts on their phone without an account: the monitor publishes to an ntfy server (one Go binary, ~30 MB RSS) and subscribers pick topics in the free iOS/Android/web app. Semantics are transitions, never state. One message when a gauge crosses its warning or danger threshold, one all-clear when it drops back (0.10 m hysteresis), nothing while it sits above. A three-day flood is two messages; a quiet season is zero. Topics: ping-warning / ping-danger (basin digest), ping-<station>-warning / -danger, ping-p1-outlook (opt-in: model P(warning within 24 h) at P.1 rises through 50 %, clears below 25 %, message says it is experimental), ping-status (feed stale >= 3 h / recovered). Priority 5 on danger so it rings through Do Not Disturb. src/notify.py runs once per collection cycle in the API process (leader only, after the forecast precompute, same data the dashboard shows). Last-sent state lives in a notification_state table so a restart never re-sends; a failed publish leaves state untouched so the crossing is retried next cycle instead of lost. Off unless NTFY_SERVER is set. Dashboard: a "Get alerts" button (only when configured) opens a panel with the server, per-topic cards, ntfy:// deep links and web links, app store links and a disclaimer. EN + TH. GET /api/notifications feeds it. scripts/install_ntfy.sh: .deb install, server.yml (loopback listen, anonymous read, token-only write scoped to ping-*, 72 h cache, signup/ login/metrics off, tight visitor limits), systemd, user + token, .env. Verified against ntfy 2.28.0: anon publish 403, token publish 200, token on foreign topic 403, anon read 200, and a seeded crossing through the real _notify_transitions path arrived in the topic with priority, tags, click and action button. docs/NOTIFICATIONS.md has the deployment and reverse-proxy notes. Tests: 10 for the state machine (159 total).
110 lines
2.9 KiB
Bash
110 lines
2.9 KiB
Bash
# Northern Thailand Ping River Monitor Configuration
|
|
# Copy this file to .env and customize for your environment
|
|
|
|
# Database Configuration
|
|
DB_TYPE=postgresql
|
|
# Options: sqlite, mysql, postgresql, influxdb, victoriametrics
|
|
|
|
# SQLite Configuration (default)
|
|
WATER_DB_PATH=water_levels.db
|
|
|
|
# VictoriaMetrics Configuration
|
|
VM_HOST=localhost
|
|
VM_PORT=8428
|
|
VM_URL=
|
|
|
|
# InfluxDB Configuration
|
|
INFLUX_HOST=localhost
|
|
INFLUX_PORT=8086
|
|
INFLUX_DATABASE=ping_river_monitoring
|
|
INFLUX_USERNAME=
|
|
INFLUX_PASSWORD=
|
|
|
|
# PostgreSQL Configuration (Remote Server)
|
|
# Option 1: Full connection string (URL encode special characters in password)
|
|
POSTGRES_CONNECTION_STRING=postgresql://username:url_encoded_password@your-postgres-host:5432/water_monitoring
|
|
|
|
# Option 2: Individual components (password will be automatically URL encoded)
|
|
POSTGRES_HOST=your-postgres-host
|
|
POSTGRES_PORT=5432
|
|
POSTGRES_DB=water_monitoring
|
|
POSTGRES_USER=username
|
|
POSTGRES_PASSWORD=your:password@with!special#chars
|
|
|
|
# Examples for connection string:
|
|
# - Local: postgresql://postgres:password@localhost:5432/water_monitoring
|
|
# - Remote: postgresql://user:pass@192.168.1.100:5432/water_monitoring
|
|
# - With special chars: postgresql://user:my%3Apass%40word@host:5432/db
|
|
# - With SSL: postgresql://user:pass@host:port/db?sslmode=require
|
|
# - Connection pooling: postgresql://user:pass@host:port/db?pool_size=20&max_overflow=0
|
|
|
|
# Special character URL encoding:
|
|
# : → %3A @ → %40 # → %23 ? → %3F & → %26 / → %2F % → %25
|
|
|
|
# MySQL Configuration
|
|
MYSQL_CONNECTION_STRING=mysql://user:password@localhost:3306/ping_river_monitoring
|
|
|
|
# API Configuration
|
|
API_HOST=0.0.0.0
|
|
API_PORT=8000
|
|
API_WORKERS=1
|
|
# Public ThaiWater API key used to add Ping-basin water-level sensors.
|
|
THAIWATER_API_KEY=
|
|
|
|
# Data Collection Settings
|
|
SCRAPING_INTERVAL_HOURS=1
|
|
REQUEST_TIMEOUT=30
|
|
MAX_RETRIES=3
|
|
RETRY_DELAY_SECONDS=60
|
|
|
|
# Data Retention
|
|
DATA_RETENTION_DAYS=365
|
|
|
|
# Logging Configuration
|
|
LOG_LEVEL=INFO
|
|
LOG_FILE=water_monitor.log
|
|
|
|
# Security (for production)
|
|
SECRET_KEY=your-secret-key-here
|
|
API_KEY=your-api-key-here
|
|
|
|
# Monitoring
|
|
ENABLE_METRICS=true
|
|
ENABLE_HEALTH_CHECKS=true
|
|
|
|
# Geographic Settings
|
|
TIMEZONE=Asia/Bangkok
|
|
DEFAULT_LATITUDE=18.7875
|
|
DEFAULT_LONGITUDE=99.0045
|
|
|
|
# External Services
|
|
NOTIFICATION_EMAIL=
|
|
SMTP_SERVER=
|
|
SMTP_PORT=587
|
|
SMTP_USERNAME=
|
|
SMTP_PASSWORD=
|
|
|
|
# Public push notifications via self-hosted ntfy (https://ntfy.sh, single binary).
|
|
# Leave NTFY_SERVER empty to disable. Topics published: <prefix>-<station>-warning,
|
|
# <prefix>-<station>-danger, <prefix>-warning, <prefix>-danger, <prefix>-p1-outlook,
|
|
# <prefix>-status. See docs/NOTIFICATIONS.md.
|
|
NTFY_SERVER=
|
|
NTFY_TOPIC_PREFIX=ping
|
|
NTFY_TOKEN=
|
|
PUBLIC_URL=https://water.buildfor.life/
|
|
|
|
# Matrix Alerting Configuration
|
|
MATRIX_HOMESERVER=https://matrix.org
|
|
MATRIX_ACCESS_TOKEN=
|
|
MATRIX_ROOM_ID=
|
|
|
|
# Grafana Integration
|
|
GRAFANA_URL=http://localhost:3000
|
|
|
|
# Alert Configuration
|
|
ALERT_MAX_AGE_HOURS=2
|
|
ALERT_CHECK_INTERVAL_MINUTES=15
|
|
|
|
# Development Settings
|
|
DEBUG=false
|
|
DEVELOPMENT_MODE=false |