diff --git a/README.md b/README.md index caf4ef2..f15ad94 100644 --- a/README.md +++ b/README.md @@ -33,6 +33,7 @@ Support the developer of this open-source project - **ACARS Messaging** - Aircraft datalink messages via acarsdec - **Listening Post** - Frequency scanner with audio monitoring - **Satellite Tracking** - Pass prediction using TLE data +- **ADS-B History** - Persistent aircraft history with reporting dashboard (Postgres optional) - **WiFi Scanning** - Monitor mode reconnaissance via aircrack-ng - **Bluetooth Scanning** - Device discovery and tracker detection - **Spy Stations** - Number stations and diplomatic HF network database @@ -51,27 +52,50 @@ cd intercept sudo -E venv/bin/python intercept.py ``` -### Docker (Alternative) - -```bash -git clone https://github.com/smittix/intercept.git -cd intercept -docker compose up -d -``` - -> **Note:** Docker requires privileged mode for USB SDR access. See `docker-compose.yml` for configuration options. - -### Local Fixes Branch (Optional) - -If you keep local changes (e.g., custom health checks), use a separate branch and rebase it after updates: - -```bash -git fetch origin -git checkout local-fixes -git rebase origin/main -``` - -### Open the Interface +### Docker (Alternative) + +```bash +git clone https://github.com/smittix/intercept.git +cd intercept +docker compose up -d +``` + +> **Note:** Docker requires privileged mode for USB SDR access. See `docker-compose.yml` for configuration options. + +### ADS-B History (Optional, Postgres) + +The ADS-B history dashboard persists aircraft messages and snapshots to Postgres. + +1. Enable history and DB connection: + +```bash +export INTERCEPT_ADSB_HISTORY_ENABLED=true +export INTERCEPT_ADSB_DB_HOST=adsb_db +export INTERCEPT_ADSB_DB_PORT=5432 +export INTERCEPT_ADSB_DB_NAME=intercept_adsb +export INTERCEPT_ADSB_DB_USER=intercept +export INTERCEPT_ADSB_DB_PASSWORD=intercept +``` + +2. Start the services (includes Postgres in `docker-compose.yml`): + +```bash +docker compose up -d +``` + +3. Open **/adsb/history** for the reporting dashboard and headless start/stop controls. + +### Local Fixes Branch (Optional) + +If you keep local changes (e.g., custom health checks), use a separate branch and rebase it after updates: + +```bash +git fetch origin +git checkout local-fixes +git rebase origin/main +``` + +### Open the Interface After starting, open **http://localhost:5050** in your browser. The username and password is admin:admin diff --git a/docs/FEATURES.md b/docs/FEATURES.md index 99f216a..5a93cff 100644 --- a/docs/FEATURES.md +++ b/docs/FEATURES.md @@ -38,20 +38,22 @@ Complete feature list for all modules. - **Source links** - references to priyom.org for detailed information - **Famous stations** - UVB-76 "The Buzzer", Cuban HM01, Israeli E17z -## ADS-B Aircraft Tracking - -- **Real-time aircraft tracking** via dump1090 or rtl_adsb -- **Full-screen dashboard** - dedicated popout with virtual radar scope -- **Interactive Leaflet map** with OpenStreetMap tiles (dark-themed) -- **Aircraft trails** - optional flight path history visualization -- **Range rings** - distance reference circles from observer position -- **Aircraft filtering** - show all, military only, civil only, or emergency only -- **Marker clustering** - group nearby aircraft at lower zoom levels -- **Reception statistics** - max range, message rate, busiest hour, total seen -- **Observer location** - manual input or GPS geolocation -- **Audio alerts** - notifications for military and emergency aircraft -- **Emergency squawk highlighting** - visual alerts for 7500/7600/7700 -- **Aircraft details popup** - callsign, altitude, speed, heading, squawk, ICAO +## ADS-B Aircraft Tracking + +- **Real-time aircraft tracking** via dump1090 or rtl_adsb +- **Full-screen dashboard** - dedicated popout with virtual radar scope +- **Interactive Leaflet map** with OpenStreetMap tiles (dark-themed) +- **Aircraft trails** - optional flight path history visualization +- **Range rings** - distance reference circles from observer position +- **Aircraft filtering** - show all, military only, civil only, or emergency only +- **Marker clustering** - group nearby aircraft at lower zoom levels +- **Reception statistics** - max range, message rate, busiest hour, total seen +- **Persistent ADS-B history** - optional Postgres-backed message and snapshot storage +- **History reporting dashboard** - session controls, aircraft timelines, and detail modal +- **Observer location** - manual input or GPS geolocation +- **Audio alerts** - notifications for military and emergency aircraft +- **Emergency squawk highlighting** - visual alerts for 7500/7600/7700 +- **Aircraft details popup** - callsign, altitude, speed, heading, squawk, ICAO
diff --git a/docs/USAGE.md b/docs/USAGE.md
index a3d7692..7abdf04 100644
--- a/docs/USAGE.md
+++ b/docs/USAGE.md
@@ -74,10 +74,42 @@ INTERCEPT automatically detects known trackers:
### Emergency Squawks
-The system highlights aircraft transmitting emergency squawks:
-- **7500** - Hijack
-- **7600** - Radio failure
-- **7700** - General emergency
+The system highlights aircraft transmitting emergency squawks:
+- **7500** - Hijack
+- **7600** - Radio failure
+- **7700** - General emergency
+
+## ADS-B History (Optional)
+
+The history dashboard persists aircraft messages and per-aircraft snapshots to Postgres for long-running tracking and reporting.
+
+### Enable History
+
+Set the following environment variables (Docker recommended):
+
+| Variable | Default | Description |
+|----------|---------|-------------|
+| `INTERCEPT_ADSB_HISTORY_ENABLED` | `false` | Enables history storage and reporting |
+| `INTERCEPT_ADSB_DB_HOST` | `localhost` | Postgres host (use `adsb_db` in Docker) |
+| `INTERCEPT_ADSB_DB_PORT` | `5432` | Postgres port |
+| `INTERCEPT_ADSB_DB_NAME` | `intercept_adsb` | Database name |
+| `INTERCEPT_ADSB_DB_USER` | `intercept` | Database user |
+| `INTERCEPT_ADSB_DB_PASSWORD` | `intercept` | Database password |
+
+### Docker Setup
+
+`docker-compose.yml` includes an `adsb_db` service and a persistent volume for history storage:
+
+```bash
+docker compose up -d
+```
+
+### Using the History Dashboard
+
+1. Open **/adsb/history**
+2. Use **Start Tracking** to run ADS-B in headless mode
+3. View aircraft history and timelines
+4. Stop tracking when desired (session history is recorded)
## Satellite Mode