lsiodev/kimai

linuxserver/kimai

Kimai是一个专业级别的时间跟踪应用，免费且开源。它适用于自由职业者以及拥有数十或数百用户的公司。Kimai专为跟踪项目时间而构建，并提供许多高级功能，包括但不限于：JSON API、发票生成、数据导出、多计时器和打卡模式、标签、多用户-多时区-多语言（现有超过30种翻译）、通过SAML/LDAP/数据库进行身份验证、带TOTP的双因素认证(2FA)、可定制的角色和团队权限、响应式设计、用户/客户/项目特定费率、高级搜索和过滤、资金和时间预算、高级报告、对插件的支持等等。

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

支持的架构

我们利用docker manifest实现多平台支持。只需拉取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

初始设置

在https://<your-ip>:80访问Web界面，更多信息请查看Kimai初始设置。

使用方法

为了帮助您开始从此镜像创建容器，您可以使用docker-compose或docker命令行。

docker-compose（推荐，点击此处了解更多信息）

yaml
---
version: "2.1"
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
    volumes:
      - /path/to/appdata/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 \
  -p 80:80 \
  -p 443:443 \
  -v /path/to/appdata/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 `#optional` \
  -e MYSQL_USER=your_db_user `#optional` \
  -e MYSQL_PASSWORD=your_db_pass `#optional` \
  -p 3306:3306 \
  -v path_to_data:/config \
  --restart unless-stopped \
  lscr.io/linuxserver/mariadb:latest

参数

容器通过运行时传递的参数进行配置（如上所示）。这些参数用冒号分隔，表示<外部>:<内部>。例如，-p 8080:80会将容器内的端口80暴露出来，可从主机的IP上通过端口8080访问。

来自文件的环境变量（Docker secrets）

您可以通过使用特殊的前缀FILE__从文件中设置任何环境变量。

例如：

bash
-e FILE__MYVAR=/run/secrets/mysecretvariable

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

运行应用程序的Umask

对于我们所有的镜像，您可以使用可选的-e UMASK=022设置来覆盖容器内启动的服务的默认umask设置。 请记住，umask不是chmod，它根据其值减去权限，而不是添加权限。在请求支持之前，请先阅读。

用户/组标识符

使用卷（-v标志）时，主机操作系统和容器之间可能会出现权限问题，我们通过允许您指定用户PUID和组PGID来避免此问题。

确保主机上的任何卷目录都由您指定的同一用户拥有，任何权限问题都将像魔术一样消失。

在这个例子中PUID=1000和PGID=1000，要找到您的ID，请使用id your_user，如下所示：

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%EF%BC%8C%E4%BB%A5%E5%90%AF%E7%94%A8%E5%AE%B9%E5%99%A8%E5%86%85%E7%9A%84%E5%85%B6%E4%BB%96%E5%8A%9F%E8%83%BD%E3%80%82%E5%8F%AF%E7%94%A8%E4%BA%8E%E6%AD%A4%E9%95%9C%E5%83%8F%E7%9A%84Mods%E5%88%97%E8%A1%A8%EF%BC%88%E5%A6%82%E6%9E%9C%E6%9C%89%EF%BC%89%E4%BB%A5%E5%8F%8A%E5%8F%AF%E5%BA%94%E7%94%A8%E4%BA%8E%E6%88%91%E4%BB%AC%E4%BB%BB%E4%BD%95%E9%95%9C%E5%83%8F%E7%9A%84%E9%80%9A%E7%94%A8Mods%E5%8F%AF%E4%BB%A5%E9%80%9A%E8%BF%87%E4%B8%8A%E9%9D%A2%E7%9A%84%E5%8A%A8%E6%80%81%E5%BE%BD%E7%AB%A0%E8%AE%BF%E9%97%AE%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
  

更新信息

我们的大多数镜像是静态的、版本化的，需要更新镜像并重新创建容器来更新内部的应用程序。对于某些例外情况（如nextcloud、plex），我们不建议或支持在容器内更新应用程序。请查阅上面的应用程序设置部分，了解是否推荐对该镜像进行更新。

以下是更新容器的说明：

通过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
  

通过Watchtower自动更新器（仅在您不记得原始参数时使用）

• 拉取其标签的最新镜像并在一次运行中用相同的环境变量替换它：

  bash
  docker run --rm \
    -v /var/run/docker.sock:/var/run/docker.sock \
    containrrr/watchtower \
    --run-once kimai
  

• 您还可以删除旧的悬空镜像：docker image prune

警告：我们不认可使用Watchtower作为自动更新现有Docker容器的解决方案。事实上，我们通常不鼓励自动更新。但是，对于您忘记原始参数的容器，这是一个有用的一次性手动更新工具。从长远来看，我们强烈建议使用Docker Compose。

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

提示：我们推荐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 .

可以使用multiarch/qemu-user-static在x86_64硬件上构建ARM变体

bash
docker run --rm --privileged multiarch/qemu-user-static:register --reset

注册后，您可以使用-f Dockerfile.aarch64定义要使用的dockerfile。

版本历史

• 21.08.23: - 重要文档更新，关于使用2.0.30及更高版本设置DATABASE_URL。
• 09.08.23: - 初始发布。