homeio
PublicForked from doctor-io/homeio
Files
Ahmed TabibMerge pull request #68 from ikhsanddy/ci/trigger-verify-on-pr
958d74616 October 2026248 commits
- ..
- architecture Type: folder
- modules Type: folder
- qa Type: folder
- api-reference.md Type: fileSize: 12,979
- architecture.md Type: fileSize: 9,674
- backend-architecture.md Type: fileSize: 3,228
- contributing.md Type: fileSize: 3,342
- conventions.md Type: fileSize: 7,746
- database.md Type: fileSize: 5,282
- marketing-promotion-plan.md Type: fileSize: 12,053
- PRD.md Type: fileSize: 3,096
- README.md Type: fileSize: 2,946
- roadmap-v1.7.md Type: fileSize: 58,093
- security.md Type: fileSize: 5,782
- testing.md Type: fileSize: 3,508
- ui-design-notes.md Type: fileSize: 4,045
README
Homeio Documentation
Homeio is a self-hosted home server dashboard with a desktop-style Next.js UI for managing Docker Compose apps, files, terminal access, system metrics, scheduled tasks, notifications, storage, Google Drive, disk management, and network controls. These docs are written for maintainers and AI coding agents; the current code is the source of truth, and PROJECT_AUDIT.md is a historical audit of v1.6.1.
Docs Index
| Document | Read this when you want to |
|---|---|
| PRD.md | Understand the product vision, personas, non-goals, and roadmap links |
| architecture.md | Understand processes, data flow, SSE/WebSocket behavior, build/deployment topology |
| conventions.md | Follow coding patterns, route conventions, contracts, query keys, and anti-patterns |
| api-reference.md | Find HTTP, SSE, and WebSocket route behavior |
| database.md | Inspect tables, relationships, and migration workflow |
| security.md | Understand auth, host privilege risks, and known gaps |
| testing.md | Add or run Vitest tests |
| contributing.md | Set up local development and prepare PRs |
| modules/README.md | Choose the correct feature module doc |
Quick Links
- I want to add a feature module: contributing.md, conventions.md
- I want to add an API route: conventions.md, api-reference.md
- I want to modify the file manager: modules/files.md
- I want to modify Google Drive or OAuth settings: modules/files.md, api-reference.md, database.md
- I want to modify App Store installs: modules/apps.md, modules/docker.md
- I want to modify auth/session behavior: modules/auth.md, security.md
- I want to modify system metrics, server info, disks, or SSE: modules/system.md, architecture.md
- I want to modify terminal behavior: modules/shell.md, api-reference.md
- I want to add a database table: database.md, conventions.md
- I want to add a settings section: contributing.md, conventions.md
Source Of Truth
- Use
PROJECT_AUDIT.mdfor the 2026-05-01 audit of v1.6.1 — historical findings and architectural context, not current state. - Use current code for exact route lists, schemas, functions, tests, and implementation details.
- If docs and code disagree, verify in code and update docs.