kaneo (minimalist kanban) fork to experiment adding a tangled integration
github.com/usekaneo/kaneo
docs: add drim CLI tool for one-click deployment and enhance installation instructions
+204
-19
+13
README.md
+13
README.md
···
52
52
53
53
## Getting Started
54
54
55
+
### One-Click Deployment with drim
56
+
57
+
For straightforward deployments, use [drim](https://github.com/usekaneo/drim) - a CLI tool that handles everything for you:
58
+
59
+
```bash
60
+
curl -fsSL https://assets.kaneo.app/install.sh | sh
61
+
drim setup
62
+
```
63
+
64
+
That's it. Your Kaneo instance will be running with automatic HTTPS, database setup, and all services configured.
65
+
66
+
Perfect for quick deployments and production setups where you want things to just work.
67
+
55
68
### Quick Start with Docker Compose
56
69
57
70
The fastest way to try Kaneo is with Docker Compose. This sets up the API, web interface, and PostgreSQL database:
-1
apps/docs/content/docs/api/index.mdx
-1
apps/docs/content/docs/api/index.mdx
+2
-15
apps/docs/content/docs/api/meta.json
+2
-15
apps/docs/content/docs/api/meta.json
···
1
1
{
2
-
"title": "API",
3
-
"description": "The API for Kaneo",
4
-
"pages": [
5
-
"authentication",
6
-
"getConfig",
7
-
"globalSearch",
8
-
"tasks",
9
-
"projects",
10
-
"labels",
11
-
"activities",
12
-
"comments",
13
-
"time-entries",
14
-
"notifications",
15
-
"github-integration"
16
-
]
2
+
"title": "API Reference",
3
+
"root": true
17
4
}
+13
-2
apps/docs/content/docs/core/index.mdx
+13
-2
apps/docs/content/docs/core/index.mdx
···
18
18
19
19
### Installation
20
20
21
-
The installation process is straightforward, we have a Docker Compose file that will start the required services.
21
+
We offer two ways to install Kaneo:
22
+
23
+
**Quick Setup with drim (Recommended)**
24
+
25
+
For straightforward deployments, use [drim](/docs/core/installation/drim) - a CLI tool that handles everything automatically:
26
+
27
+
```bash
28
+
curl -fsSL https://assets.kaneo.app/install.sh | sh
29
+
drim setup
30
+
```
31
+
32
+
**Manual Setup with Docker Compose**
22
33
23
-
It is part of a three part installation process.
34
+
For more control or complex setups, follow the manual installation process:
24
35
25
36
- [Setting up the Docker compose file](/docs/core/installation/docker-compose)
26
37
- [Setting up the environment variables](/docs/core/installation/environment-variables)
+10
apps/docs/content/docs/core/installation/docker-compose.mdx
+10
apps/docs/content/docs/core/installation/docker-compose.mdx
···
18
18
volumes:
19
19
- postgres_data:/var/lib/postgresql/data
20
20
restart: unless-stopped
21
+
healthcheck:
22
+
test: ["CMD-SHELL", "pg_isready -U kaneo -d kaneo"]
23
+
interval: 10s
24
+
timeout: 5s
25
+
retries: 5
21
26
22
27
api:
23
28
image: ghcr.io/usekaneo/api:latest
···
25
30
- "1337:1337"
26
31
env_file:
27
32
- .env
33
+
depends_on:
34
+
postgres:
35
+
condition: service_healthy
28
36
restart: unless-stopped
29
37
30
38
web:
···
33
41
- "5173:5173"
34
42
env_file:
35
43
- .env
44
+
depends_on:
45
+
- api
36
46
restart: unless-stopped
37
47
38
48
volumes:
+113
apps/docs/content/docs/core/installation/drim.mdx
+113
apps/docs/content/docs/core/installation/drim.mdx
···
1
+
---
2
+
title: Deploy with drim CLI
3
+
description: One-click deployment tool for self-hosted Kaneo instances
4
+
---
5
+
6
+
## What is drim?
7
+
8
+
[drim](https://github.com/usekaneo/drim) is a CLI tool for deploying your Kaneo instances. It's designed for fairly straightforward setups where you want to get Kaneo up and running quickly without manual configuration.
9
+
10
+
drim handles:
11
+
- Docker Compose file generation
12
+
- Environment variable setup
13
+
- Automatic HTTPS with Caddy
14
+
- Service management (start, stop, restart)
15
+
- Updates and upgrades
16
+
17
+
## Installation
18
+
19
+
Install drim with a single command:
20
+
21
+
```bash
22
+
curl -fsSL https://assets.kaneo.app/install.sh | sh
23
+
```
24
+
25
+
Or download the binary manually from [releases](https://github.com/usekaneo/drim/releases/latest).
26
+
27
+
## Quick Start
28
+
29
+
### Local Development
30
+
31
+
For local development without a domain:
32
+
33
+
```bash
34
+
drim setup
35
+
# Press Enter when prompted for domain
36
+
# Access at http://localhost
37
+
```
38
+
39
+
### Production Deployment
40
+
41
+
For production with automatic HTTPS:
42
+
43
+
```bash
44
+
drim setup
45
+
# Enter your domain when prompted (e.g., kaneo.example.com)
46
+
# Access at https://your-domain.com
47
+
```
48
+
49
+
<Callout type="info">
50
+
Make sure your domain's DNS A record points to your server before running setup.
51
+
</Callout>
52
+
53
+
## Commands
54
+
55
+
drim provides several commands to manage your Kaneo instance:
56
+
57
+
```bash
58
+
drim setup # Deploy Kaneo
59
+
drim start # Start services
60
+
drim stop # Stop services
61
+
drim restart # Restart services
62
+
drim upgrade # Update Kaneo to latest version
63
+
drim update # Update drim CLI to latest version
64
+
drim configure # Edit configuration
65
+
drim uninstall # Remove Kaneo
66
+
```
67
+
68
+
## What Gets Installed
69
+
70
+
When you run `drim setup`, the following services are deployed:
71
+
72
+
- **PostgreSQL 16** - Database
73
+
- **Kaneo API** - Backend service
74
+
- **Kaneo Web** - Frontend interface
75
+
- **Caddy** - Reverse proxy with automatic HTTPS
76
+
77
+
All services run in Docker containers with proper networking and health checks.
78
+
79
+
## Configuration
80
+
81
+
To edit environment variables after setup:
82
+
83
+
```bash
84
+
drim configure
85
+
```
86
+
87
+
This opens `.env` in your default editor. After saving, services are restarted automatically.
88
+
89
+
See the [environment variables documentation](/docs/core/installation/environment-variables) for available options.
90
+
91
+
## Requirements
92
+
93
+
- Docker 20.10+
94
+
- Docker Compose V2
95
+
- 2GB RAM minimum
96
+
- 10GB disk space
97
+
98
+
**Supported Platforms:** Linux, macOS, Windows (WSL)
99
+
100
+
<Callout type="info">
101
+
drim will attempt to install Docker automatically on supported Linux distributions.
102
+
</Callout>
103
+
104
+
## When to Use drim
105
+
106
+
drim is ideal for:
107
+
108
+
- Quick local development setups
109
+
- Simple production deployments with a single domain
110
+
- Teams that want automatic HTTPS without manual configuration
111
+
- Anyone who wants to get Kaneo running with minimal effort
112
+
113
+
For more complex setups (multiple domains, custom networking, Kubernetes, etc.), see the [manual Docker Compose installation](/docs/core/installation/docker-compose).
+51
apps/docs/content/docs/core/installation/index.mdx
+51
apps/docs/content/docs/core/installation/index.mdx
···
1
+
---
2
+
title: Installation Overview
3
+
description: Choose how to install Kaneo - quick setup with drim or manual Docker Compose
4
+
---
5
+
6
+
## Choose Your Installation Method
7
+
8
+
Kaneo offers two installation methods depending on your needs:
9
+
10
+
### Quick Setup with drim (Recommended)
11
+
12
+
[drim](/docs/core/installation/drim) is a CLI tool designed for straightforward Kaneo deployments. It's perfect for:
13
+
14
+
- Getting started quickly with minimal configuration
15
+
- Local development environments
16
+
- Simple production deployments with a single domain
17
+
- Automatic HTTPS setup
18
+
19
+
```bash
20
+
curl -fsSL https://assets.kaneo.app/install.sh | sh
21
+
drim setup
22
+
```
23
+
24
+
### Manual Setup with Docker Compose
25
+
26
+
For more control over your deployment or complex setups, use the manual installation process:
27
+
28
+
1. [Create the Docker Compose file](/docs/core/installation/docker-compose)
29
+
2. [Configure environment variables](/docs/core/installation/environment-variables)
30
+
3. [Start the services](/docs/core/installation/start-services)
31
+
32
+
This method is ideal for:
33
+
- Custom networking configurations
34
+
- Multiple domains or complex reverse proxy setups
35
+
- Integration with existing infrastructure
36
+
- Advanced customization needs
37
+
38
+
## Requirements
39
+
40
+
Both methods require:
41
+
42
+
- Docker 20.10+
43
+
- Docker Compose V2
44
+
- 2GB RAM minimum
45
+
- 10GB disk space
46
+
47
+
**Supported Platforms:** Linux, macOS, Windows (WSL)
48
+
49
+
## Next Steps
50
+
51
+
Choose your preferred method and follow the corresponding guide to get Kaneo up and running.
+1
apps/docs/content/docs/core/installation/meta.json
+1
apps/docs/content/docs/core/installation/meta.json
+1
-1
apps/docs/next-env.d.ts
+1
-1
apps/docs/next-env.d.ts
···
1
1
/// <reference types="next" />
2
2
/// <reference types="next/image-types/global" />
3
-
import "./.next/dev/types/routes.d.ts";
3
+
import "./.next/types/routes.d.ts";
4
4
5
5
// NOTE: This file should not be edited
6
6
// see https://nextjs.org/docs/app/api-reference/config/typescript for more information.