Kazier Documentation
Kazier Documentation
Section titled “Kazier Documentation”Welcome to the Kazier documentation.
Kazier is a local-first Android file manager. It mirrors your device’s Storage Access Framework (SAF) into a local Room database, then pushes metadata only to your own backend — never your files.
Principles
Section titled “Principles”| Principle | Meaning |
|---|---|
| Local-First | Your data lives on your own hardware, not in a cloud that could disappear tomorrow. |
| Open Source | Software you can inspect, audit and self-host. No black boxes, no vendor lock-in. |
| Private by Design | Encryption and sovereignty are the defaults, not options. |
| Controlled sync | The server receives metadata only. Physical files stay on your device. |
How it works
Section titled “How it works”- The Android client walks your SAF folders and mirrors them into a local Room database.
- Mutations (create, move, delete) are recorded in a transactional outbox alongside the local change.
- A WorkManager worker drains the outbox to
POST /sync/opson your backend. - Your backend (Go + PostgreSQL) applies the operations sequentially and stores metadata.
Architecture
Section titled “Architecture”┌─────────────────────────────┐ outbox sync ┌────────────────────────────┐│ Android (Kotlin + Compose) │ ───────────────────▶ │ Backend (Go + Gin) ││ · Room database │ metadata only │ · PostgreSQL 17 ││ · SAF file access │ │ · PASETO auth ││ · WorkManager outbox │ │ · OCR (Tesseract) │└─────────────────────────────┘ └────────────────────────────┘Getting started
Section titled “Getting started”- Quick Start — run the backend and Android app locally.
- Docker Setup — run PostgreSQL with Docker Compose.
- Environment Variables — full reference of server configuration.
- API Reference — the authoritative V1 API contract.
- Android app on Google Play (coming soon with the alpha release)
- Source code
- Landing page: Kazier