After the installation a new menu entry
EasyBackup is created. There you can create a new backup
by clicking the
Create Backup button. Afterwards all created backups will be listed at the page
and you can delete or download the created backup as zip file.
Please contact me via email@example.com for any inquiry.
This bundle stores the backups zipped in the directory
Make sure its writable by your webserver! We don’t use the recommended
var/data/ directory, because it will be part of the backup’ed files!
Currently these directories and files are included in the backup:
.env config/packages/local.yaml var/data/ var/plugins/
According to the backup docu the kimai version should be saved to. Also the current git head. Therefor a Readme.txt file with the mentioned information is written and added to the backup.
If you use sqlite, the database file is backuped because the
var/data directory will be backuped by the plugin.
If you use mysql/mariadb the plugin will recognize it by reading the configured database connection url. Then it will execute a mysqldump command and create a sql dump file which will be added to the backup zip.
Please note: Currently the mysqldump command is used as
/usr/bin/mysqldump. This will only work on systems where
mysqldump is available at this location. I will change it later on, but this should work on most environments.
If anyone will help me with testing or contributing it would be great.
Extract the ZIP file and upload the included directory and all files to your Kimai installation to the new directory:
Or you can clone it directly to the
var/plugins/ directory of your Kimai installation:
The file structure needs to like like this afterwards:
After uploading the files, Kimai needs to know about the new plugin. It will be found once the cache was re-built. Call these commands from the Kimai directory:
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:
You might have to set file permissions afterwards:
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):
Test Kimai before executing these commands (they are likely not required in a shared-hosting environment).
You probably need to prefix them with
the group might be called different than
Updating the plugin works exactly like the installation: