📚 EAS Station Documentation Index
Welcome to the complete documentation for EAS Station - an Emergency Alert System platform built for amateur radio operators and emergency communications professionals.
🚀 Quick Start
If you're new to EAS Station, start here:
| Document | Description |
|---|---|
| Main README | Installation and overview |
| Setup Instructions | First-run configuration |
| Portainer Deployment | Container-based setup |
📊 Visual Documentation
| Diagram | Description |
|---|---|
| All Diagrams Index | Complete visual documentation |
👥 User Documentation
Essential Guides
| Document | Description |
|---|---|
| Help & Operations Guide | Complete operator manual |
| Setup Instructions | Initial configuration |
| HTTPS Setup | SSL/TLS certificates |
| IPAWS Integration | Federal alert source setup |
| One-Button Upgrade | Automated updates |
Hardware & Audio
| Document | Description |
|---|---|
| SDR Setup Guide | Radio receiver configuration |
| Audio Monitoring | Live stream viewer |
🛠️ Developer Documentation
| Document | Description |
|---|---|
| Developer Guidelines | Code standards and architecture |
| Contributing Guide | How to contribute |
| System Architecture | Overall system design |
| Theory of Operation | How the system works |
| Data Flow Sequences | Detailed mermaid diagrams |
| Display System Architecture | Display subsystem diagrams |
| EAS Decoding Summary | Architecture analysis |
🎨 Frontend Documentation
| Document | Description |
|---|---|
| User Interface Guide | Web interface navigation |
| JavaScript API | API documentation |
| Component Library | UI component reference |
🔧 Troubleshooting
| Document | Description |
|---|---|
| Database Issues | PostgreSQL troubleshooting |
| SDR Waterfall Issues | SDR troubleshooting |
🔐 Security & Legal
| Document | Description |
|---|---|
| Security Guide | Security best practices |
| Password Guide | Password management |
| Terms of Use | Usage terms |
| Privacy Policy | Privacy information |
📈 Project Information
| Document | Description |
|---|---|
| About EAS Station | Project background |
| Changelog | Version history |
| Ohio EAS Documentation | Ohio EAS system reference |
| Feature Roadmap | Planned features |
📁 File Organization
docs/
├── guides/ # 5 essential user guides
├── architecture/ # 5 system architecture docs (with diagrams)
├── audio/ # 1 audio monitoring guide
├── deployment/ # 1 deployment guide
├── development/ # 1 developer guide
├── frontend/ # 3 UI documentation files
├── hardware/ # 1 SDR setup guide
├── troubleshooting/ # 2 problem-solving guides
├── security/ # 2 security guides
├── reference/ # 3 reference materials
├── roadmap/ # 1 roadmap document
├── policies/ # 2 legal documents
└── process/ # 1 contributing guide
🔍 Finding Information
By User Type
- New Users: Start with Setup Instructions
- Operators: See Help & Operations Guide
- Admins: Check Portainer Deployment
- Developers: Review Developer Guidelines
🆘 Getting Help
- Check Documentation: Start with the relevant guide above
- Search Issues: GitHub Issues
- Community Support: GitHub Discussions
📊 Documentation Statistics
| Metric | Value |
|---|---|
| Total Documentation Files | 31 |
| Essential User Guides | 5 |
| Technical Documents | 8 |
| Legal/Policy Documents | 4 |
| Total Directories | 13 |
Last Updated: 2025-11-25 Version: 4.0 (Streamlined for Website) For questions or contributions, see the Contributing Guide
This document is served from docs/INDEX.md in the EAS Station installation.