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

Articles that explain basic functionality in Kimai

Initial setup Rates Billable Keyboard shortcuts Switch to AM/PM Duration format FAQ Kimai application

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

Use the JSON API to fetch and create data in Kimai

Kimai API Examples Pagination

Creating custom plugins, extending Kimai, using internal APIs

Getting started Translations / i18n Custom fields Theme Add to store Migrate plugins to v2

Background info and technical correlations

Bughunter Permission structure SQL Examples Switch account Using Redis for caching Creating a release

Everything you need to host your Kimai on your own server

Installation Updates Docker Reloading cache Plugins Webserver Ubuntu 18.04 Ubuntu 20.04 Ubuntu 22.04 Synology NAS

Manage and configure your Kimai installation

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

LDAP SAML Azure SAML Google SAML Keycloak SAML Authentik SAML