Installation
Choose the route that matches how you already operate self-hosted software.
For a first evaluation, use the Quickstart. It follows the reviewed Docker Compose topology from a fresh checkout through one verified sample document, then shows how to stop without deleting the installation.
| Route | Good for | What you manage |
|---|---|---|
| Quickstart | First evaluation | Docker, port 443, and a non-sensitive sample document |
| Docker Compose | A reviewed single-host HTTPS topology | Docker, local DNS/name resolution, volumes, and backups |
| Run from source | Evaluation and contributors | Rust/Deno toolchains and local build dependencies |
| Kubernetes | Existing cluster operators | Ingress, secrets, persistent storage, and database lifecycle |
The repository currently documents source-built deployments. Do not invent a container image name or download URL: use the reviewed examples from the same revision you are installing.
After the process starts, continue to first run. For access from another device, do not expose the default HTTP listener directly; follow reverse proxy and HTTPS.
Before choosing a production shape
Confirm these boundaries first:
- one Jiandu process owns an installation;
- the repository currently publishes source-built deployments rather than release packages;
- SQLite is the default database and PostgreSQL 17.x or 18.x are the supported external families;
- local disk, S3-compatible storage, and WebDAV are the supported blob backends; and
- a working readiness probe does not replace an application-level restore test.
The support matrix is the current concise contract. The deployment checklist defines the evidence to collect before inviting other people or importing important records.