How to Deploy Kimai Time Tracking with Docker Compose

X (Twitter) Facebook Pinterest LinkedIn

Kimai is a free, open-source time-tracking software that allows freelancers, developers, and teams to track their working hours across various projects and tasks. Deploying Kimai with Docker Compose simplifies the process, making it accessible even to those with minimal Docker experience. This article will walk you through the steps to set up Kimai using Docker Compose, ensuring you have a powerful time tracking system that is up and running quickly.

Table of Contents

Prerequisites

Before you start, ensure Docker and Docker Compose are installed on your system. Docker Compose allows you to easily define and run multi-container Docker applications. With a YAML file, you can configure your application’s services, networks, and volumes and then start everything with a single command.

Step 1: Create a Docker Compose File

To begin, create a docker-compose.yml file in a new directory. This file will define the services, volumes, and configurations to run Kimai. Below is an example Docker Compose file tailored for Kimai:

version: '3.7'

services:
  kimai:
    image: kimai/kimai2:fpm-alpine-1.14
    environment:
      - APP_ENV=prod
      - DATABASE_URL=mysql://kimaiuser:kimaipassword@database/kimai
    volumes:
      - public:/opt/kimai/public
      - var:/opt/kimai/var
    depends_on:
      - database

  database:
    image: mysql:5.7
    environment:
      - MYSQL_DATABASE=kimai
      - MYSQL_USER=kimaiuser
      - MYSQL_PASSWORD=kimaipassword
      - MYSQL_ROOT_PASSWORD=rootpassword
    volumes:
      - db:/var/lib/mysql

  nginx:
    image: nginx:alpine
    ports:
      - "8001:80"
    volumes:
      - ./nginx.conf:/etc/nginx/nginx.conf:ro
      - public:/var/www/public:ro
    depends_on:
      - kimai

volumes:
  public:
  var:
  db:

Explanation of the Docker Compose File

Kimai Service: Uses the official Kimai image. The environment variables APP_ENV and DATABASE_URL are used to configure Kimai. Volumes are mounted to persist data.
Database Service: Uses MySQL 5.7 image, with environment variables to set up the database for Kimai.
Nginx Service: Serves as the web server for Kimai. The custom nginx.conf file needs to be created to configure Nginx properly. Port 8001 is exposed for web access.

Step 2: Create the Nginx Configuration

For Nginx to serve the Kimai application correctly, you must provide a configuration file. Create a file named nginx.conf in the same directory as your docker-compose.yml with the following configuration:

worker_processes 1;

events {
    worker_connections 1024;
}

http {
    server {
        listen 80;
        server_name localhost;

        root /var/www/public;
        index index.php index.html;

        location / {
            try_files $uri /index.php$is_args$args;
        }

        location ~ ^/index\.php(/|$) {
            fastcgi_pass kimai:9000;
            fastcgi_split_path_info ^(.+\.php)(/.*)$;
            include fastcgi_params;
            fastcgi_param SCRIPT_FILENAME $document_root$fastcgi_script_name;
            fastcgi_param DOCUMENT_ROOT $document_root;
            internal;
        }

        location ~ \.php$ {
            return 404;
        }
    }
}

This configuration directs Nginx to serve the Kimai application and handle PHP files correctly by forwarding them to the Kimai service.

Step 3: Launch Your Kimai Instance

With the docker-compose.yml and nginx.conf files ready, launch your Kimai instance by running the following command in the directory containing your Docker Compose file:

This command starts all the defined services in detached mode. Your Kimai instance will be accessible at http://localhost:8001.

docker-compose up -d

Conclusion

Deploying Kimai with Docker Compose offers a streamlined and efficient approach to setting up a robust time-tracking system. Following the steps outlined in this guide, you can quickly get Kimai up and running, ready to track your projects and work hours. Docker Compose simplifies the deployment process and ensures that your Kimai instance is easily maintainable and scalable. Whether you’re a freelancer, part of an agency, or managing a team, Kimai provides the features to stay on top of your time management needs.

Author
Recent Posts

Follow me

Anastasios Antoniadis

Anastasios Antoniadis is the founder and editor-in-chief of BORDERPOLAR... He is a software engineer, blogger, and avid gamer covering tech, gaming, and coding guides for over 4 years. He is a 2014 graduate of the Department of Informatics and Telecommunications of the University of Athens, an M.Sc. holder in Computer Science, and a Ph.D. student in Program Analysis.