kimai/kimai2

Kimai Docker镜像文档

镜像概述和主要用途

Kimai是一款领先的开源时间跟踪应用（https://github.com/kimai/kimai%EF%BC%89%EF%BC%8C%E6%97%A8%E5%9C%A8%E5%B8%AE%E5%8A%A9%E4%B8%AA%E4%BA%BA%E5%92%8C%E5%9B%A2%E9%98%9F%E9%AB%98%E6%95%88%E8%AE%B0%E5%BD%95%E3%80%81%E7%AE%A1%E7%90%86%E5%92%8C%E5%88%86%E6%9E%90%E5%B7%A5%E4%BD%9C%E6%97%B6%E9%97%B4%E3%80%82%E6%9C%ACDocker%E9%95%9C%E5%83%8F%E6%98%AFKimai%E5%AE%98%E6%96%B9%E6%8F%90%E4%BE%9B%E7%9A%84%E9%83%A8%E7%BD%B2%E6%96%B9%E6%A1%88%EF%BC%8C%E5%B0%81%E8%A3%85%E4%BA%86%E5%BA%94%E7%94%A8%E8%BF%90%E8%A1%8C%E6%89%80%E9%9C%80%E7%9A%84%E7%8E%AF%E5%A2%83%E5%92%8C%E4%BE%9D%E8%B5%96%EF%BC%8C%E5%8F%AF%E5%BF%AB%E9%80%9F%E6%90%AD%E5%BB%BAKimai%E5%AE%9E%E4%BE%8B%EF%BC%8C%E7%AE%80%E5%8C%96%E9%83%A8%E7%BD%B2%E6%B5%81%E7%A8%8B%E3%80%82

核心功能和特性

• 时间记录：支持手动录入或自动跟踪工时，记录项目、任务、描述等关键信息。
• 项目与任务管理：创建项目及子任务，关联客户，设置预算和时间目标。
• 用户与权限管理：多用户支持，基于角色的访问控制（RBAC），如超级管理员（ROLE_SUPER_ADMIN）、普通用户等。
• 报告与分析：生成多维度工时统计报告，支持数据导出（如CSV、PDF），辅助项目成本核算和效率分析。
• 多语言支持：内置多种语言包，适应不同地区用户需求。

使用场景和适用范围

• 软件开发团队：跟踪不同项目模块的开发工时，监控任务进度。
• 自由职业者：记录为不同客户提供服务的时间，用于生成发票和工时统计。
• 项目管理人员：汇总团队成员工时，分析资源分配合理性，评估项目成本。
• 中小企业：管理员工考勤、项目工时，生成部门或公司级别的时间利用报告。

可用标签

选择标签前建议参考官方文档：

• kimai/kimai2:apache：最新稳定版Kimai，基于Apache容器封装。
• kimai/kimai2:fpm：最新稳定版Kimai，基于PHP-FPM Alpine容器封装（轻量级，适合生产环境）。
• kimai/kimai2:latest：与kimai/kimai2:fpm标签一致，为默认标签。
• kimai/kimai2:dev：开发版镜像，基于Apache，不建议用于生产环境。

详细使用方法和配置说明

快速启动

以下步骤用于快速部署临时Kimai实例（数据会随容器删除而丢失，仅用于测试）。

1. 启动数据库

Kimai依赖关系型数据库（如MySQL），首先启动MySQL容器：

bash
docker run --rm --name kimai-mysql-testing \
  -e MYSQL_DATABASE=kimai \
  -e MYSQL_USER=kimai \
  -e MYSQL_PASSWORD=kimai \
  -e MYSQL_ROOT_PASSWORD=kimai \
  -p 3399:3306 -d mysql

参数说明：

• --rm：容器停止后自动删除。
• -e MYSQL_DATABASE=kimai：创建名为kimai的数据库。
• -e MYSQL_USER=kimai/MYSQL_PASSWORD=kimai：创建数据库用户kimai及密码。
• -p 3399:3306：将容器3306端口映射到主机3399端口。

2. 启动Kimai容器

使用apache标签启动Kimai，并连接至上述MySQL数据库：

bash
docker run --rm --name kimai-test \
  -ti \
  -p 8001:8001 \
  -e DATABASE_URL=mysql://kimai:kimai@host.docker.internal:3399/kimai \
  --add-host=host.docker.internal:host-gateway \
  kimai/kimai2:apache

关键参数说明：

• -p 8001:8001：将容器8001端口映射到主机8001端口，用于访问Kimai Web界面。
• -e DATABASE_URL：数据库连接URL，格式为mysql://<用户>:<密码>@<主机>:<端口>/<数据库名>，此处连接步骤1启动的MySQL。
• --add-host=host.docker.internal:host-gateway：解决容器内访问主机数据库的网络问题（适用于Docker Desktop环境）。

3. 创建管理员用户

通过容器终端执行命令创建超级管理员用户：

bash
docker exec -ti kimai-test \
  /opt/kimai/bin/console \
  kimai:user:create admin admin@example.com ROLE_SUPER_ADMIN

执行后按提示设置密码，完成后即可通过http://localhost:8001访问Kimai实例，使用创建的管理员账号登录。

注意事项

• 网络连接问题：在Docker Desktop（Windows/Mac）环境中，若出现“Connection refused”错误，需将数据库主机地址改为host.docker.internal（如上述示例），或使用--network="host"参数让容器共享主机网络。详情参考StackOverflow解答。

• 数据持久性：快速启动示例中的容器为临时模式（--rm），删除容器后数据会丢失。生产环境需通过挂载卷（-v）持久化数据库数据和Kimai应用数据。

• 停止与清理：如需删除临时容器，执行：

bash
docker stop kimai-mysql-testing kimai-test
docker rm kimai-mysql-testing kimai-test

配置参数与环境变量

核心环境变量

扩展部署方案

Docker Compose

官方提供Docker Compose配置示例，支持生产环境部署（含数据持久化、Nginx反向代理等），详情参考Kimai Docker Compose文档。

Kubernetes

如需在Kubernetes集群部署，可参考Kimai Kubernetes文档。

官方文档

更多部署细节（如Docker高级配置、升级策略等），请参考Kimai官方文档：

• Docker部署指南
• Docker Compose部署
• Kubernetes部署