Kimai is an open source PHP based time tracking system released under the GNU GPL.
This document describes:
Kimai is accessed through a web browser. Kimai supports the following web browsers:
Kimai requires a web server with a PHP environment and a database. The minimum system requirements for running Kimai are:
mysqli
, iconv
and xml
The following requirements must be met on the server installation:
Kimai works with MySQL in the above mentioned versions. It will also work on compatible “drop-in” replacements like MariaDB or Percona.
The MySQL user needs a least the following privileges on the Kimai database:
Your PHP needs to support the following extensions. Install will check if these are available.
This is a basic setup for best performance and increased functionality:
/dev/urandom
or /dev/random
on Unix-like platforms for
increased security. Make sure to add /dev/random:/dev/urandom
to
open_basedir
settings if you use it. If these paths are unavailable, Kimai
will attempt to simulate random number generation. This is less secure,
reduces performance and throws out warnings in the Kimai log.If you have SSH access to your webserver, this is the recommended way of setting up Kimai:
Uncompress the zip file on the Document root of your web-server:
cd /var/www/
mkdir kimai
cd kimai
wget https://github.com/kimai/kimai1/releases/download/1.2.2/kimai_1.2.2.zip
unzip kimai_1.2.2.zip
Replace 1.2.2 with the latest available release TAG
Important: If you use GIT to fetch the sources, use the following command:
cd /var/www/
git clone https://github.com/kimai/kimai1.git
git fetch
git checkout 1.2.2
Replace 1.2.2 with the latest available release TAG
In case you only have FTP or SFTP access to your hosting environment, you can still install Kimai, but you won’t easily be able to upgrade your installation once a new release is out.
Please note that this is not a recommended setup!
kimai.zip
locallyincludes/autoconf.php
extensions/ki_invoice/invoices/
extensions/
Now access the web server using a web browser. You will be redirected to the Installer which will walk you through the steps for setting up Kimai for the first time.
It will check if your environment conforms to the minimum system requirements and gives you some suggestions on what to change in case there are any discrepancies.
install
directory after the installationupdater
directory after the installationsudo apt-get install php-xml
Extract the Kimai release zip/tarball into a server directory accessible from the outside and navigate to this location using your browser. A step-by-step installation program is included with every new release of Kimai. Follow the instructions of the installer and correct missing or incorrect permissions using your FTP or shell account. If the step-by-step installer does not work, please report this error.
Kimai v1 can be installed with theS oftaculous Auto-Installer.
Get more information at http://www.softaculous.com/softaculous/apps/others/Kimai
After you removed the “install” directory you may login into Kimai using the following credentials:
Change the administrator password using the settings dialog. Keeping “changeme” as your password is a major security implication!
If you are using Apache web server, check the Apache error log for specifics on the error. The cause might be some missing module, or some syntax error in your .htaccess file. The error log is usually located in /var/log/apache2 or /var/log/httpd. Check with your hosting provider if you are in doubt where the logs are located.