linuxserver/kimai

https://github.com/linuxserver/docker-kimai

LinuxServer.io团队呈现的此容器具有以下特点：

• 定期及时的应用更新
• 简单的用户映射（PGID、PUID）
• 带s6覆盖层的自定义基础镜像
• 每周基础操作系统更新，整个LinuxServer.io生态系统共享通用层，以最小化空间占用、停机时间和带宽
• 定期安全更新

可在以下渠道找到我们：

• 博客 - 关于容器的所有使用方法，包括指南、观点等
• *** - 实时支持/与社区和团队聊天
• Discourse - 在社区论坛发帖
• https://github.com/linuxserver - 查看所有仓库源代码
• Open Collective - 欢迎通过***或贡献预算支持我们

镜像概述

Kimai是专业级时间跟踪应用，免费开源。它适用于自由职业者以及拥有数十或数百用户的企业。Kimai专为跟踪项目时间而构建，具备众多高级功能，包括但不限于：

JSON API、发票生成、数据导出、多计时器和打卡模式、标签、多用户-多时区-多语言（现有30多种翻译）、通过SAML/LDAP/数据库认证、带TOTP的双因素认证(2FA)、可自定义角色和团队权限、响应式设计、用户/客户/项目特定费率、高级搜索与筛选、资金和时间预算、高级报告、插件支持等。

!https://raw.githubusercontent.com/linuxserver/docker-templates/master/linuxserver.io/img/kimai-logo.png

支持的架构

我们利用Docker清单实现多平台支持。更多信息可参考Dockerhttps://distribution.github.io/distribution/spec/manifest-v2-2/#manifest-list和我们的公告。

直接拉取lscr.io/linuxserver/kimai:latest即可获取适合您架构的正确镜像，也可通过标签拉取特定架构镜像。

此镜像支持的架构：

应用设置

配置数据库连接

需将以下值替换为您的默认值：

• 数据库用户名 "your_db_user"
• 数据库密码 "your_db_pass"
• 数据库模式名称 "your_db_name"
• 数据库主机或IP "your_db_host"
• 数据库字符集 "your_db_charset"（通常为"utf8"）
• 数据库版本 "your_db_version"
  • 在MariaDB/MySQL数据库中运行SELECT VERSION();获取版本
  • MariaDB示例："10.11.4-MariaDB-log"
  • MySQL示例："8.0.32"
• 可能还需要调整端口"3306"

env
DATABASE_URL=mysql://your_db_user:your_db_pass@your_db_host:3306/your_db_name?charset=your_db_charset&serverVersion=your_db_version

创建第一个用户

shell
docker exec -it kimai console kimai:user:create your_username admin@example.com ROLE_SUPER_ADMIN

初始设置

通过http://<您的IP>:80访问Web界面，更多信息请查看Kimai初始设置。

使用方法

以下提供docker-compose和docker cli两种方式帮助您创建容器。

[!NOTE] 除非参数标记为"可选"，否则均为必填项，必须提供值。

docker-compose（推荐，点击查看更多信息）

yaml
---
services:
  kimai:
    image: lscr.io/linuxserver/kimai:latest
    container_name: kimai
    environment:
      - PUID=1000
      - PGID=1000
      - TZ=Etc/UTC
      - DATABASE_URL=mysql://your_db_user:your_db_pass@your_db_host:3306/your_db_name?charset=your_db_charset&serverVersion=your_db_version
      - TRUSTED_PROXIES=127.0.0.1/32 #可选
    volumes:
      - /path/to/kimai/config:/config
    ports:
      - 80:80
      - 443:443
    restart: unless-stopped

# 此容器需要单独运行外部应用
# MariaDB
  mariadb:
    image: lscr.io/linuxserver/mariadb:latest
    container_name: mariadb
    environment:
      - PUID=1000
      - PGID=1000
      - TZ=Etc/UTC
      - MYSQL_ROOT_PASSWORD=ROOT_ACCESS_PASSWORD
      - MYSQL_DATABASE=your_db_name #可选
      - MYSQL_USER=your_db_user #可选
      - MYSQL_PASSWORD=your_db_pass #可选
    volumes:
      - path_to_data:/config
    ports:
      - 3306:3306
    restart: unless-stopped

docker cli（点击查看更多信息）

bash
docker run -d \
  --name=kimai \
  -e PUID=1000 \
  -e PGID=1000 \
  -e TZ=Etc/UTC \
  -e DATABASE_URL=mysql://your_db_user:your_db_pass@your_db_host:3306/your_db_name?charset=your_db_charset&serverVersion=your_db_version \
  -e TRUSTED_PROXIES=127.0.0.1/32 `#可选` \
  -p 80:80 \
  -p 443:443 \
  -v /path/to/kimai/config:/config \
  --restart unless-stopped \
  lscr.io/linuxserver/kimai:latest

# 此容器需要单独运行外部应用
docker run -d \
  --name=mariadb \
  -e PUID=1000 \
  -e PGID=1000 \
  -e TZ=Etc/UTC \
  -e MYSQL_ROOT_PASSWORD=ROOT_ACCESS_PASSWORD \
  -e MYSQL_DATABASE=your_db_name `#可选` \
  -e MYSQL_USER=your_db_user `#可选` \
  -e MYSQL_PASSWORD=your_db_pass `#可选` \
  -p 3306:3306 \
  -v path_to_data:/config \
  --restart unless-stopped \
  lscr.io/linuxserver/mariadb:latest

参数

容器通过运行时传递的参数进行配置（如上述示例）。参数格式为<外部>:<内部>，例如-p 8080:80表示将容器内80端口映射到主机8080端口。

从文件设置环境变量（Docker secrets）

可通过特殊前缀FILE__从文件设置任何环境变量。

示例：

bash
-e FILE__MYVAR=/run/secrets/mysecretvariable

这会根据/run/secrets/mysecretvariable文件内容设置环境变量MYVAR。

应用运行的Umask设置

所有镜像均支持通过可选参数-e UMASK=022覆盖容器内服务的默认umask设置。请注意，umask不是chmod，它基于其值减去权限而非添加。使用前请了解umask。

用户/组ID

使用卷（-v参数）时，主机OS与容器间可能出现权限问题。通过指定用户PUID和组PGID可避免此问题。

确保主机上的卷目录归指定用户所有，权限问题将迎刃而解。

此处PUID=1000和PGID=1000，通过id your_user命令获取您的ID：

bash
id your_user

示例输出：

text
uid=1000(your_user) gid=1000(your_user) groups=1000(your_user)

Docker Mods

https://img.shields.io/badge/dynamic/yaml?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge&label=kimai&query=%24.mods%5B%27kimai%27%5D.mod_count&url=https%3A%2F%2Fraw.githubusercontent.com%2Flinuxserver%2Fdocker-mods%2Fmaster%2Fmod-list.yml]([] "查看此容器可用mods") https://img.shields.io/badge/dynamic/yaml?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge&label=universal&query=%24.mods%5B%27universal%27%5D.mod_count&url=https%3A%2F%2Fraw.githubusercontent.com%2Flinuxserver%2Fdocker-mods%2Fmaster%2Fmod-list.yml]([] "查看通用mods")

我们提供多种https://github.com/linuxserver/docker-mods%E4%BB%A5%E5%90%AF%E7%94%A8%E5%AE%B9%E5%99%A8%E9%A2%9D%E5%A4%96%E5%8A%9F%E8%83%BD%E3%80%82%E4%B8%8A%E6%96%B9%E5%8A%A8%E6%80%81%E5%BE%BD%E7%AB%A0%E6%98%BE%E7%A4%BA%E6%AD%A4%E9%95%9C%E5%83%8F%E5%8F%AF%E7%94%A8mods%E5%8F%8A%E9%80%9A%E7%94%A8mods%E3%80%82

支持信息

• 容器运行时进入shell：

  bash
  docker exec -it kimai /bin/bash
  

• 实时监控容器日志：

  bash
  docker logs -f kimai
  

• 容器版本号：

  bash
  docker inspect -f '{{ index .Config.Labels "build_version" }}' kimai
  

• 镜像版本号：

  bash
  docker inspect -f '{{ index .Config.Labels "build_version" }}' lscr.io/linuxserver/kimai:latest
  

更新信息

大多数镜像为静态、版本化，需更新镜像并重建容器以更新内部应用。除特殊说明外，不建议或支持在容器内更新应用。请参考应用设置部分查看是否推荐更新。

以下是更新容器的说明：

通过Docker Compose

• 更新镜像：

  • 所有镜像：

    bash
    docker-compose pull
    

  • 单个镜像：

    bash
    docker-compose pull kimai
    

• 更新容器：

  • 所有容器：

    bash
    docker-compose up -d
    

  • 单个容器：

    bash
    docker-compose up -d kimai
    

• 清理旧镜像：

  bash
  docker image prune
  

通过Docker Run

• 更新镜像：

  bash
  docker pull lscr.io/linuxserver/kimai:latest
  

• 停止运行中的容器：

  bash
  docker stop kimai
  

• 删除容器：

  bash
  docker rm kimai
  

• 使用上述相同docker run参数重建容器（若正确映射主机文件夹，/config文件夹和设置将保留）

• 清理旧镜像：

  bash
  docker image prune
  

镜像更新通知 - Diun（Docker镜像更新通知器）

[!TIP] 推荐使用Diun获取更新通知。不推荐或支持自动更新容器的工具。

本地构建

如需为开发或自定义修改本地镜像：

bash
git clone https://github.com/linuxserver/docker-kimai.git
cd docker-kimai
docker build \
  --no-cache \
  --pull \
  -t lscr.io/linuxserver/kimai:latest .

可使用lscr.io/linuxserver/qemu-static在x86_64硬件上构建ARM变体，反之亦然：

bash
docker run --rm --privileged lscr.io/linuxserver/qemu-static --reset

注册后，可使用-f Dockerfile.aarch64指定Dockerfile。

版本历史

• 04.07.25: - 基于Alpine 3.22重建
• 06.04.25: - 基于Alpine 3.21重建
• 30.06.24: - 基于Alpine 3.20重建。现有用户应更新nginx配置以避免http2弃用警告
• 24.03.24: - 向composer添加LDAP模块
• 06.03.24: - 现有用户应更新：site-confs/default.conf - 清理默认站点配置
• 23.01.24: - 基于Alpine 3.19和php 8.3重建
• 02.01.24: - 将config.yaml符号链接到/config供用户编辑
• 21.08.23: - 重要文档更新：2.0.30及更高版本的DATABASE_URL设置说明
• 09.08.23: - 初始发布