You have to backup the following files:
The following stuff needs attention as well, backup if necessary:
Write down the exact version of your Kimai installation:
git rev-parse HEAD
Here is a one liner that creates a database backup for MySQL/MariaDB (adjust connection to your needs):
mysqldump --single-transaction -u kimai2 -p -h 127.0.0.1 kimai2 > ~/kimai2-`date +%F_%H-%M`.sql
Or with SQLite
cp var/data/kimai.sqlite ~/kimai2-`date +%F_%H-%M`.sqllite
.envto your imported database
Now refresh your cache:
bin/console kimai:reload --env=prod
FTP users: please have a look at this documentation.
If you are running an older version of Kimai (before 1.8) you have to use:
bin/console cache:clear --env=prod bin/console cache:warmup --env=prod
At this step: test Kimai again and don’t proceed before it works as expected!
Working properly? If not, check your file permissions:
You have to allow PHP (your webserver process) to write to
var/ and it subdirectories.
Here is an example for Debian/Ubuntu (to be executed inside the Kimai directory):
chown -R :www-data . chmod -R g+r . chmod -R g+rw var/ chmod -R g+rw public/avatars/
Test Kimai before executing these commands (they are likely not required in a shared-hosting environment).
You probably need to prefix them with
sudo and the group might be called different than
Working now? Fine, then go ahead and restore all other files:
Still not satisfied and want to upgrade to the latest version?
Great! Make sure you have the
migration_versions table in your database backup,
before you upgrade. If not, execute
bin/console doctrine:migrations:version --add --all
beforehand and read the installation docs again,
if you might have missed other points as well.
Now you can upgrade :-)
You restored Kimai (as documented above), but have problems when accessing it?
Maybe you have missed an upgrade steps, which you would have done when executing a normal upgrade.
Please check the UPGRADING guide and make sure you executed all version specific tasks.
If Kimai will not load properly (e.g. you only see a white screen, maybe some pages work) the database could be the reason. This problem can happen when you install a different (newer) version that has a different database structure then your backup.
Check your database if you have the
migration_versions table. If not, go back to “Restore”.
If so: try to execute the missing database migrations with
bin/console kimai:update -n.
You see an error when executing
This problem can happen when a configuration change is necessary in your
Please check the UPGRADING guide.