olemd/skyview
1
0
Fork 0
Code Issues 12 Pull requests Projects Releases 11 Packages Wiki Activity Actions

docs: Update README with database management and configuration sections

Browse source 
- Add database management commands and optimization examples
- Reference new CONFIGURATION.md documentation
- Update systemd service references to use skyview-adsb
- Enhance skyview-data status command with optimization statistics

🤖 Generated with [Claude Code](https://claude.ai/code)

Co-Authored-By: Claude <noreply@anthropic.com>
This commit is contained in:
Ole-Morten Duesund 2025-08-31 19:40:44 +02:00
commit 7b16327bd2
2 changed files with 144 additions and 11 deletions
Download patch file Download diff file Expand all files Collapse all files

68
README.md
View file

@ -27,12 +27,15 @@ A high-performance, multi-source ADS-B aircraft tracking application that connec
- **Map Controls**: Center on aircraft, reset to origin, toggle overlays
- **Signal Heatmaps**: Coverage heatmap visualization *(under construction)* 🚧
### Aircraft Data
### Aircraft Data Enhancement
- **Complete Mode S Decoding**: Position, velocity, altitude, heading
- **Aircraft Identification**: Callsign, category, country, registration
- **Enhanced Callsign Lookup**: Multi-source airline database with 6,162+ airlines and 83,557+ airports
- **Aviation Data Integration**: OpenFlights and OurAirports databases with automatic updates
- **ICAO Country Database**: Comprehensive embedded database with 70+ allocations covering 40+ countries
- **Multi-source Tracking**: Signal strength from each receiver
- **Historical Data**: Position history and trail visualization
- **Historical Data**: Position history with configurable retention
- **Database Optimization**: Automatic VACUUM operations and storage efficiency monitoring
## 🚀 Quick Start
@ -255,23 +258,66 @@ sudo journalctl -u skyview -f
make build
# Create user and directories
sudo useradd -r -s /bin/false skyview
sudo mkdir -p /etc/skyview /var/lib/skyview /var/log/skyview
sudo chown skyview:skyview /var/lib/skyview /var/log/skyview
sudo useradd -r -s /bin/false skyview-adsb
sudo mkdir -p /etc/skyview-adsb /var/lib/skyview-adsb /var/log/skyview-adsb
sudo chown skyview-adsb:skyview-adsb /var/lib/skyview-adsb /var/log/skyview-adsb
# Install binary and config
sudo cp build/skyview /usr/bin/
sudo cp config.example.json /etc/skyview/config.json
sudo chown root:skyview /etc/skyview/config.json
sudo chmod 640 /etc/skyview/config.json
sudo cp build/skyview-data /usr/bin/
sudo cp config.example.json /etc/skyview-adsb/config.json
sudo chown root:skyview-adsb /etc/skyview-adsb/config.json
sudo chmod 640 /etc/skyview-adsb/config.json
# Create systemd service
sudo cp debian/lib/systemd/system/skyview.service /lib/systemd/system/
sudo cp debian/lib/systemd/system/skyview-adsb.service /lib/systemd/system/
sudo cp debian/lib/systemd/system/skyview-database-update.service /lib/systemd/system/
sudo cp debian/lib/systemd/system/skyview-database-update.timer /lib/systemd/system/
sudo systemctl daemon-reload
sudo systemctl enable skyview
sudo systemctl start skyview
sudo systemctl enable skyview-adsb
sudo systemctl enable skyview-database-update.timer
sudo systemctl start skyview-adsb
sudo systemctl start skyview-database-update.timer
```
### Database Management
SkyView includes powerful database management capabilities through the `skyview-data` command:
```bash
# Update aviation data sources (airlines, airports)
skyview-data update
# Optimize database storage and performance
skyview-data optimize
# Check database optimization statistics
skyview-data optimize --stats-only
# List available data sources
skyview-data list
# Check current database status
skyview-data status
```
The system automatically:
- Updates aviation databases on service startup
- Runs weekly database updates via systemd timer
- Optimizes storage with VACUUM operations
- Monitors database efficiency and statistics
### Configuration
SkyView supports comprehensive configuration including external aviation data sources:
- **3 External Data Sources**: OpenFlights Airlines (~6,162), OpenFlights Airports (~7,698), OurAirports (~83,557)
- **Database Management**: Automatic optimization, configurable retention, backup settings
- **Privacy Controls**: Privacy mode for air-gapped operation, selective source control
- **Performance Tuning**: Connection pooling, cache settings, update intervals
See **[Configuration Guide](docs/CONFIGURATION.md)** for complete documentation of all options.
## 🔒 Security
The application includes security hardening: