Documentation

Using Kimai

Kimai user manual, explaining the UI and all available screens

Timesheet Weekly working hours Calendar Invoices Export Reporting Customer Projects Activities Tags Users User preferences Roles & Permissions Teams Settings Doctor Working times Public holiday Absence Dashboard

Tips and Tricks

Articles that explain basic functionality in Kimai

Initial setup Prices (rates) Billable PDF templates Keyboard shortcuts Date and Time formats Duration format Use Kimai as app Connecting via API

Additional features

User documentation for features provided by (paid) plugins

Custom fields Expenses Task management Custom CSS Custom content Translation Invoice Importer Audit trail logs Working contract Kiosk mode Customer Portal

Cloud management

Manage your Kimai Cloud account

Backups Custom domain IP access restriction Single Sign-On (SAML) Invoice templates

FAQ

Answers to frequent questions about Kimai Cloud

Payments Supported countries Data removal Migration to the cloud Plan change

Cloud setups

This is the recommended way for most users / companies

Hetzner Cloud DigitalOcean

Using Docker

Running and updating containerized Kimai images

Docker Docker Compose Kubernetes Build your image Troubleshooting

Setup with SSH

Manage Kimai via SSH on your own server

Installation Updates Reloading cache Plugins

Other setups

There are many ways how you could install and host Kimai

Ubuntu 22.04 Webserver Synology NAS Shared hosting 1-click installations

DevOps

Manage and configure your Kimai installation

Backups Configuration files Emails Logging Commands FAQ Migrate from Kimai v1 Kimai versions

Authenticator

Log in to Kimai using external identity provider

LDAP SAML Azure SAML Google SAML Keycloak SAML Authentik SAML Microsoft ADFS

JSON API

Use the JSON API to fetch and create data in Kimai

Kimai API Examples Pagination

Create plugins

Creating custom plugins, extending Kimai, using internal APIs

Development environment Extending Kimai Create plugins Translations / i18n Custom fields Theme Add to store Migrate plugins to v2

Technical background

Background info and technical correlations

Bughunter Permission structure SQL Examples Using Redis for caching

Kimai - Documentation