Jiandu documentation
Install a private document library, find your household's records, or build an integration. Start with the task you need to complete, then use the reference pages for exact settings and API fields.
Start here
| Your goal | Start with | First result |
|---|---|---|
| Evaluate or install Jiandu | Docker Compose quickstart | A running installation and one verified sample |
| Use an existing household library | Join your household's Jiandu | Your own sign-in and a document you can open |
| Connect an automation client | Native API quickstart | An authenticated request with a scoped token |
| Move from Paperless-ngx | Migration guide | A checked sample import with exceptions reconciled |
Jiandu is evolving software, publishes source-built deployments, and does not yet have a project license. Evaluate with non-critical samples and read scope and readiness before relying on it for important records.
The source repository is not anonymously accessible at the time of writing. A 404 from the clone
URL means this source-built evaluation path is unavailable; Jiandu currently has no public package
fallback.
Work with documents
- Add, organize, and find a document — preserve an original, correct its filing details, and retrieve it without remembering the filename.
- Search, archive, and recover documents — narrow results, make bulk edits, and understand Archive, Bin, and Restore.
- Save a search with quick filters — return to personal views such as utility bills or records that need filing.
- Follow activity and notifications — review failures and completions, then choose which browser alerts you want.
- Use Smart filing — review proposed rules and understand how to undo them.
- Restrict a sensitive document — grant access and verify it with two accounts.
See Using Jiandu for a suggested learning order and checks for each task.
Set up and operate the household
| Task | Guide |
|---|---|
| Choose an installation method | Installation |
| Set up HTTPS, storage, a database, or sign-in | Configuration |
| Create accounts or invitations | People and access |
| Add a watched folder, scanner, or Gmail connector | Capture and email |
| Back up and rehearse recovery | Backup and restore |
| Check readiness before wider use | Deployment checklist |
| Investigate a failed operation | Troubleshooting and error messages |
Jiandu runs one process per installation. A complete backup protects the database and every referenced blob together. Read how Jiandu works for the relationship between originals, filing data, processing, search, and access; use the support matrix to check your intended combination before adding integrations.
Build and look up details
- API: Integration overview, operation reference, and problem codes.
- Configuration: All options, environment variables, and commands.
- Development: Local environment, plugins, and writing documentation.
- Evaluation: Why Jiandu, choosing a document manager, and frequently asked questions.
Choose the matching documentation version
The Latest (main) docs describe the current main branch. A major release tag publishes a durable N.x snapshot, which remains selectable from the version menu after main moves on.
Use the version selector before copying a setting or API example into an older installation. Generated API pages and release-pinned JSON contracts are authoritative for their matching version.
For text-oriented tools, use the Latest documentation index. Its Markdown pages describe Latest (main); use the versioned HTML and matching JSON contracts for an older installation. To propose a correction, authorized repository members can follow Writing documentation.