usekaneo / kaneo

Why Kaneo? After years of using bloated, overcomplicated project management platforms that distracted from actual work, we built Kaneo to be different. 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.

为什么选择 Kaneo？ 在多年使用臃肿、过度复杂的项目管理平台并因此分散了实际工作精力后，我们打造了与众不同的 Kaneo。大多数工具的问题不在于功能缺失，而在于功能过剩。每一条通知、每一个不必要的按钮、每一个复杂的工作流，都会让你的团队偏离核心目标：打造出色的产品。

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.

我们坚信最好的工具应该是“隐形”的。它们应该增强团队原有的工作流，而不是强迫团队去适应工具。Kaneo 的核心理念是“少即是多”——每一个功能的存在都是为了解决实际问题，而不是为了在演示中看起来炫酷。

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

它的独特之处：

简洁的界面，让你专注于工作而非工具本身
支持自托管，确保数据完全由你掌控
极致的性能优化，确保运行速度
开源且采用宽松的 MIT 许可证

Learn more about Kaneo’s features and capabilities in our documentation.

请查阅我们的文档，了解更多关于 Kaneo 的功能和特性。

Sponsors Kaneo is open source. If you find it useful, consider sponsoring the project to help support ongoing development.

赞助商 Kaneo 是开源项目。如果你觉得它有用，请考虑赞助该项目，以支持其持续开发。

Getting Started (入门指南)

One-Click Deployment with drim For straightforward deployments, use drim - a CLI tool that handles everything for you: curl -fsSL https://assets.kaneo.app/install.sh | sh 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.

使用 drim 一键部署 对于简单的部署，可以使用 drim——一个为你处理所有事务的 CLI 工具： curl -fsSL https://assets.kaneo.app/install.sh | sh drim setup 只需如此。你的 Kaneo 实例将自动配置 HTTPS、数据库及所有服务。非常适合需要快速部署且希望“开箱即用”的生产环境。

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.

使用 Docker Compose 快速启动 尝试 Kaneo 最快的方法是使用 Docker Compose。这可以通过单个 Kaneo 容器来设置 Kaneo 和 PostgreSQL。

(Code block omitted for brevity, please refer to original text for configuration)

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.

将上述内容保存为 compose.yml，将 .env.sample 复制为 .env，取消 KANEO_CLIENT_URL=http://localhost:5173 的注释，设置 POSTGRES_PASSWORD=<密码> 和 AUTH_SECRET=<openssl rand -hex 32 的输出>，运行 docker compose up -d，然后访问 http://localhost:5173。

Important: See our full documentation for detailed setup instructions, environment variable configuration, and troubleshooting guides.

重要提示： 请参阅我们的完整文档，获取详细的设置说明、环境变量配置和故障排除指南。

Development Setup (开发环境设置)

For development, see our Environment Setup Guide for detailed instructions on configuring environment variables and troubleshooting common issues like CORS problems.

对于开发环境，请参阅我们的“环境设置指南”，获取有关配置环境变量和解决 CORS 等常见问题的详细说明。

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.

Kaneo 需要配置多个环境变量。上述 Docker Compose 设置会自动处理数据库，但你需要为 API 和 Web 服务配置环境变量。有关完整的配置说明（包括所有必需的环境变量、非 Docker 部署的数据库设置以及高级设置），请参阅文档。

Kubernetes Deployment (Kubernetes 部署)

If you’re running Kubernetes, we provide a comprehensive Helm chart. Check out the Helm chart documentation for detailed installation instructions, production configuration examples, TLS setup, and more.

如果你正在运行 Kubernetes，我们提供了全面的 Helm Chart。请查看 Helm Chart 文档，获取详细的安装说明、生产环境配置示例、TLS 设置等信息。

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 for the details on how to get involved.

我们一直在寻求帮助，无论是：

报告 Bug 或建议新功能
改进文档
贡献代码
在 Discord 上帮助其他用户

请查看 CONTRIBUTING.md 了解如何参与贡献的详细信息。

License MIT License - see LICENSE for details. Built with ❤️ by the Kaneo team and contributors.

许可证 MIT 许可证 - 详情请参阅 LICENSE 文件。由 Kaneo 团队和贡献者怀着 ❤️ 构建。