Deploy BostonIvy
BostonIvy (爬山虎) is open-source task management you host yourself. Agents draft your tasks and project plans; people review them, change them and stay in charge. These guides take you from an empty machine to a running server.
What you deploy
One deployment has three parts:
| Part | What it does |
|---|---|
| PostgreSQL | Stores everything: accounts, projects, tasks, comments |
| BostonIvy server | The API and the background jobs, in one process. It migrates the database by itself when it starts |
| BostonIvy Web | The web app. Its built-in Caddy serves the pages and forwards /api, /mcp, /llms.txt, the OAuth endpoints and the health checks to the server, so browsers only need one address |
Choose how to deploy
| Way | Good for | Guide |
|---|---|---|
| Docker Compose | One machine: trying it out, a family, a small team | Deploy with Docker Compose |
| Kubernetes with Helm | A cluster, several replicas, a managed database | Deploy on Kubernetes with Helm |
What you need
- A machine with Docker and Docker Compose v2, or a Kubernetes cluster with Helm.
- A GitHub account that can read the BostonIvy packages. The images are private packages on GitHub Container Registry (
ghcr.io). - For real use: a domain name pointing at the machine, so that BostonIvy can be served over HTTPS.
More guides on the way
Signing in with an OpenID Connect provider, calendars over CalDAV, mail, and connecting the Web, macOS and Android apps will each get their own guide here.