Kaneo 快速开始

快速开始 | 网站 | 云服务 | Discord

为什么选择 Kaneo？

在多年使用臃肿、过度复杂的项目管理平台，而这些平台反而让人无法专注于实际工作之后，我们构建了 Kaneo，让它与众不同。

大多数工具的问题不在于功能不够——而在于功能太多。每一条通知、每一个多余的按钮、每一个复杂的工作流程，都会让你的团队偏离真正重要的事情：打造优秀的产品。

我们相信，最好的工具是无形的。它们应该放大你团队的自然工作流程，而不是强迫你去适应它们的流程。Kaneo 建立在“少即是多”的原则之上——每个功能的存在都是因为它解决了实际问题，而不是因为它在演示中看起来很惊艳。

它的与众不同之处：

简洁的界面，专注于你的工作，而不是工具本身
支持自托管，让你的数据始终属于你
真正地快速，因为我们重视性能
开源，采用宽松的 MIT 许可证

在我们的[文档](https://docs.kaneo.app)中了解更多关于 Kaneo 的功能和能力。

赞助商

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

快速开始

使用 drim 一键部署

对于简单的部署，使用 drim——一个为你处理所有事情的 CLI 工具：

curl -fsSL https://assets.kaneo.app/install.sh | sh
drim setup

就这样。你的 Kaneo 实例将自动配置 HTTPS、数据库和所有服务并运行。非常适合快速部署和希望一切开箱即用的生产环境。

使用 Docker Compose 快速开始

体验 Kaneo 最快的方式是使用 Docker Compose。这将通过一个 Kaneo 容器同时设置 Kaneo 和 PostgreSQL：

services:
  postgres:
    image: postgres:16-alpine
    env_file:
      - .env
    ports:
      - "5432:5432"
    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
    ports:
      - "5173:5173"
    env_file:
      - .env
    depends_on:
      postgres:
        condition: service_healthy
    restart: unless-stopped
volumes:
  postgres_data:

将其保存为 compose.yml，将 .env.sample 复制为 .env，取消注释 KANEO_CLIENT_URL=http://localhost:5173，设置 POSTGRES_PASSWORD=<密码> 和 AUTH_SECRET=，然后运行 docker compose up -d，打开 http://localhost:5173 即可。

在 Docker Compose 中，捆绑的 Kaneo 容器通过服务主机名 postgres 访问 PostgreSQL。如果你在宿主机上运行 API 而不是在 Compose 内部，请使用 localhost 或显式设置 DATABASE_URL。

重要提示： 请参阅我们的[完整文档](https://docs.kaneo.app)以获取详细的设置说明、环境变量配置和故障排除指南。

开发环境设置

对于开发环境，请参阅我们的[环境设置指南](https://docs.kaneo.app/development/environment-setup)，了解配置环境变量和排查常见问题（如 CORS 问题）的详细说明。

配置

Kaneo 需要配置多个环境变量。上述 Docker Compose 设置会自动处理数据库，但你仍然需要为 API 和 Web 服务配置环境变量。

有关完整的配置说明，包括所有必需的环境变量、非 Docker 部署的数据库设置以及高级配置，请参阅[文档](https://docs.kaneo.app)。

高级部署仍然可以使用单独的 ghcr.io/usekaneo/api 和 ghcr.io/usekaneo/web 镜像。

Kubernetes 部署

如果你正在使用 Kubernetes，我们提供了一个全面的 Helm chart。请查看 [Helm chart 文档](https://docs.kaneo.app/deployment/kubernetes)，了解详细的安装说明、生产配置示例、TLS 设置等。

开发

想要参与 Kaneo 的开发？请参阅我们的[环境设置指南](https://docs.kaneo.app/development/environment-setup)，了解配置环境变量和排查常见问题（如 CORS 问题）的详细说明。

快速开始：

# 克隆并安装依赖
git clone https://github.com/usekaneo/kaneo.git
cd kaneo
pnpm install

# 在根目录创建 .env 文件并配置所需的环境变量
# 详细说明请参阅 ENVIRONMENT_SETUP.md

# 启动开发服务器
pnpm dev

有关贡献指南、代码结构和开发最佳实践，请查看我们的[贡献指南](https://github.com/usekaneo/kaneo/blob/main/CONTRIBUTING.md)和[文档](https://docs.kaneo.app)。

社区

Discord - 与用户和贡献者交流
GitHub Issues - 报告 Bug 和功能请求
文档 - 详细指南、API 文档和教程

贡献

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

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

请查看 [CONTRIBUTING.md](https://github.com/usekaneo/kaneo/blob/main/CONTRIBUTING.md) 了解如何参与的详细信息。

许可证

MIT 许可证 - 详情请参阅 [LICENSE](https://github.com/usekaneo/kaneo/blob/main/LICENSE)。

由 Kaneo 团队和贡献者用 ❤️ 构建

usekaneo kaneo