{"id":20828575,"url":"https://github.com/linuxserver/docker-kimai","last_synced_at":"2026-04-13T22:04:00.020Z","repository":{"id":187344396,"uuid":"676347023","full_name":"linuxserver/docker-kimai","owner":"linuxserver","description":null,"archived":false,"fork":false,"pushed_at":"2026-03-13T23:03:43.000Z","size":307,"stargazers_count":28,"open_issues_count":0,"forks_count":4,"subscribers_count":7,"default_branch":"main","last_synced_at":"2026-03-14T10:43:09.789Z","etag":null,"topics":["hacktoberfest"],"latest_commit_sha":null,"homepage":null,"language":"Dockerfile","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"gpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/linuxserver.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":".github/CONTRIBUTING.md","funding":".github/FUNDING.yml","license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null},"funding":{"github":"linuxserver","open_collective":"linuxserver"}},"created_at":"2023-08-09T02:14:31.000Z","updated_at":"2026-03-13T22:57:17.000Z","dependencies_parsed_at":"2026-01-08T04:17:52.356Z","dependency_job_id":null,"html_url":"https://github.com/linuxserver/docker-kimai","commit_stats":{"total_commits":123,"total_committers":5,"mean_commits":24.6,"dds":"0.21138211382113825","last_synced_commit":"740bd20da37dd1d4249b491fb0726dac8e18d020"},"previous_names":["linuxserver/docker-kimai"],"tags_count":173,"template":false,"template_full_name":null,"purl":"pkg:github/linuxserver/docker-kimai","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/linuxserver%2Fdocker-kimai","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/linuxserver%2Fdocker-kimai/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/linuxserver%2Fdocker-kimai/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/linuxserver%2Fdocker-kimai/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/linuxserver","download_url":"https://codeload.github.com/linuxserver/docker-kimai/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/linuxserver%2Fdocker-kimai/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":31383636,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-04-03T23:20:52.058Z","status":"ssl_error","status_checked_at":"2026-04-03T23:20:51.675Z","response_time":107,"last_error":"SSL_read: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["hacktoberfest"],"created_at":"2024-11-17T23:16:18.524Z","updated_at":"2026-04-04T01:02:36.150Z","avatar_url":"https://github.com/linuxserver.png","language":"Dockerfile","funding_links":["https://github.com/sponsors/linuxserver","https://opencollective.com/linuxserver"],"categories":[],"sub_categories":[],"readme":"\u003c!-- DO NOT EDIT THIS FILE MANUALLY --\u003e\n\u003c!-- Please read https://github.com/linuxserver/docker-kimai/blob/main/.github/CONTRIBUTING.md --\u003e\n[![linuxserver.io](https://raw.githubusercontent.com/linuxserver/docker-templates/master/linuxserver.io/img/linuxserver_medium.png)](https://linuxserver.io)\n\n[![Blog](https://img.shields.io/static/v1.svg?color=94398d\u0026labelColor=555555\u0026logoColor=ffffff\u0026style=for-the-badge\u0026label=linuxserver.io\u0026message=Blog)](https://blog.linuxserver.io \"all the things you can do with our containers including How-To guides, opinions and much more!\")\n[![Discord](https://img.shields.io/discord/354974912613449730.svg?color=94398d\u0026labelColor=555555\u0026logoColor=ffffff\u0026style=for-the-badge\u0026label=Discord\u0026logo=discord)](https://linuxserver.io/discord \"realtime support / chat with the community and the team.\")\n[![Discourse](https://img.shields.io/discourse/https/discourse.linuxserver.io/topics.svg?color=94398d\u0026labelColor=555555\u0026logoColor=ffffff\u0026style=for-the-badge\u0026logo=discourse)](https://discourse.linuxserver.io \"post on our community forum.\")\n[![GitHub](https://img.shields.io/static/v1.svg?color=94398d\u0026labelColor=555555\u0026logoColor=ffffff\u0026style=for-the-badge\u0026label=linuxserver.io\u0026message=GitHub\u0026logo=github)](https://github.com/linuxserver \"view the source for all of our repositories.\")\n[![Open Collective](https://img.shields.io/opencollective/all/linuxserver.svg?color=94398d\u0026labelColor=555555\u0026logoColor=ffffff\u0026style=for-the-badge\u0026label=Supporters\u0026logo=open%20collective)](https://opencollective.com/linuxserver \"please consider helping us by either donating or contributing to our budget\")\n\nThe [LinuxServer.io](https://linuxserver.io) team brings you another container release featuring:\n\n* regular and timely application updates\n* easy user mappings (PGID, PUID)\n* custom base image with s6 overlay\n* weekly base OS updates with common layers across the entire LinuxServer.io ecosystem to minimise space usage, down time and bandwidth\n* regular security updates\n\nFind us at:\n\n* [Blog](https://blog.linuxserver.io) - all the things you can do with our containers including How-To guides, opinions and much more!\n* [Discord](https://linuxserver.io/discord) - realtime support / chat with the community and the team.\n* [Discourse](https://discourse.linuxserver.io) - post on our community forum.\n* [GitHub](https://github.com/linuxserver) - view the source for all of our repositories.\n* [Open Collective](https://opencollective.com/linuxserver) - please consider helping us by either donating or contributing to our budget\n\n# [linuxserver/kimai](https://github.com/linuxserver/docker-kimai)\n\n[![Scarf.io pulls](https://scarf.sh/installs-badge/linuxserver-ci/linuxserver%2Fkimai?color=94398d\u0026label-color=555555\u0026logo-color=ffffff\u0026style=for-the-badge\u0026package-type=docker)](https://scarf.sh)\n[![GitHub Stars](https://img.shields.io/github/stars/linuxserver/docker-kimai.svg?color=94398d\u0026labelColor=555555\u0026logoColor=ffffff\u0026style=for-the-badge\u0026logo=github)](https://github.com/linuxserver/docker-kimai)\n[![GitHub Release](https://img.shields.io/github/release/linuxserver/docker-kimai.svg?color=94398d\u0026labelColor=555555\u0026logoColor=ffffff\u0026style=for-the-badge\u0026logo=github)](https://github.com/linuxserver/docker-kimai/releases)\n[![GitHub Package Repository](https://img.shields.io/static/v1.svg?color=94398d\u0026labelColor=555555\u0026logoColor=ffffff\u0026style=for-the-badge\u0026label=linuxserver.io\u0026message=GitHub%20Package\u0026logo=github)](https://github.com/linuxserver/docker-kimai/packages)\n[![GitLab Container Registry](https://img.shields.io/static/v1.svg?color=94398d\u0026labelColor=555555\u0026logoColor=ffffff\u0026style=for-the-badge\u0026label=linuxserver.io\u0026message=GitLab%20Registry\u0026logo=gitlab)](https://gitlab.com/linuxserver.io/docker-kimai/container_registry)\n[![Quay.io](https://img.shields.io/static/v1.svg?color=94398d\u0026labelColor=555555\u0026logoColor=ffffff\u0026style=for-the-badge\u0026label=linuxserver.io\u0026message=Quay.io)](https://quay.io/repository/linuxserver.io/kimai)\n[![Docker Pulls](https://img.shields.io/docker/pulls/linuxserver/kimai.svg?color=94398d\u0026labelColor=555555\u0026logoColor=ffffff\u0026style=for-the-badge\u0026label=pulls\u0026logo=docker)](https://hub.docker.com/r/linuxserver/kimai)\n[![Docker Stars](https://img.shields.io/docker/stars/linuxserver/kimai.svg?color=94398d\u0026labelColor=555555\u0026logoColor=ffffff\u0026style=for-the-badge\u0026label=stars\u0026logo=docker)](https://hub.docker.com/r/linuxserver/kimai)\n[![Jenkins Build](https://img.shields.io/jenkins/build?labelColor=555555\u0026logoColor=ffffff\u0026style=for-the-badge\u0026jobUrl=https%3A%2F%2Fci.linuxserver.io%2Fjob%2FDocker-Pipeline-Builders%2Fjob%2Fdocker-kimai%2Fjob%2Fmain%2F\u0026logo=jenkins)](https://ci.linuxserver.io/job/Docker-Pipeline-Builders/job/docker-kimai/job/main/)\n\n[Kimai](https://kimai.org/) is a professional grade time-tracking application, free and open-source.\nIt handles use-cases of freelancers as well as companies with dozens or hundreds of users.\nKimai was build to track your project times and ships with many advanced features, including but not limited to:\n\nJSON API, invoicing, data exports, multi-timer and punch-in punch-out mode, tagging, multi-user - multi-timezones - multi-language ([over 30 translations existing](https://hosted.weblate.org/projects/kimai/)!), 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 \u0026 filtering, money and time budgets, advanced reporting, support for [plugins](https://www.kimai.org/store/) and so much more.\n\n[![kimai](https://raw.githubusercontent.com/linuxserver/docker-templates/master/linuxserver.io/img/kimai-logo.png)](https://kimai.org/)\n\n## Supported Architectures\n\nWe utilise the docker manifest for multi-platform awareness. More information is available from docker [here](https://distribution.github.io/distribution/spec/manifest-v2-2/#manifest-list) and our announcement [here](https://blog.linuxserver.io/2019/02/21/the-lsio-pipeline-project/).\n\nSimply pulling `lscr.io/linuxserver/kimai:latest` should retrieve the correct image for your arch, but you can also pull specific arch images via tags.\n\nThe architectures supported by this image are:\n\n| Architecture | Available | Tag |\n| :----: | :----: | ---- |\n| x86-64 | ✅ | amd64-\\\u003cversion tag\\\u003e |\n| arm64 | ✅ | arm64v8-\\\u003cversion tag\\\u003e |\n\n## Application Setup\n\n### Configure your database connection\n\nYou have to replace the following values with your defaults:\n\n* the database username \"your_db_user\"\n* the database password \"your_db_pass\"\n* the database schema name \"your_db_name\"\n* the database host or IP \"your_db_host\"\n* the database character set \"your_db_charset\" (usually \"utf8\")\n* the database version \"your_db_version\"\n  * run `SELECT VERSION();` in your MariaDB/MySQL database to get the version\n  * example for [MariaDB](https://www.doctrine-project.org/projects/doctrine-dbal/en/current/reference/configuration.html#mariadb) use \"10.11.4-MariaDB-log\"\n  * example for [MySQL](https://www.doctrine-project.org/projects/doctrine-dbal/en/current/reference/configuration.html#mysql) use \"8.0.32\"\n* you might have to adapt port \"3306\" as well\n\n```env\nDATABASE_URL=mysql://your_db_user:your_db_pass@your_db_host:3306/your_db_name?charset=your_db_charset\u0026serverVersion=your_db_version\n````\n\n### Create your first user\n\n```shell\ndocker exec -it kimai console kimai:user:create your_username admin@example.com ROLE_SUPER_ADMIN\n```\n\n### Initial setup\n\nAccess the web gui at `http://\u003cyour-ip\u003e:80`, for more information check out [Kimai Initial setup](https://www.kimai.org/documentation/initial-setup.html).\n\n## Usage\n\nTo help you get started creating a container from this image you can either use docker-compose or the docker cli.\n\n\u003e[!NOTE]\n\u003eUnless a parameter is flagged as 'optional', it is *mandatory* and a value must be provided.\n\n### docker-compose (recommended, [click here for more info](https://docs.linuxserver.io/general/docker-compose))\n\n```yaml\n---\nservices:\n  kimai:\n    image: lscr.io/linuxserver/kimai:latest\n    container_name: kimai\n    environment:\n      - PUID=1000\n      - PGID=1000\n      - TZ=Etc/UTC\n      - DATABASE_URL=mysql://your_db_user:your_db_pass@your_db_host:3306/your_db_name?charset=your_db_charset\u0026serverVersion=your_db_version\n      - TRUSTED_PROXIES=127.0.0.1/32 #optional\n    volumes:\n      - /path/to/kimai/config:/config\n    ports:\n      - 80:80\n      - 443:443\n    restart: unless-stopped\n\n# This container requires an external application to be run separately.\n# MariaDB\n  mariadb:\n    image: lscr.io/linuxserver/mariadb:latest\n    container_name: mariadb\n    environment:\n      - PUID=1000\n      - PGID=1000\n      - TZ=Etc/UTC\n      - MYSQL_ROOT_PASSWORD=ROOT_ACCESS_PASSWORD\n      - MYSQL_DATABASE=your_db_name #optional\n      - MYSQL_USER=your_db_user #optional\n      - MYSQL_PASSWORD=your_db_pass #optional\n    volumes:\n      - path_to_data:/config\n    ports:\n      - 3306:3306\n    restart: unless-stopped\n\n```\n\n### docker cli ([click here for more info](https://docs.docker.com/engine/reference/commandline/cli/))\n\n```bash\ndocker run -d \\\n  --name=kimai \\\n  -e PUID=1000 \\\n  -e PGID=1000 \\\n  -e TZ=Etc/UTC \\\n  -e DATABASE_URL=mysql://your_db_user:your_db_pass@your_db_host:3306/your_db_name?charset=your_db_charset\u0026serverVersion=your_db_version \\\n  -e TRUSTED_PROXIES=127.0.0.1/32 `#optional` \\\n  -p 80:80 \\\n  -p 443:443 \\\n  -v /path/to/kimai/config:/config \\\n  --restart unless-stopped \\\n  lscr.io/linuxserver/kimai:latest\n\n# This container requires an external application to be run separately.\ndocker run -d \\\n  --name=mariadb \\\n  -e PUID=1000 \\\n  -e PGID=1000 \\\n  -e TZ=Etc/UTC \\\n  -e MYSQL_ROOT_PASSWORD=ROOT_ACCESS_PASSWORD \\\n  -e MYSQL_DATABASE=your_db_name `#optional` \\\n  -e MYSQL_USER=your_db_user `#optional` \\\n  -e MYSQL_PASSWORD=your_db_pass `#optional` \\\n  -p 3306:3306 \\\n  -v path_to_data:/config \\\n  --restart unless-stopped \\\n  lscr.io/linuxserver/mariadb:latest\n\n```\n\n## Parameters\n\nContainers are configured using parameters passed at runtime (such as those above). These parameters are separated by a colon and indicate `\u003cexternal\u003e:\u003cinternal\u003e` 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.\n\n| Parameter | Function |\n| :----: | --- |\n| `-p 80:80` | http gui |\n| `-p 443:443` | https gui |\n| `-e PUID=1000` | for UserID - see below for explanation |\n| `-e PGID=1000` | for GroupID - see below for explanation |\n| `-e TZ=Etc/UTC` | specify a timezone to use, see this [list](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones#List). |\n| `-e DATABASE_URL=mysql://your_db_user:your_db_pass@your_db_host:3306/your_db_name?charset=your_db_charset\u0026serverVersion=your_db_version` | Configure your database connection, see Application Setup instructions. |\n| `-e TRUSTED_PROXIES=127.0.0.1/32` | If behind a reverse proxy set this to its IP or network CIDR so that Kimai trusts its headers. |\n| `-v /config` | Persistent config files |\n\n## Environment variables from files (Docker secrets)\n\nYou can set any environment variable from a file by using a special prepend `FILE__`.\n\nAs an example:\n\n```bash\n-e FILE__MYVAR=/run/secrets/mysecretvariable\n```\n\nWill set the environment variable `MYVAR` based on the contents of the `/run/secrets/mysecretvariable` file.\n\n## Umask for running applications\n\nFor 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.\nKeep in mind umask is not chmod it subtracts from permissions based on it's value it does not add. Please read up [here](https://en.wikipedia.org/wiki/Umask) before asking for support.\n\n## User / Group Identifiers\n\nWhen 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`.\n\nEnsure any volume directories on the host are owned by the same user you specify and any permissions issues will vanish like magic.\n\nIn this instance `PUID=1000` and `PGID=1000`, to find yours use `id your_user` as below:\n\n```bash\nid your_user\n```\n\nExample output:\n\n```text\nuid=1000(your_user) gid=1000(your_user) groups=1000(your_user)\n```\n\n## Docker Mods\n\n[![Docker Mods](https://img.shields.io/badge/dynamic/yaml?color=94398d\u0026labelColor=555555\u0026logoColor=ffffff\u0026style=for-the-badge\u0026label=kimai\u0026query=%24.mods%5B%27kimai%27%5D.mod_count\u0026url=https%3A%2F%2Fraw.githubusercontent.com%2Flinuxserver%2Fdocker-mods%2Fmaster%2Fmod-list.yml)](https://mods.linuxserver.io/?mod=kimai \"view available mods for this container.\") [![Docker Universal Mods](https://img.shields.io/badge/dynamic/yaml?color=94398d\u0026labelColor=555555\u0026logoColor=ffffff\u0026style=for-the-badge\u0026label=universal\u0026query=%24.mods%5B%27universal%27%5D.mod_count\u0026url=https%3A%2F%2Fraw.githubusercontent.com%2Flinuxserver%2Fdocker-mods%2Fmaster%2Fmod-list.yml)](https://mods.linuxserver.io/?mod=universal \"view available universal mods.\")\n\nWe publish various [Docker Mods](https://github.com/linuxserver/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.\n\n## Support Info\n\n* Shell access whilst the container is running:\n\n    ```bash\n    docker exec -it kimai /bin/bash\n    ```\n\n* To monitor the logs of the container in realtime:\n\n    ```bash\n    docker logs -f kimai\n    ```\n\n* Container version number:\n\n    ```bash\n    docker inspect -f '{{ index .Config.Labels \"build_version\" }}' kimai\n    ```\n\n* Image version number:\n\n    ```bash\n    docker inspect -f '{{ index .Config.Labels \"build_version\" }}' lscr.io/linuxserver/kimai:latest\n    ```\n\n## Updating Info\n\nMost of our images are static, versioned, and require an image update and container recreation to update the app inside. With some exceptions (noted in the relevant readme.md), we do not recommend or support updating apps inside the container. Please consult the [Application Setup](#application-setup) section above to see if it is recommended for the image.\n\nBelow are the instructions for updating containers:\n\n### Via Docker Compose\n\n* Update images:\n    * All images:\n\n        ```bash\n        docker-compose pull\n        ```\n\n    * Single image:\n\n        ```bash\n        docker-compose pull kimai\n        ```\n\n* Update containers:\n    * All containers:\n\n        ```bash\n        docker-compose up -d\n        ```\n\n    * Single container:\n\n        ```bash\n        docker-compose up -d kimai\n        ```\n\n* You can also remove the old dangling images:\n\n    ```bash\n    docker image prune\n    ```\n\n### Via Docker Run\n\n* Update the image:\n\n    ```bash\n    docker pull lscr.io/linuxserver/kimai:latest\n    ```\n\n* Stop the running container:\n\n    ```bash\n    docker stop kimai\n    ```\n\n* Delete the container:\n\n    ```bash\n    docker rm kimai\n    ```\n\n* Recreate a new container with the same docker run parameters as instructed above (if mapped correctly to a host folder, your `/config` folder and settings will be preserved)\n* You can also remove the old dangling images:\n\n    ```bash\n    docker image prune\n    ```\n\n### Image Update Notifications - Diun (Docker Image Update Notifier)\n\n\u003e[!TIP]\n\u003eWe recommend [Diun](https://crazymax.dev/diun/) for update notifications. Other tools that automatically update containers unattended are not recommended or supported.\n\n## Building locally\n\nIf you want to make local modifications to these images for development purposes or just to customize the logic:\n\n```bash\ngit clone https://github.com/linuxserver/docker-kimai.git\ncd docker-kimai\ndocker build \\\n  --no-cache \\\n  --pull \\\n  -t lscr.io/linuxserver/kimai:latest .\n```\n\nThe ARM variants can be built on x86_64 hardware and vice versa using `lscr.io/linuxserver/qemu-static`\n\n```bash\ndocker run --rm --privileged lscr.io/linuxserver/qemu-static --reset\n```\n\nOnce registered you can define the dockerfile to use with `-f Dockerfile.aarch64`.\n\n## Versions\n\n* **28.12.25:** - Rebase to Alpine 3.23.\n* **04.07.25:** - Rebase to Alpine 3.22.\n* **06.04.25:** - Rebase to Alpine 3.21.\n* **30.06.24:** - Rebase to Alpine 3.20. Existing users should update their nginx confs to avoid http2 deprecation warnings.\n* **24.03.24:** - Added LDAP module to composer\n* **06.03.24:** - Existing users should update: site-confs/default.conf - Cleanup default site conf.\n* **23.01.24:** - Rebase to Alpine 3.19 with php 8.3.\n* **02.01.24:** - Symlink config.yaml to /config for user editing.\n* **21.08.23:** - Important documentation update for setting `DATABASE_URL` with version 2.0.30 and later.\n* **09.08.23:** - Initial Release.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Flinuxserver%2Fdocker-kimai","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Flinuxserver%2Fdocker-kimai","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Flinuxserver%2Fdocker-kimai/lists"}