Documentation

User Guide

Kimai user manual, explaining the UI and all available screens

Timesheet Weekly hours Calendar Invoices Export Reporting Customer Projects Activities Tags Users User preferences Working times Absence Dashboard Expenses Tasks Invoice+ Customer Portal

Admin Guide

Kimai user manual, explaining the UI and all available screens

Roles & Permissions Teams Public holiday Settings Custom fields Kiosk mode Audit logs Custom CSS Custom content Translation Doctor Importer

Advanced Topics

Articles that explain basic functionality in Kimai

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

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 User licenses Change the cloud domain Migration to the cloud Plan change Plugins Supported countries

Delete & Cancel

Answers to frequent questions about Kimai Cloud

Data removal Please cancel my trial account

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 & Proxy 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

Plugins

Plugin functionality available to onpremise installations

FAQ - Downloads, Subscriptions, and Refunds LemonSqueezy Invoices Working contract

JSON API

Use the JSON API to fetch and create data in Kimai

Kimai API Pagination

API Examples

Real world examples of using the Kimai API

Importing a CSV file jQuery Demo Sync to a local DB Onboarding users

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

Security advisories Permission structure SQL Examples Using Redis for caching

Kimai - Documentation