# Jiandu

> Jiandu is an evolving, source-built, self-hosted document manager for one household. It preserves originals and keeps storage, access, and recovery under the operator’s control.

Use the canonical HTML pages for people and the Markdown alternatives below for text-oriented tools. Current boundaries: one Jiandu process per installation; no published release package or project license; API-only access administration; SQLite or PostgreSQL 17/18 without cross-backend conversion.

## Start here

- [Jiandu self-hosted document management documentation](https://jiandu.org/docs.md): Install, evaluate, operate, secure, and troubleshoot a private Jiandu document library.
- [Quickstart](https://jiandu.org/docs/installation/quickstart.md): Build Jiandu, open the local HTTPS site, and verify your first document.
- [Choosing self-hosted document management](https://jiandu.org/docs/why-jiandu/self-hosted-document-management.md): Evaluate Jiandu and other self-hosted document management tools using recovery, privacy, workflow, and operating criteria.

## Understand Jiandu

- [How Jiandu works](https://jiandu.org/docs/concepts/overview.md): Learn the mental model behind originals, document records, processing, search, and recovery.
- [Security and trust model](https://jiandu.org/docs/concepts/security-model.md): Understand Jiandu's local defaults, trust boundaries, credentials, and shared-library access model.
- [Scope and readiness](https://jiandu.org/docs/why-jiandu/scope-and-readiness.md): Check current product boundaries before relying on Jiandu.

## Use Jiandu

- [Add, organize, and find a document](https://jiandu.org/docs/guides/document-workflow.md): Build a repeatable Jiandu workflow from durable intake through search and original download.
- [Search, archive, and recover documents](https://jiandu.org/docs/guides/search-and-lifecycle.md): Find Jiandu records, organize several at once, and use archive, bin, restore, and permanent deletion safely.
- [Use Smart filing](https://jiandu.org/docs/guides/smart-filing.md): Review, accept, pause, audit, and undo Jiandu filing suggestions without surrendering manual control.
- [Native API quickstart](https://jiandu.org/docs/guides/native-api-quickstart.md): Create a scoped Jiandu token, make an authenticated request, paginate safely, upload with TUS, and handle concurrency and errors.

## Operate and recover

- [Backup and restore](https://jiandu.org/docs/administration/backup-and-restore.md): Create, verify, restore, and drill a complete Jiandu recovery backup without risking the live installation.
- [Deployment checklist](https://jiandu.org/docs/best-practice/deployment-checklist.md): Move from local evaluation to a household deployment in safe stages.
- [Support and evidence matrix](https://jiandu.org/docs/references/support-matrix.md): Check Jiandu's current deployment, storage, identity, integration, and release-evidence boundaries.
- [Complete configuration reference](https://jiandu.org/docs/references/configuration-options.md): Look up every Jiandu JSON setting, default, override, bound, and restart or secret requirement.

## Reference

- [Health and HTTP API](https://jiandu.org/docs/references/api.md): Find stable health probes and the complete native OpenAPI contract.
- [Native API problem codes](https://jiandu.org/docs/references/problem-codes.md): Interpret Jiandu RFC 9457 problem codes, retry guidance, and safe client actions by API family.
- [Environment variables](https://jiandu.org/docs/references/environment.md): Look up Jiandu overrides and the bounded standard OpenTelemetry environment surface.
- [Error messages](https://jiandu.org/docs/references/errors.md): Search exact Jiandu errors and take the safest next step.
- [Glossary](https://jiandu.org/docs/references/glossary.md): Look up Jiandu terms for documents, processing, access, storage, and operations.
- [Frequently asked questions](https://jiandu.org/docs/references/faq.md): Get direct answers about Jiandu hosting, privacy, storage, OCR, Paperless migration, backups, and readiness.

## Machine-readable contracts

- [OpenAPI 3.1 contract](https://jiandu.org/openapi/native-v1.json): Native HTTP API generated from Jiandu handlers.
- [Configuration JSON Schema](https://jiandu.org/schemas/config-v1.json): Closed configuration contract with defaults, bounds, overrides, and secret markers.
- [Complete documentation corpus](https://jiandu.org/llms-full.txt): Concatenated hand-authored documentation; generated API operations remain in OpenAPI.