Search
K

linuxserver/kimai

Kimai is a professional grade time-tracking application, free and open-source. It handles use-cases of freelancers as well as companies with dozens or hundreds of users. Kimai was build to track your project times and ships with many advanced features, including but not limited to:
JSON API, invoicing, data exports, multi-timer and punch-in punch-out mode, tagging, multi-user - multi-timezones - multi-language (over 30 translations existing!), authentication via SAML/LDAP/Database, two-factor authentication (2FA) with TOTP, customizable role and team permissions, responsive design, user/customer/project specific rates, advanced search & filtering, money and time budgets, advanced reporting, support for plugins and so much more.

Supported Architectures

We utilise the docker manifest for multi-platform awareness. More information is available from docker here and our announcement here.
Simply pulling lscr.io/linuxserver/kimai:latest should retrieve the correct image for your arch, but you can also pull specific arch images via tags.
The architectures supported by this image are:
Architecture
Available
Tag
x86-64
amd64-<version tag>
arm64
arm64v8-<version tag>
armhf

Application Setup

Configure your database connection

You have to replace the following values with your defaults:
  • the database username "your_db_user"
  • the database password "your_db_pass"
  • the database schema name "your_db_name"
  • the database host or IP "your_db_host"
  • the database character set "your_db_charset" (usually "utf8")
  • the database version "your_db_version"
    • run SELECT VERSION(); in your MariaDB/MySQL database to get the version
    • example for MariaDB use "10.11.4-MariaDB-log"
    • example for MySQL use "8.0.32"
  • you might have to adapt port "3306" as well
DATABASE_URL=mysql://your_db_user:your_db_pass@your_db_host:3306/your_db_name?charset=your_db_charset&serverVersion=your_db_version

Create your first user

docker exec -it kimai console kimai:user:create your_username [email protected] ROLE_SUPER_ADMIN

Initial setup

Access the web gui at https://<your-ip>:80, for more information check out Kimai Initial setup.

Usage

To help you get started creating a container from this image you can either use docker-compose or the docker cli.
---
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
# This container requires an external application to be run separately.
# 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 #optional
- MYSQL_USER=your_db_user #optional
- MYSQL_PASSWORD=your_db_pass #optional
volumes:
- path_to_data:/config
ports:
- 3306:3306
restart: unless-stopped
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
# This container requires an external application to be run separately.
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

Parameters

Docker images are configured using parameters passed at runtime (such as those above). These parameters are separated by a colon and indicate <external>:<internal> respectively. For example, -p 8080:80 would expose port 80 from inside the container to be accessible from the host's IP on port 8080 outside the container.

Ports (-p)

Parameter
Function
80
http gui
443
https gui

Environment Variables (-e)

Env
Function
PUID=1000
for UserID - see below for explanation
PGID=1000
for GroupID - see below for explanation
TZ=Etc/UTC
specify a timezone to use, see this list.
DATABASE_URL=mysql://your_db_user:your_db_pass@your_db_host:3306/your_db_name?charset=your_db_charset&serverVersion=your_db_version
Configure your database connection, see Application Setup instructions.

Volume Mappings (-v)

Volume
Function
/config
Configuration files.

Miscellaneous Options

Environment variables from files (Docker secrets)

You can set any environment variable from a file by using a special prepend FILE__.
As an example:
-e FILE__PASSWORD=/run/secrets/mysecretpassword
Will set the environment variable PASSWORD based on the contents of the /run/secrets/mysecretpassword file.

Umask for running applications

For all of our images we provide the ability to override the default umask settings for services started within the containers using the optional -e UMASK=022 setting. Keep in mind umask is not chmod it subtracts from permissions based on it's value it does not add. Please read up here before asking for support.

User / Group Identifiers

When using volumes (-v flags), permissions issues can arise between the host OS and the container, we avoid this issue by allowing you to specify the user PUID and group PGID.
Ensure any volume directories on the host are owned by the same user you specify and any permissions issues will vanish like magic.
In this instance PUID=1000 and PGID=1000, to find yours use id user as below:
$ id username
uid=1000(dockeruser) gid=1000(dockergroup) groups=1000(dockergroup)

Docker Mods

We publish various Docker Mods to enable additional functionality within the containers. The list of Mods available for this image (if any) as well as universal mods that can be applied to any one of our images can be accessed via the dynamic badges above.

Support Info

  • Shell access whilst the container is running:
    • docker exec -it kimai /bin/bash
  • To monitor the logs of the container in realtime:
    • docker logs -f kimai
  • Container version number
    • docker inspect -f '{{ index .Config.Labels "build_version" }}' kimai
  • Image version number
    • docker inspect -f '{{ index .Config.Labels "build_version" }}' lscr.io/linuxserver/kimai:latest

Versions

  • 21.08.23: - Important documentation update for setting DATABASE_URL with version 2.0.30 and later.
  • 09.08.23: - Initial Release.