Planekeeper Internal Docs
Planekeeper internal documentation — architecture, API, database, and operations reference.
Internal reference for the Planekeeper development team. For the public user-facing documentation, see the User Docs.
Architecture
System overview, nine binaries, service topology, Traefik routing, and project structure.
Database
Schema reference, 26 tables, 9 enums, seed data, and 31 migrations.
API Reference
All 100+ endpoints across Client, Agent, and Internal APIs.
Configuration
36+ environment variables and build-time service IDs.
Development
Make commands, coding standards, and common tasks.
Operations
Deployment guide, debugging production, and onboarding.
Business Logic
Job workflows, rule evaluation, alert generation, notifications, and state machines.
Testing
E2E test plan and automation strategy.
Troubleshooting
Agent connectivity, stuck jobs, rate limits, and common issues.
Pages in this section
API
API authentication, endpoints, and integration details.
Architecture
System overview, binaries, and project structure.
Configuration
Environment variables and service IDs.
Database
Schema design and migration management.
Development
Commands, coding standards, and common tasks.
Operations
Deployment, debugging, and onboarding.
QA
QA checklists and release validation.
Reference
Permissions and configuration reference.
Testing
E2E test plans and automation strategy.
Troubleshooting
Debugging guides and common issues.