Kimai via FTP

WARNING: Do not use FTP because it is simpler to install, it will likely cause problems in the long run!

The recommended way to install Kimai v2 is via SSH.

FTP is not recommended, because most of Kimai’s management tasks rely on the console. There are workaournds available, see below, but they are not as reliable as SSH access.

FTP installation

If you have no SSH access to your server (e.g. when you use a shared hosting package) then you can download a package, which includes a pre-installed Kimai version.

You install it via FTP like this:

  • download the latest release package for FTP
  • extract it locally and upload all files
  • point your domain (document root) to the public/ directory
  • register your first user in the login screen, you will automatically become SUPER_ADMIN

The file var/data/kimai.sqlite will hold all your data, please include it in your backups.

Clear cache

When working with configuration files you cannot run the normally commands to clear the cache.

The workaround is to delete the cache directory var/cache/prod/ manually. If possible, use your hoster Management UI. They tend to be must faster and more reliable than using your regular FTP software.

Kimai will re-create a fresh cache when you open it again in your browser.

Make sure that you don’t open a Kimai while you are deleting the cache!

FTP updates

Unfortunately there is no built-in support for updates yet. This feature will hopefully be included in the future.

The problem is, that there is currently no support for upgrading your database automatically. You can only do it manually and please don’t expect support for that method. You have been warned!

Manual update

Currently the way to upgrade Kimai via FTP includes several manual steps:

  • Install Kimai via GIT locally
  • Download the SQLite database from your server to your local Kimai installation
    • Configure your local Kimai to use this SQLite database
  • Execute the update as documented
  • Backup/Rename/Delete your FTP installation
  • Install the latest FTP package
  • Upload the locally upgraded SQLite database to your new FTP installation
    • Add .env, local.yaml and other adjusted files back to this new installation
    • Clear your cache