free

Pricing for this item
Logo - HMR-IT GmbH

HMR-IT GmbH

Software development company from Germany

A plugin for Kimai 2 which shows you all entries without a description + email notification for users to ask them to add a description.
Last update: 14 Sep 2019

A plugin for Kimai 2 which shows you all entries without a description + email notification for users to ask them to add a description.

Installation, Usage, and so on

Documentation of this plugin

Changelog

Changelog of this plugin

Feature requests + bug reports

Issue tracker

Screenshots

Installation

Copy files

Extract the ZIP file and upload the included directory and all files to your Kimai installation to the new directory:

var/plugins/EmptyDescriptionCheckerBundle/

Or you can clone it directly to the var/plugins/ directory of your Kimai installation:

cd kimai/var/plugins/
git clone https://gitlab.com/hmr-it/kimai2plugins/EmptyDescriptionCheckerBundle.git

The file structure needs to like like this afterwards:

var/plugins/
├── EmptyDescriptionCheckerBundle
│   ├── EmptyDescriptionCheckerBundle.php
|   └ ... more files and directories follow here ...

Clear cache

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:

How to reload Kimai 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

You might have to set file permissions afterwards:

Fix Kimai file permission

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 www-data.

Updates

Updating the plugin works exactly like the installation:

  • Delete the directory var/plugins/EmptyDescriptionCheckerBundle/
  • Execute all installation steps again:
    • Copy files
    • Clear cache