Application Setup

Configure your database connection

• the database username "yourdbuser"
• the database password "yourdbpass"
• the database schema name "yourdbname"
• the database host or IP "yourdbhost"
• the database character set "yourdbcharset" (usually "utf8")
• the database version "yourdbversion"

• 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

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

Initial setup

Usage

docker-compose (recommended, click here for more info)

---
services:
  kimai:
    image: lscr.io/linuxserver/kimai:latest
    container_name: kimai
    environment:
      - PUID=1000
      - PGID=1000
      - TZ=Etc/UTC
      - APP_SECRET=
      - 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_HOSTS=kimai.example.com
      - TRUSTED_PROXIES=127.0.0.1/32 #optional
    volumes:
      - /path/to/kimai/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 cli (click here for more info)

docker run -d \
  --name=kimai \
  -e PUID=1000 \
  -e PGID=1000 \
  -e TZ=Etc/UTC \
  -e APP_SECRET= \
  -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_HOSTS=kimai.example.com \
  -e TRUSTED_PROXIES=127.0.0.1/32 `#optional` \
  -p 80:80 \
  -p 443:443 \
  -v /path/to/kimai/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

Environment variables from files (Docker secrets)

-e FILE__MYVAR=/run/secrets/mysecretvariable

Umask for running applications

User / Group Identifiers

id your_user

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

Docker Mods

Support Info

• Shell access whilst the container is running:

```bash
docker exec -it kimai /bin/bash
```

• To monitor the logs of the container in realtime:

```bash
docker logs -f kimai
```

• Container version number:

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

• Image version number:

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

Updating Info

Via Docker Compose

• Update images:

* All images:

    ```bash
    docker-compose pull
    ```

* Single image:

    ```bash
    docker-compose pull kimai
    ```

• Update containers:

* All containers:

    ```bash
    docker-compose up -d
    ```

* Single container:

    ```bash
    docker-compose up -d kimai
    ```

• You can also remove the old dangling images:

```bash
docker image prune
```

Via Docker Run

• Update the image:

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

• Stop the running container:

```bash
docker stop kimai
```

• Delete the container:

```bash
docker rm kimai
```

• 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)
• You can also remove the old dangling images:

```bash
docker image prune
```

Image Update Notifications - Diun (Docker Image Update Notifier)

Building locally

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

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