Documentation for WebVideo2NAS is split into two trees. This page is the map — each topic has one source of truth; follow the link rather than duplicating.
Comprehensive reference for operators and integrators.
| Document | Source of truth for |
|---|---|
| ARCHITECTURE.md | System architecture, data-flow diagrams, DB schema overview, Redis structures, multi-worker layout, deployment topology |
| SPECIFICATION.md | API endpoint contracts, request/response models, job status vocabulary, technology stack, directory layout |
| PRIVACY_SECURITY.md | Data handling, secrets, storage locations, browser-side safety model, disclosure notes |
| THREAT_MODEL.md | Adversary model, trust boundaries, and mitigations (maintained separately) |
Implementation deep-dives for people changing the code live in
development/ — see its index. Chapters:
getting started, architecture internals, chrome extension, worker pipeline,
API + DB internals, testing, CI/release, and bug case studies.
- Install / configure / troubleshoot / changelog → root README.md
- Synology copy-paste command reference →
video-downloader/docker/SYNOLOGY_DEPLOY_COMMANDS.md - Annotated environment variables →
video-downloader/docker/.env.example
When two documents would describe the same thing, the owner above wins and the other should link to it. When you change behaviour, update the owning document in the same change. Test counts, service/container names, and env-var defaults are the usual drift culprits — verify against the actual source file before copying a number or name into prose.