Skip to main content

ScannerSky Documentation

ScannerSky is a Django-based attendance and access control platform.

The docs are organized by user journey:

  • Getting Started: local setup and first run
  • Architecture: system design and server internals
  • Scanning Nodes: Windows, Raspberry Pi, and ESP32 node guidance
  • Deployment and Operations: production setup, CI/CD, and runbook tasks
  • Reference: API, schema, admin, command reference, and MCP server

Start Here

Common Tasks

  • Bring up a local dev environment and validate endpoints
  • Understand scan flow from node to server record creation
  • Deploy to Ubuntu with Nginx and Gunicorn
  • Operate backups, restores, and incident troubleshooting