zwitschi
926a663c23
- Created README.md in docs folder outlining project structure and documentation links. - Added SECURITY.md detailing the security model, threat model, authentication, transport security, network isolation, and incident response procedures. - Introduced SETUP.md providing a detailed setup guide for local and production environments, including prerequisites, environment setup, and Gitea integration. - Added STREAMING.md outlining the streaming pipeline, including production flow, source-media contract, playout and HLS packaging, cache contract, player behavior, and monitoring. - Updated architecture documentation to include links to new SETUP.md and STREAMING.md files for better navigation.
1.2 KiB
1.2 KiB
Docs Folder
This folder contains the documentation for the Linear Void project. The documentation is organized into several markdown files, each covering different aspects of the project.
Architecture
- Architecture - High-level system architecture and component interactions.
API
- API - Implemented WebSocket and REST API reference.
Deployment
- Deployment - Production deployment and operational runbook.
Monitoring
- Monitoring - Metrics, dashboards, and monitoring troubleshooting.
Security
- Security - Security model, controls, and hardening baseline.
Setup
- Setup - Test lab setup, local development, and CI/CD workflow.
Streaming
- Streaming - Streaming architecture, playout, and delivery details.
Development
- Development - Remaining tasks and test fixtures for development.
Additional Resources
- Marketing - Marketing materials and resources.
- Operations - Operational procedures and checklists.
- Incident Runbook - Incident response and disaster recovery procedures.