Skip to content

armgit / kaneo

Public Imported from GitHub
0

⚡ Project management that doesn't become the project. Boards, Gantt charts, and GitHub integration. Self-host it or use Kaneo Cloud.

2.4 KB
Raw Blame
---
title: "Self-host Kaneo"
description: "Choose a deployment method and know what you need to run it."
---

Kaneo runs as one application container plus PostgreSQL. You can add file storage and email when you need them. Redis is only needed when multiple API instances must share live updates.

## Choose your setup

| Setup | Choose this when… |
| --- | --- |
| [Docker Compose](/core/installation/docker-compose) | You want to see and control the configuration. Start here for a local trial or an existing server. |
| [drim](/core/installation/drim) | You want a CLI to generate the deployment and set up Caddy for HTTPS. |
| [Coolify](/core/deployments/coolify) | You already deploy applications through Coolify. |
| [Railway](/core/deployments/railway) | You want a hosted deployment without managing a server. |
| [Helm](https://github.com/usekaneo/kaneo/tree/main/charts/kaneo) | You already operate a Kubernetes cluster. |

<Tip>
  Rather not run it yourself? We host [managed instances](https://kaneo.app/pricing#managed-instance) in the EU with your own domain, single sign-on, daily backups, and upgrades handled for you, from $299 a month for the whole instance. For a small team, [Kaneo Cloud](https://kaneo.app/pricing) starts at $4 a month.
</Tip>

For a small installation, plan for at least 2 GB of memory and 10 GB of free disk as a starting point. Leave additional space for database growth, uploaded files, and backups. Compose deployments need Docker and Docker Compose V2.

## What runs where

```mermaid
flowchart LR
  Browser[Your browser] -->|HTTPS| Proxy[Reverse proxy]
  Proxy --> Kaneo[Kaneo: web app and API]
  Kaneo --> DB[(PostgreSQL)]
  Browser -->|File uploads| Storage[(Optional S3 storage)]
  Kaneo -->|Read and validate files| Storage
```

PostgreSQL stores accounts, projects, tasks, comments, and upload records. File contents live in your configured object storage. Account avatars are stored in PostgreSQL.

## Before inviting your team

1. Put the instance behind [HTTPS](/core/reverse-proxy/nginx).
2. Create the initial administrator account before opening registration to others.
3. Configure [email and access settings](/core/installation/environment-variables).
4. Add [Silo file storage](/core/installation/silo) if your team needs attachments.
5. Make a [backup and test a restore](/core/operations/backups).

Then follow [Your first project](/core/index). Your team can also connect the [mobile app](/core/functional/mobile-app) to this instance.