Documentation
Getting Started
Documentation Index
Architecture
Data Flow Sequences Display System Architecture Eas Decoding Summary System Architecture Theory Of Operation
Development
Agents Component Library Contributing Javascript Api User Interface Guide
Reference
About Audio Monitoring Changelog Dasdec3 Feature Roadmap Database Consistency Fixes Diagrams Index Ohio Eas Documentation Overview Portainer Deployment Repository Statistics Sdr Setup Sdr Waterfall Troubleshooting Security Security Password Guide
Guides
Help Https Setup Ipaws Feed Integration One Button Upgrade Setup Instructions
Policies
Privacy Policy Terms Of Use

📚 EAS Station Documentation

Welcome! This is your complete guide to the EAS Station emergency alert system.

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

🚀 Getting Started

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

📖 Documentation by Role

🎯 For Operators

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

🔧 For Administrators

Deployment, security, and maintenance
Guide What You'll Learn
Portainer Deployment Complete deployment guide
SDR Setup Radio receiver configuration
Hardware Build Raspberry Pi setup
Database Troubleshooting PostgreSQL issues

💻 For Developers

Architecture, APIs, and contributing
Guide What You'll Learn
Developer Guidelines Code standards, architecture, testing
Frontend Documentation UI components, theming
JavaScript API REST API reference
Contributing How to contribute

🗺️ System Overview

Architecture

EAS Station integrates multiple alert sources (NOAA Weather, IPAWS Federal) and processes them through a sophisticated 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 Visual Diagrams →

📂 Documentation Structure

docs/
├── guides/              ← Essential operator guides (5 files)
├── hardware/            ← SDR, GPIO, Raspberry Pi setup
├── audio/               ← Audio system documentation
├── deployment/          ← Deployment and maintenance guides
├── evaluations/         ← Hardware evaluation reports
├── troubleshooting/     ← Problem-solving guides
├── development/         ← Developer documentation
├── architecture/        ← System design and theory
├── frontend/            ← Web UI documentation
├── reference/           ← Technical reference materials
├── security/            ← Security documentation
├── roadmap/             ← Future features and planning
└── resources/           ← Vendor PDFs and external docs
Complete Index - Searchable 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

We welcome contributions! See:

Last Updated: 2025-11-25 Documentation Version: 3.0 (Reorganized Structure)Return to Main README | View Complete Index
Back to Documentation Index

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