Kimai - Open Source time-tracker Kimai
Installation Start for free

Small-business regulations

A plugin to use the small-business regulation, as it can be applied in Germany and Austria, when creating invoices in Kimai.

Alexander Pankow EDV-Dienstleistungen
Offered by
Alexander Pankow EDV-Dienstleistungen

This plugin provides the ability to use the small business regulation, as it can be applied in Germany and Austria, when creating invoices in Kimai.

More information and documentation can be found on GitHub.

Please note that this plugin requires at least Kimai v1.24.0.

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/SmallBusinessRuleBundle/

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

cd kimai/var/plugins/
git clone https://github.com/LiaraAlis/kimai2-SmallBusinessRuleBundle.git SmallBusinessRuleBundle

The file structure needs to look like this afterwards:

var/plugins/
├── SmallBusinessRuleBundle
│   ├── SmallBusinessRuleBundle.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

It is not advised, but in case the above command fails you could try:

rm -r var/cache/prod/*

You might have to set file permissions afterwards:

Adjust 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/
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/SmallBusinessRuleBundle/
  • Execute all installation steps again:
    • Copy files
    • Clear cache

Compatibility

The following table contains a comparison between plugin and required minimum Kimai version.

Bundle version Minimum Kimai version
1.0 1.24.0
2.0 2.0.0
Offered by

Alexander Pankow EDV-Dienstleistungen

Web developer

If you have any question, please use the following contact information to get in touch with the developer directly.
Homepage Email GitHub
Twitter
Top