Docbank documentation¶
Docbank keeps documents in a vault on your own machine. The vault holds the stored files, every saved version, and the catalog that records where each document lives.
If you are new, start with setup and then the ten-minute quickstart. For an overview of the product, see docbank.ai or the visual tour.
What do you want to do?¶
| Task | Start here |
|---|---|
| Install Docbank or build it from source | Setup |
| Import a folder of documents | Importing documents |
| Move, rename, or tag documents | Organizing and tagging |
| Find documents by name, text, or filters | Searching |
| Search by meaning | Processing search |
| Extract a document's text and read it | Document processing |
| Read email and follow attachments | Web email reader |
| Browse photos and organize albums | Photos |
| Export documents as a verified ZIP | Export bundles |
| Import review packages or stamp PDF pages | Web package import · Bates export |
| Export search counts for a date range, with evidence | Search exports |
| Work in a browser or terminal | Web application · Terminal browser |
| Restore a deleted document or reclaim space | Trash, garbage collection, and repack |
| Create and test a backup | Backup and restore |
| Keep a permanent record of changes | Audited history |
| Add storage or move stored content | Multi-store storage |
| Maintain or upgrade a vault | Vault lifecycle |
| Diagnose a failure | Troubleshooting |
Build an integration¶
- Docbank for agents helps you choose an interface.
- MCP setup connects a local agent to the daemon.
- Agent integration covers authentication, verified transfers, and conflicting edits.
- Embed in Go shows how an application can own its own vault.
- Document understanding in Go covers the packages for text preparation, optical character recognition (OCR), and embeddings.
- Document processing explains how the vault stores processing results and which workers the daemon runs.
Look up a command, endpoint, or setting¶
Use the CLI reference for commands and flags, the HTTP API reference for requests and errors, and configuration for settings.
How Docbank works introduces the storage model and links to the architecture pages that define it.
Check capabilities and releases¶
The capability guide lists what Docbank does today. The roadmap lists what is planned. The changelog records each published release.
Docbank is alpha software. Keep your own copies of anything irreplaceable, and verify a backup before you rely on it.
Docbank is licensed under the Apache License, Version 2.0.