Kimai logo Kimai Documentation

Kimai - 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
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 Data removal Charities and Educational Migration to the cloud Plan change
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

Getting started 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 Creating a release
Installation & Updates

Everything you need to host your Kimai on your own server

Installation Updates Shared hosting 1-click installations Reloading cache Plugins Webserver Ubuntu 22.04 Synology NAS
Docker

Running and updating containerized Kimai images

Docker Docker Compose Kubernetes Updating docker Build your image Troubleshooting
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
Top