Custom content

Create custom content for stylesheets, Javascript, a global warning-message and a new page to render markdown content for company news.

Kevin Papst
Offered by
Kevin Papst

A Kimai plugin which allows adding custom content for:

  • Stylesheet (embedded in all pages)
  • Javascript (embedded in all pages, except security screens)
  • A global warning message, shown to every logged-in user
  • An entire new page to display (markdown formatted) information for your users

Alternative

If you only want to add some custom CSS stylesheets, you can have a look at this free item instead: Custom CSS

Storage

This bundle stores contents in the directory var/data/custom-content-bundle/.

Make sure the data directory is writable by your webserver and included in your backups.

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

The file structure needs to look like this afterwards:

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

You might not need these commands in a shared-hosting environment. And you probably need to prefix them with sudo and/or the group might be called different from www-data.

Updates

Updating the plugin works exactly like the installation:

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

Changelog

Version 2.3.2

Compatibility: requires minimum Kimai 2.5.0

  • Refactoring: do not register Entity directory as service

Version 2.3.1

Compatibility: requires minimum Kimai 2.5.0

  • Changed: import Route attribute from correct namespace
  • Changed: use bundle identifier to load routes

Version 2.3.0

Compatibility: requires minimum Kimai 2.5.0

Changed: moved some translations to core, allowing more languages

Version 2.2.0

Compatibility: requires minimum Kimai 2.1.0

  • Fixed: route mapping type changed to attribute
  • Fixed code-sniffer deprecation

Version 2.1.1

Compatibility: requires minimum Kimai 2.0.0

Added: explicit ID and class to target markdown news content via Javascript

Version 2.1.0

Compatibility: requires minimum Kimai 2.0.0

Added: new permissions - js_custom_content, css_custom_content, alert_custom_content, news_custom_content Added: better tabs

Demo

You can test this plugin at demo.kimai.org:

Username: susan_super
Password: password

Find more test accounts here.

Screenshots

Screenshot
The warning message is displayed on every page for logged-in users
Screenshot
The Javascript is executed on every page for logged-in users
Screenshot
You can enter a markdown-formatted news with a title
Screenshot
The news page is linked in the user menu and displays your markdown message

FAQ

These FAQs are provided by the developer of this offer.

You can buy the plugin via the Marketplaces 'Lemon Squeezy' or 'Gumroad' and pay with Credit Card or PayPal. Both offer instant access to the purchases.

Support-questions, bug-reports and feature-requests will be answered in this Github repository

Offered by

Kevin Papst

Building Kimai since 2009

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