Scope and readiness
Jiandu is being built as a household-first document manager. Treat the current repository as evolving software, not as a finished replacement for every document workflow.
Supported direction
- One Jiandu application process owns an installation.
- SQLite is the simple default; PostgreSQL 17.x and 18.x are the supported external database family.
- Files can live on local disk, S3 or S3-compatible storage, or WebDAV services such as ownCloud and Nextcloud.
- The browser covers everyday document work plus watched-folder, scanner, capture-agent, and permission-gated Paperless migration workflows. The native API supplies roles, groups, local-account administration, personal access tokens, per-document grants, the same capture operations, and Gmail connector administration; backup and portable export are operator CLI tools.
Important boundaries
- Do not run two Jiandu processes against the same installation.
- Scanned-text recognition is not currently an advertised product guarantee. Keep the original and expect to correct searchable metadata when needed.
- SAML and managed identity provisioning are not current sign-in options.
- Remote OCR is not supported by the local profile.
- Plugins are an expert feature, disabled by default, and run with reduced—not perfect—isolation when enabled.
- There is currently no project license. Default copyright applies to the source repository until that changes.
Before trusting important documents
Use non-critical sample documents first. Verify sign-in, search, original download, a stopped-writer portable export, backup, and restore on the exact storage and database combination you plan to use. Keep an independent copy of irreplaceable originals.
The deployment checklist turns this into a step-by-step readiness review.