Expand description
kasl-server as a library.
The binary is a thin wrapper: configuration, a pool, migrations, then
app::router. Everything else lives here so integration tests can drive
the real router and the real provisioning path instead of a copy that
drifts from what ships.
Modules§
- admin
- Managing people and the agents that report for them.
- alerts
- Alerts: what the server noticed now, and what somebody did about it.
- app
- audit
- The audit log: who did what, to whom, and when.
- auth
- Agent authentication: who is allowed to upload, and on whose behalf.
- backup
kasl-server backupandrestore: the installation’s data as one file.- calendar
- The production calendar and the norm: how much a date was meant to be worked, and by whom.
- config
- demo
- A fictional team, so the dashboards can be seen before a single agent is installed on anybody’s machine.
- department
- Departments: the boundary a manager’s authority is measured in.
- error
- One error shape for the whole API.
- heartbeat
- The agent’s pulse:
POST /api/v1/agent/heartbeat, and the live status the dashboard reads off it. - heatmap
- The month as a shape:
GET /api/v1/team/heatmap. - import
- Importing an agent’s local history.
- ingest
- The upload endpoints:
POST /api/v1/daysand/days/batch. - login
- The login endpoints and the extractor that guards everything behind them.
- me
- What a person can read about themselves:
GET /api/v1/me/days. - model
- The domain the server stores: the shapes behind
migrations/. - privacy
- The privacy manifest: what this installation stores about a person, and the setting that decides it.
- provision
- Getting the first agents onto a server that has no admin UI yet.
- session
- Passwords and browser sessions.
- signals
- What the dashboard should point at:
GET /api/v1/team/signalsand the weekly trend behindGET /api/v1/users/{id}/trend. - team
- What a manager may read about other people:
GET /api/v1/team/daysandGET /api/v1/users/{id}/days. - web
- Serving the web UI.
- webhooks
- Webhooks: the server says what it noticed to where a manager already is.
Functions§
- migrator
- The embedded migrations, applied on startup and by the tests.