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(readme): highlight cloud and current features (#1831)

Tin Sever4bf7f8d13173
diff --git a/README.md b/README.md
index b716ce434..3104c2cb5 100644
--- a/README.md
+++ b/README.md
@@ -15,36 +15,43 @@
<div align="center">
<h3>
- <a href="https://kaneo.app/docs/core">Quick Start</a>
+ <a href="https://cloud.kaneo.app">Cloud</a>
<span> | </span>
- <a href="https://kaneo.app">Website</a>
+ <a href="https://kaneo.app/docs/core/installation">Installation</a>
<span> | </span>
- <a href="https://cloud.kaneo.app">Cloud</a>
+ <a href="https://kaneo.app">Website</a>
<span> | </span>
<a href="https://discord.gg/rU4tSyhXXU">Discord</a>
</h3>
</div>
+<p align="center">
+ Fast, simple, open-source project management.
+</p>
<p align="center">
- <img src="https://assets.kaneo.app/readme.png" alt="Kaneo Dashboard" />
+ <img src="screenshots/[email protected]" srcset="screenshots/[email protected] 1x, screenshots/readme.png 2x" alt="Kaneo project board with the Kaneo logo and tagline" />
</p>
-## Why Kaneo?
+## Built for your team's work
-After years of using bloated, overcomplicated project management platforms that distracted from actual work, we built Kaneo to be different.
+- **See work your way:** Board, List, Calendar, and Gantt views, plus a backlog, filters, and search.
+- **Keep task context together:** descriptions, attachments, subtasks, dependencies, labels, comments, and time tracking.
+- **Work with your team:** shared workspaces, invitations, custom roles, live updates, and public project views.
+- **Shape your workflow:** custom columns and fields, with rules that move tasks when repository activity changes.
+- **Stay informed:** in-app notifications, email, ntfy, Gotify, and personal webhooks.
+- **Connect other tools:** GitHub and Gitea, chat integrations, project webhooks, a [REST API](https://kaneo.app/docs/api-reference/introduction), and [MCP](https://kaneo.app/docs/core/integrations/mcp) for AI assistants.
-The problem with most tools isn't that they lack features, it's that they have **too many**. Every notification, every unnecessary button, every complex workflow pulls your team away from what matters: **building great products**.
+## Installation
-We believe the best tools are **invisible**. They should amplify your team's natural workflow, not force you to adapt to theirs. Kaneo is built on the principle that **less is more**: every feature exists because it solves a real problem, not because it looks impressive in a demo.
+- **Cloud:** [Get started with Kaneo Cloud](https://cloud.kaneo.app).
+- **Self-hosted:** Follow the [installation guide](https://kaneo.app/docs/core/installation).
-**What makes it different:**
-- **Clean interface** that focuses on your work, not the tool
-- **Self-hosted** so your data stays yours
-- **Actually fast** because we care about performance
-- **Open source** with a permissive MIT license
+## Contributing
+
+Code, translations, documentation, and bug reports are welcome. Start with the [contributing guide](CONTRIBUTING.md) and [local development setup](ENVIRONMENT_SETUP.md).
-Learn more about Kaneo's features and capabilities in our [documentation](https://kaneo.app/docs/core).
+Join us on [Discord](https://discord.gg/rU4tSyhXXU) or share bugs and feature requests in [GitHub Issues](https://github.com/usekaneo/kaneo/issues).
## Sponsors
@@ -62,124 +69,6 @@ This project is tested with BrowserStack.
<!-- sponsors --><a href="https://github.com/danielsada"><img src="https:&#x2F;&#x2F;github.com&#x2F;danielsada.png" width="60px" alt="User avatar: Daniel Sada" /></a><a href="https://github.com/randoneering"><img src="https:&#x2F;&#x2F;github.com&#x2F;randoneering.png" width="60px" alt="User avatar: (justin)randoneering" /></a><a href="https://github.com/floreabogdan"><img src="https:&#x2F;&#x2F;github.com&#x2F;floreabogdan.png" width="60px" alt="User avatar: Bogdan FLOREA" /></a><a href="https://github.com/barbanet"><img src="https:&#x2F;&#x2F;github.com&#x2F;barbanet.png" width="60px" alt="User avatar: Damián Culotta" /></a><a href="https://github.com/t0yohei"><img src="https:&#x2F;&#x2F;github.com&#x2F;t0yohei.png" width="60px" alt="User avatar: t0yohei" /></a><a href="https://github.com/ryanilano"><img src="https:&#x2F;&#x2F;github.com&#x2F;ryanilano.png" width="60px" alt="User avatar: Ryan Ilano" /></a><!-- sponsors -->
-## Getting Started
-
-### Deployment with drim
-
-For straightforward deployments, use [drim](https://github.com/usekaneo/drim) - a CLI tool that handles everything for you:
-
-Install drim using the [version-pinned download and checksum verification](https://kaneo.app/docs/core/installation/drim#installation), then run:
-
-```bash
-drim setup
-```
-
-That's it. Your Kaneo instance will be running with automatic HTTPS, database setup, and all services configured.
-
-Perfect for quick deployments and production setups where you want things to just work.
-
-### Quick Start with Docker Compose
-
-The fastest way to try Kaneo is with Docker Compose. This sets up Kaneo and PostgreSQL with a single Kaneo container:
-
-```yaml
-services:
- postgres:
- image: postgres:16-alpine
- env_file:
- - .env
- environment:
- POSTGRES_USER: ${POSTGRES_USER:-kaneo}
- POSTGRES_DB: ${POSTGRES_DB:-kaneo}
- volumes:
- - postgres_data:/var/lib/postgresql/data
- restart: unless-stopped
- healthcheck:
- test: ["CMD-SHELL", 'pg_isready -U "$${POSTGRES_USER}" -d "$${POSTGRES_DB}"']
- interval: 10s
- timeout: 5s
- retries: 5
-
- kaneo:
- image: ghcr.io/usekaneo/kaneo:latest
- ports:
- - "5173:5173"
- env_file:
- - .env
- depends_on:
- postgres:
- condition: service_healthy
- restart: unless-stopped
-
-volumes:
- postgres_data:
-```
-
-Save this as `compose.yml`, copy `.env.sample` to `.env`, uncomment `KANEO_CLIENT_URL=http://localhost:5173`, and set `POSTGRES_PASSWORD=<password>` and `AUTH_SECRET=<output of openssl rand -hex 32>`, run `docker compose up -d`, and open [http://localhost:5173](http://localhost:5173).
-
-In Docker Compose, the bundled Kaneo container reaches PostgreSQL at the service hostname `postgres`.
-The database is reachable only inside the Compose network. If you run the API on your host, explicitly add a loopback-only database mapping (`127.0.0.1:5432:5432`) for development and configure `DATABASE_URL` accordingly.
-
-> **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 `compose.coolify.yml`](compose.coolify.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 `compose.coolify.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. Leave `KANEO_API_URL` unset (it is derived from `KANEO_CLIENT_URL`; a `localhost` value breaks the browser API calls). 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.
-
-### Configuration
-
-Kaneo requires several environment variables to be configured. The Docker Compose setup above handles the database automatically, but you'll need to configure environment variables for the API and web services.
-
-For complete configuration instructions, including all required environment variables, database setup for non-Docker deployments, and advanced settings, see the [documentation](https://kaneo.app/docs/core). Advanced deployments can still use the separate `ghcr.io/usekaneo/api` and `ghcr.io/usekaneo/web` images.
-
-## Kubernetes Deployment
-
-If you're running Kubernetes, we provide a comprehensive Helm chart. Check out the [Helm chart documentation](./charts/kaneo/README.md) for detailed installation instructions, production configuration examples, TLS setup, and more.
-
-## Development
-
-Want to hack on Kaneo? See our [Environment Setup Guide](ENVIRONMENT_SETUP.md) for detailed instructions on configuring environment variables and troubleshooting common issues like CORS problems.
-
-Quick start:
-```bash
-# Clone and install dependencies
-git clone https://github.com/usekaneo/kaneo.git
-cd kaneo
-pnpm install
-
-# Create a .env file in the root with required environment variables
-# See ENVIRONMENT_SETUP.md for detailed instructions
-
-# Start development servers
-pnpm dev
-```
-
-For contributing guidelines, code structure, and development best practices, check out our [contributing guide](CONTRIBUTING.md) and [documentation](https://kaneo.app/docs/core).
-
-## MCP Server
-
-Kaneo has an official [MCP (Model Context Protocol) server](https://kaneo.app/docs/core/integrations/mcp), so AI tools like Claude, Cursor, and other MCP clients can manage your tasks, projects, and labels. Every instance ships a built-in HTTP MCP endpoint at `/api/mcp`, and for stdio clients there is the official [@kaneo/mcp](https://www.npmjs.com/package/@kaneo/mcp) package on npm (`npx -y @kaneo/mcp`).
-
-## Community
-
-- **[Discord](https://discord.gg/rU4tSyhXXU)** - Chat with users and contributors
-- **[GitHub Issues](https://github.com/usekaneo/kaneo/issues)** - Bug reports and feature requests
-- **[Documentation](https://kaneo.app/docs/core)** - Detailed guides, API docs, and tutorials
-
-## Contributing
-
-We're always looking for help, whether that's:
-- Reporting bugs or suggesting features
-- Improving documentation
-- Contributing code
-- Helping other users on Discord
-
-Check out [CONTRIBUTING.md](CONTRIBUTING.md) for the details on how to get involved.
-
## License
MIT License - see [LICENSE](LICENSE) for details.
@@ -191,5 +80,5 @@ MIT License - see [LICENSE](LICENSE) for details.
</div>
<p align="center">
- Built with ❤️ by the Kaneo team and <a href="#contributors">contributors</a>
+ Built with ❤️ by the Kaneo team and <a href="https://github.com/usekaneo/kaneo/graphs/contributors">contributors</a>
</p>
diff --git a/screenshots/readme.png b/screenshots/readme.png
new file mode 100644
index 000000000..c114755fc
Binary files /dev/null and b/screenshots/readme.png differ
diff --git a/screenshots/[email protected] b/screenshots/[email protected]
new file mode 100644
index 000000000..0628fb00c
Binary files /dev/null and b/screenshots/[email protected] differ