User manual

Use Kimai, the UI and all the available features

Timesheet Weekly working hours Calendar Invoices Export Reporting Customer Projects Activities Tags Users User preferences Roles & Permissions Teams Settings

Tips & Tricks

Articles that explain basic functionality in Kimai

Initial setup Rates Billable Switch to AM/PM Duration format

Self-hosted

Everything you need to host your Kimai on your own server

Installation Updates Docker Reloading cache Webserver configuration LDAP SAML Backups Importing data Configuration files Dashboard Emails Logging Upgrade to Kimai 2 from v1 Install Kimai on Ubuntu 18.04 Install Kimai on Ubuntu 20.04 Install Kimai on a Synology NAS Using Redis for caching Commands

Developer

Extending Kimai, plugin development and translations

Developers Rest API Plugins Bughunter Translations / i18n Custom fields Theme Permission structure Impersonate a user The Marketplace Creating a release

Plugins

Documentation for plugins

Custom fields Expenses Custom CSS Custom content Translation Invoice

FAQ - Frequently asked questions

I have a problem

Please check your logfile at var/log/prod.log. Many problems reveal themselves after checking it.

If that doesn’t help, open a new discussion at GitHub and we try to find a solution. Please include the last ~ 20-50 lines of the log file, which were written around the time the error happened.

Kimai is slow

There are many factors that influence the performance of Kimai, the most important one is the server Kimai runs on. Shared hosts aren’t known for their good performance, especially running modern PHP projects like Kimai that load a large amount of files per request.

The second factor is your PHP configuration, which can lead to massively decreased performance when not tuned for production usage.

Please read this issue.

Recorded times are wrong

Please read the user preferences documentation especially the part about timezones.

Don’t mix it up with the system specific configuration for new customers.

Changed configs/templates do not load

Kimai is built on top of Symfony, a framework that optimizes its speed by caching most files. Therefor, if you are running Kimai in production, you have to clear the cache before changes will show up.

I have only FTP available

Sorry, no chance. You either have to find a hoster that offers SSH access, or you use the SaaS version of Kimai.

Dotenv::populate() must be an instance of Symfony\Component\Dotenv\void

If you encounter an error like this:

PHP Fatal error:  Uncaught TypeError: Return value of Symfony\\Component\\Dotenv\\Dotenv::populate() must be an instance of Symfony\\Component\\Dotenv\\void, none returned in /var/www/kimai2/vendor/symfony/dotenv/Dotenv.php:95
Stack trace:
#0 /var/www/kimai2/vendor/symfony/dotenv/Dotenv.php(57): Symfony\\Component\\Dotenv\\Dotenv->populate(Array)
#1 /var/www//kimai2/public/index.php(15): Symfony\\Component\\Dotenv\\Dotenv->load('/var/www/html/k...')
#2 {main}\n  thrown in /var/www/kimai2/vendor/symfony/dotenv/Dotenv.php on line 95

you are running PHP 7.0. Probably you were able to install Kimai, because your PHP-CLI uses a different PHP version than your webserver. Upgrade PHP or change the used PHP version in your webserver, and the error will be gone.

Further questions?

Need help and can’t find what you are looking for? Create a new ticket in the Kimai support forum and ask for help.

Kimai - Documentation