Help & Operations Guide
Complete documentation for operating and maintaining your EAS Station
Quick Navigation
Jump directly into the workflows you open most often.
Operations Flow
-
1
Monitor & Capture
CAP polling + SDR ingest keep alerts flowing in.
-
2
Analyze & Verify
Rule filters, analytics, and operator review.
-
3
Broadcast & Notify
Builder, audio playout, GPIO, and displays.
-
4
Audit & Improve
Archive, compliance, and analytics feedback.
Safety Expectations
- Isolated Networks: Operate the stack in isolated development or staging networks disconnected from broadcast transmitter controls.
- No Live Credentials: Do not ingest live IPAWS credentials, dispatch feeds, or mission-critical telemetry into this environment.
- Validated Workflows: Validate any workflows on certified FCC equipment before using them in real-world alerting scenarios.
- Legal Review: Review the repository Terms of Use and Privacy Policy with your operators prior to onboarding.
Getting Started
-
Review DocumentationThe About page covers system goals, core services, and the complete software stack.
-
Provision InfrastructureDeploy Docker Engine 24+ with Docker Compose V2 and ensure a dedicated PostgreSQL 15 + PostGIS database container is available.
-
Configure EnvironmentCopy
.env.exampleto.env, set secure secrets, and update database connection details. -
Launch the StackRun
docker compose up -d --buildafter.envpoints at your PostgreSQL/PostGIS deployment.
Routine Operations
Navigate to http://<host>:5000 in a modern browser.
Log in with administrator credentials created during initial setup.
- Open the Dashboard to view active CAP products on the interactive map.
- Use the Statistics tab to analyze severity, event types, and historical counts.
- Check System Health for CPU, memory, disk, receiver, and audio pipeline heartbeat metrics.
- Navigate to Alert Verification (
/admin/alert-verification) to inspect delivery timelines and per-target outcomes. - Upload captured WAV or MP3 files to decode SAME bursts directly in the browser.
- Store decoded results for future comparison from the sidebar list.
Importing Boundary Data
The system supports two methods for importing geographic boundary data:
- GeoJSON Files: Upload GeoJSON files directly via the "Upload Files" tab
- Shapefiles: Upload ESRI Shapefiles (ZIP archives with .shp, .shx, .dbf files) or import existing shapefiles from the server
Using Shapefiles
Navigate to Admin → Upload Files and scroll to the "Upload Shapefiles" section:
- View Server Files: Click "Refresh List" to see shapefiles already on the server (e.g., in
/streams and ponds) - Import Existing: Click "Import" next to any complete shapefile to convert and load it into the database
- Upload New: Upload a ZIP file containing all shapefile components and select the boundary type
streams and ponds directory.
Supported Boundary Types
- 🌊 Rivers & Streams - Linear water features
- 💧 Lakes & Ponds - Area water bodies
- ⚡ Electric Providers - Utility service areas
- 🏘️ Villages & Townships - Municipal boundaries
- 🏫 School Districts
- 🔥 Fire Districts
- 🚑 EMS Districts
- 🚆 Railroads - Rail corridors
- 📞 Telephone Providers
- 🗺️ County Outlines
Additional Configuration
- Alert Configuration: Set up alert routing and notification preferences in the admin panel
- Filter Settings: Configure geographic and event-based alert filtering
- Intersection Calculation: After uploading boundaries, calculate intersections via Operations → Calculate Intersections
- Toggle Auto Start or Enabled to control which receivers the radio manager spins up during poller runs.
- Use the action menu to request synchronized IQ/PCM captures.
- Captured files are surfaced alongside status updates in the compliance dashboard.
Create dynamic content templates for LED signs and VFD displays with API data integration.
- Screen Templates: Define custom layouts with variable substitution from API endpoints like
/api/system_status,/api/alerts, and/api/monitoring/radio - LED Displays: Configure text content (4 lines × 20 chars) with color, animation mode, and speed settings
- VFD Graphics: Build graphical screens with progress bars, VU meters, text, shapes, and images on 140×32 pixel displays
- Screen Rotation: Set up automatic cycling between multiple screens with configurable durations
- Dynamic Data: Display system health, CPU/memory usage, alert counts, network info, signal strength, and more
- Priority Management: Emergency screens override rotation; alerts pause normal displays
/screens
Accessible from the top navigation once logged in. Use the browser-based workflow to:
- Pick a state or territory
- Choose county/parish or statewide SAME codes
- Select originator code (EAS, CIV, WXR, PEP)
- Choose from authorized 47 CFR §11.31(d-e) event types
- Preview the SAME header in real-time
- Generate complete packages with SAME bursts, attention tones, and narration
docker compose exec app python tools/generate_sample_audio.py
Required Weekly Test (RWT) broadcasts can be automatically scheduled to run on specific days and time windows.
Accessing Weekly Test Automation
- Navigate to Broadcast → Weekly Test Automation from the navigation menu
- Or visit
/rwt-scheduledirectly
Configuration Options
- Enable/Disable: Toggle automatic RWT broadcasts on or off
- Days of Week: Select which days to send RWT (Monday through Sunday)
- Time Window: Set start and end times (e.g., 8:00 AM to 4:00 PM)
- Coverage: The scheduler always follows the shared Default RWT Counties list that sits next to the form—update it once and Quick RWT, manual defaults, and automation all stay aligned.
EAS_ORIGINATOR and EAS_STATION_ID environment variables that also feed the Broadcast Builder console.
RWT Broadcast Behavior
Automatic RWT broadcasts are designed to be lean and FCC-compliant:
- No TTS Narration: RWT contains only SAME headers and EOM tones
- No Attention Tones: Silent except for required signaling
- Once Per Day: Only one RWT sent per configured day
- Time Window: Broadcasts only during configured hours
- Logged: All broadcasts stored in database for compliance tracking
Testing Your Configuration
Use the "Send Test RWT Now" button to immediately trigger a test broadcast and verify your configuration.
Troubleshooting
- Check Logs: Run
docker compose logs -fto see container startup messages. - Database Connection: Verify
POSTGRES_*settings in.envmatch your database deployment. - Secret Key: Ensure
SECRET_KEYis set to a non-empty value. - Port Conflicts: Confirm port 5000 isn't already in use.
- PostGIS Extension: Ensure your database has the PostGIS extension enabled:
CREATE EXTENSION IF NOT EXISTS postgis; - Spatial Indexes: Check that boundary tables have spatial indexes for performance.
- Geometry Types: Verify imported GeoJSON files use valid geometry types.
- Audio Drivers: Verify sound card drivers are working on the host system.
- File Permissions: Check that the application has write access to audio output directories.
- Azure Speech: If using Azure TTS, verify API keys and regional endpoints.
- Serial Connection: Verify the serial port device exists and is accessible.
- Protocol Settings: Check that baud rate and protocol settings match your sign model.
- Network Access: Ensure the application can reach the sign's IP address if using network control.
Reference Commands
Docker Operations
# View logs
docker compose logs -f
# Restart services
docker compose restart
# Update stack
docker compose pull && docker compose up -d
Database Operations
# Reset database
docker compose exec app python tools/reset_database.py
# Check health
docker compose exec app python tools/check_db_health.py
Audio & Testing
# Generate test audio
docker compose exec app python tools/generate_sample_audio.py
# Test receivers
docker compose exec app python tools/test_receivers.py
System Status
# System health
curl http://localhost:5000/api/system_health
# Version info
curl http://localhost:5000/version
Getting Help
-
1Check Documentation: Review this guide and the About page for system information.
-
2Review Logs: Run
docker compose logs -fto identify error messages. -
3Check System Health: Visit System Health for status overview.
-
4Search Issues: Look for similar problems on GitHub Issues.
-
5Create New Issue: Provide logs, configuration (redact secrets), and steps to reproduce.
Trusted Field Resources
Curated references from NOAA, FEMA IPAWS, and ARRL to keep operations sharp.
NOAA Weather Service
Primary CAP documentation, glossary, and sample payloads.
FEMA IPAWS Lab
Interoperability, architecture, and test schedule references.
ARRL Field Playbooks
ARES task books, ICS-213 templates, and readiness checklists.