Kimai Kimai – Docs

Select chapter
User manual Developer Self-hosted
  • User manual
  • Developer
  • Self-hosted
Select chapter
User manual Developer Self-hosted

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

Tips and Tricks

Articles that explain basic functionality in Kimai

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

Additional features

User documentation for features provided by (paid) plugins

Custom fields Expenses Custom CSS Custom content Translation Invoice Importer Audit trail logs

REST 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 Marketplace Migrate plugins to v2

Technical background

Background info and technical correlations

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

Installation & Updates

Everything you need to host your Kimai on your own server

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

DevOps

Manage and configure your Kimai installation

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

Authenticator

Log in to Kimai using external identity provider

LDAP SAML Azure SAML Google SAML Keycloak SAML Authentik SAML
  • Home
  • Site notice
  • Privacy policy
  • Made by Kevin Papst