EAS Station Documentation

Welcome to the documentation for EAS Station - an Emergency Alert System platform.

IMPORTANT: This software is experimental and for laboratory use only. Not FCC-certified for production emergency alerting.


Getting Started

  1. Installation - One command to get running
  2. Setup Wizard - First-run configuration
  3. User Guide - Daily operations

Documentation by Role

For Operators

Guide What You'll Learn
User Guide Dashboard, alerts, monitoring
Setup Instructions First-time configuration
HTTPS Setup Secure access configuration

For Administrators

Guide What You'll Learn
Installation Guide Bare metal deployment
SDR Setup Radio receiver configuration
Firewall Requirements Network port configuration

For Developers

Guide What You'll Learn
Developer Guidelines Code standards, architecture, testing
JavaScript API REST API reference
Contributing How to contribute

System Overview

EAS Station integrates multiple alert sources (NOAA Weather, IPAWS Federal) and processes them through a pipeline that includes:

  • Multi-source alert aggregation
  • FCC-compliant SAME encoding
  • PostGIS spatial filtering
  • SDR broadcast verification
  • Built-in HTTPS with Let's Encrypt
  • GPIO relay and LED sign control

View Full Architecture Details | View Diagrams


Documentation Structure

docs/
├── architecture/    # System architecture and design
├── audio/           # Audio monitoring
├── development/     # Developer documentation
├── frontend/        # Web UI documentation
├── guides/          # User and operator guides
├── hardware/        # SDR and hardware setup
├── installation/    # Installation guides
├── maintenance/     # System maintenance
├── policies/        # Legal documents
├── process/         # Contributing and certification
├── reference/       # Reference materials
├── roadmap/         # Feature planning
├── security/        # Security documentation
└── troubleshooting/ # Problem-solving guides

Complete Index - Full list of all documentation


Common Tasks

Setup & Configuration

Daily Operations

Troubleshooting


Getting Help

  1. Check the documentation - Start with INDEX
  2. Review troubleshooting - See Common Issues
  3. Run diagnostics - Use built-in diagnostic tools
  4. Ask for help - GitHub Discussions
  5. Report bugs - GitHub Issues

Project Information

Resource Link
About Project Overview
Changelog Version History
Roadmap Future Features
License AGPL v3 (Open Source) / Commercial

Legal & Compliance


Contributing


Last Updated: 2026-02-13

Return to Main README | View Complete Index


This document is served from docs/README.md in the EAS Station installation.