usekaneo/kaneo
GitHub: usekaneo/kaneo
Kaneo 是一款开源的轻量级项目管理平台,旨在用极简界面和自托管能力替代臃肿的团队协作工具。
Stars: 4609 | Forks: 423
[](LICENSE)
[](https://github.com/usekaneo/kaneo/actions)
[](https://discord.gg/rU4tSyhXXU)
[](https://github.com/sponsors/andrejsshell)
## 为什么选择 Kaneo?
在使用了多年臃肿、过于复杂且让人无法专注于实际工作的项目管理平台后,我们决定打造一个与众不同的 Kaneo。
大多数工具的问题不在于缺乏功能,而在于功能**太多了**。每一条通知、每一个多余的按钮、每一个复杂的工作流,都在分散你团队的注意力,让你们无法专注于真正重要的事情:**打造优秀的产品**。
我们相信,最好的工具是**隐形的**。它们应该放大你团队的自然工作流,而不是强迫你去适应它们。Kaneo 的构建理念是**少即是多**——每一个功能的存在都是为了解决实际问题,而不是为了在演示中看起来很酷。
**它的独特之处在于:**
- **简洁的界面**,让你专注于工作,而不是工具本身
- **支持自托管**,确保你的数据始终归你所有
- **极致的速度**,因为我们非常在乎性能
- **开源**,采用宽松的 MIT 许可证
在 our [文档](https://kaneo.app/docs/core) 中了解有关 Kaneo 功能和特性的更多信息。
## 快速上手
### 使用 drim 一键部署
对于简单的部署,可以使用 [drim](https://github.com/usekaneo/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](http://localhost:5173)。
在 Docker Compose 中,打包的 Kaneo 容器通过服务主机名 `postgres` 连接到 PostgreSQL。
如果你在宿主机而不是在 Compose 内部运行 API,请使用 `localhost` 或显式设置 `DATABASE_URL`。
### 开发环境配置
对于开发环境,请参阅我们的 [环境配置指南](ENVIRONMENT_SETUP.md) 获取详细说明,了解如何配置环境变量以及排查 CORS 等常见问题。
### 配置说明
Kaneo 需要配置多个环境变量。上面的 Docker Compose 设置会自动处理数据库,但你仍需为 API 和 Web 服务配置环境变量。
有关完整的配置说明(包括所有必需的环境变量、非 Docker 部署的数据库设置以及高级设置),请参阅[文档](https://kaneo.app/docs/core)。高级部署依然可以使用独立的 `ghcr.io/usekaneo/api` 和 `ghcr.io/usekaneo/web` 镜像。
## Kubernetes 部署
如果你在运行 Kubernetes,我们提供了一个详尽的 Helm chart。请查看 [Helm chart 文档](./charts/kaneo/README.md) 获取详细的安装说明、生产环境配置示例、TLS 设置等更多信息。
## 开发说明
想要折腾 Kaneo?请参阅我们的 [环境配置指南](ENVIRONMENT_SETUP.md) 获取详细说明,了解如何配置环境变量以及排查 CORS 等常见问题。
快速开始:
```
# 克隆并安装依赖
git clone https://github.com/usekaneo/kaneo.git
cd kaneo
pnpm install
# 在 root 目录下创建包含所需 environment variables 的 .env 文件
# 查看 ENVIRONMENT_SETUP.md 获取详细说明
# 启动 development servers
pnpm dev
```
有关贡献指南、代码结构和开发最佳实践,请查看我们的[贡献指南](CONTRIBUTING.md)和[文档](https://kaneo.app/docs/core)。
## 开源许可证
MIT 许可证 - 详情请参阅 [LICENSE](LICENSE)。
由 Kaneo 团队和 贡献者 用 ❤️ 构建
标签:Linux 内核安全, PPID欺骗, 任务管理, 团队协作, 子域名突变, 开源, 敏捷开发, 测试用例, 版权保护, 自动化攻击, 自托管, 请求拦截, 项目管理