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.

docs: add Coolify deployment instructions and Docker Compose file

Mortezad59db25f89bb
diff --git a/README.md b/README.md
index 861ae72d1..8f0b8067b 100644
--- a/README.md
+++ b/README.md
@@ -110,6 +110,10 @@ If you run the API on your host instead of inside Compose, use `localhost` or se
> **Important:** See our [full documentation](https://kaneo.app/docs/core) for detailed setup instructions, environment variable configuration, and troubleshooting guides.
+### Deploy on Coolify
+
+Kaneo ships a [Coolify-optimized `docker-compose.yml`](docker-compose.yml). In Coolify, create a **Public Repository** resource pointing to `https://github.com/usekaneo/kaneo`, pick the **Docker Compose** build pack (Base Directory `/`, Compose Location `docker-compose.yml`), assign a domain to the `kaneo` service as `https://your-domain.com:5173`, set `KANEO_CLIENT_URL`, and deploy. `AUTH_SECRET` and the database password are auto-generated by Coolify. See the [Coolify deployment guide](https://kaneo.app/docs/core/deployments/coolify) for details.
+
### Development Setup
For development, see our [Environment Setup Guide](ENVIRONMENT_SETUP.md) for detailed instructions on configuring environment variables and troubleshooting common issues like CORS problems.
diff --git a/apps/docs/core/deployments/coolify.mdx b/apps/docs/core/deployments/coolify.mdx
new file mode 100644
index 000000000..7d08fb236
--- /dev/null
+++ b/apps/docs/core/deployments/coolify.mdx
@@ -0,0 +1,42 @@
+---
+title: Coolify
+description: Deploy Kaneo to Coolify using the bundled Docker Compose file.
+---
+
+## Coolify
+
+Kaneo ships a [Coolify-optimized Docker Compose file](https://github.com/usekaneo/kaneo/blob/main/docker-compose.yml) so you can deploy the pre-built `ghcr.io/usekaneo/kaneo` image from the repository without building anything.
+
+## Deployment Steps
+
+1. **Create a new resource**: In your Coolify project, click **+ New** and choose **Public Repository**.
+2. **Enter the repository**: `https://github.com/usekaneo/kaneo` and click **Check Repository**.
+3. **Select the build pack**: Set **Build Pack** to `Docker Compose`.
+ - **Base Directory**: `/`
+ - **Docker Compose Location**: `docker-compose.yml`
+4. **Assign a domain to the `kaneo` service**: the container listens on port `5173`, so enter `https://<your-domain>:5173`. The port only tells Coolify where to route traffic inside the container — visitors use the normal HTTPS URL (`https://<your-domain>`) without the port.
+5. **Set environment variables** (pre-filled from the compose file):
+ - `KANEO_CLIENT_URL` (required): your public URL, e.g. `https://kaneo.example.com` (no `:5173`).
+ - `AUTH_SECRET` (auto-generated 64-character hex, editable).
+ - PostgreSQL password (auto-generated, shared with both services).
+6. **Deploy**.
+
+## What the Compose File Sets Up
+
+- **PostgreSQL 16** with a persistent volume; Kaneo waits for its health check before starting.
+- **Kaneo bundled image** (nginx + API in one container) on port `5173`.
+- **`KANEO_API_URL` is derived automatically** from `KANEO_CLIENT_URL` by the container entrypoint — no extra API URL configuration needed.
+- **No host port mappings or custom networks**: Coolify's proxy handles all external traffic.
+
+## Post-Deployment Setup
+
+1. **Create your first user**: visit your domain to create the admin account.
+2. **Email (optional)**: set the `SMTP_*` variables on the `kaneo` service in the Coolify UI.
+3. **SSO (optional)**: configure GitHub, Google, or other providers — see the [social providers](/core/social-providers/github) guides.
+
+## Troubleshooting
+
+- **"No Available Server"**: check the container health check with `docker ps`; the image needs up to 60 seconds to start.
+- **Verify environment**: ensure `KANEO_CLIENT_URL` is set to the exact public URL of your instance.
+
+For other issues, see the [troubleshooting section](/core/installation/start-services).
diff --git a/apps/docs/docs.json b/apps/docs/docs.json
index 55de06e50..aeeb365d3 100644
--- a/apps/docs/docs.json
+++ b/apps/docs/docs.json
@@ -108,7 +108,11 @@
},
{
"group": "Deployment & Operations",
- "pages": ["core/reverse-proxy/nginx", "core/deployments/railway"]
+ "pages": [
+ "core/reverse-proxy/nginx",
+ "core/deployments/railway",
+ "core/deployments/coolify"
+ ]
},
{
"group": "Migration",
diff --git a/docker-compose.yml b/docker-compose.yml
new file mode 100644
index 000000000..4dcad1440
--- /dev/null
+++ b/docker-compose.yml
@@ -0,0 +1,54 @@
+# Kaneo on Coolify
+#
+# Deploy this stack from a Git source with Coolify's "Docker Compose" build pack:
+# Public Repository -> https://github.com/usekaneo/kaneo
+# Build Pack: Docker Compose | Base Directory: / | Compose Location: docker-compose.yml
+#
+# Assign a domain to the "kaneo" service using its container port, e.g. https://kaneo.example.com:5173
+# (visitors use the normal HTTPS URL; the port only tells Coolify where to route traffic).
+#
+# The only required environment variable is KANEO_CLIENT_URL (your public URL, without :5173).
+# AUTH_SECRET and the PostgreSQL password are auto-generated via Coolify magic variables.
+
+services:
+ postgres:
+ image: postgres:16-alpine
+ environment:
+ - POSTGRES_DB=kaneo
+ - POSTGRES_USER=kaneo
+ - POSTGRES_PASSWORD=${SERVICE_PASSWORD_POSTGRES:?}
+ volumes:
+ - postgres_data:/var/lib/postgresql/data
+ restart: unless-stopped
+ healthcheck:
+ test: ["CMD-SHELL", "pg_isready -U kaneo -d kaneo"]
+ interval: 10s
+ timeout: 5s
+ retries: 5
+
+ kaneo:
+ image: ghcr.io/usekaneo/kaneo:latest
+ environment:
+ - KANEO_CLIENT_URL=${KANEO_CLIENT_URL:?}
+ - AUTH_SECRET=${SERVICE_HEX_64_KANEO:?}
+ # The image derives DATABASE_URL from these POSTGRES_* variables at startup.
+ # POSTGRES_PASSWORD is the same generated value shared with the postgres service.
+ - POSTGRES_HOST=postgres
+ - POSTGRES_DB=kaneo
+ - POSTGRES_USER=kaneo
+ - POSTGRES_PASSWORD=${SERVICE_PASSWORD_POSTGRES}
+ # Optional: SMTP_*, SSO providers, GitHub integration, Sentry, Redis...
+ # add them here or in the Coolify UI for the kaneo service.
+ depends_on:
+ postgres:
+ condition: service_healthy
+ restart: unless-stopped
+ healthcheck:
+ test: ["CMD", "wget", "--no-verbose", "--tries=1", "--spider", "http://127.0.0.1:5173/api/health"]
+ interval: 30s
+ timeout: 5s
+ start_period: 60s
+ retries: 3
+
+volumes:
+ postgres_data: