Custom content

9 € (excl. VAT)

License and purchase details

Table of contents

Features
Purchase
Screenshots
Installation
Updates

Offered by

Kevin Papst

Freelancer, PHP professional and Kimai maintainer since 2007

If you have any question, visit the developers homepage or use the email for direct contact .

Try it

You can test this plugin at https://demo-plugins.kimai.org:

Username: susan_super
Password: kitten

Find more test accounts here.

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

Buy now

Full documentation available in the documentation.

You can test the Plugin in the Plugin demo.

Features

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

Permissions

Permission Name	Description
edit_custom_content	show the “custom content” administration screen

By default, these are assigned to each user with the role ROLE_SUPER_ADMIN.

Read how to assign these permissions to your user roles in the permission documentation.

Custom CSS plugin

If you only want to add some custom stylesheets, you can have a look at the free Custom CSS plugin.

Purchase

Buy now

You can buy this item from the developer with a regular EU-invoice or via Gumroad (platform for selling digital goods). Please create an account during your purchase to receive software updates. Read more about the license and purchase options.

Every customer gets free access to a private GitHub repository (like a forum) for support and access to the latest updates. Sent your GitHub username and your purchase receipt to kevin@kevinpapst.de and you will receive an invitation soon!

Screenshots

Warning message

The warning message is displayed on every page for logged-in users (fullscreen)

Javascript

The javascript is executed on every page for logged- in users (fullscreen)

Warning message

You can enter a markdown formatted news with a title (fullscreen)

News page

The news page is linked in the user menu and displays your markdown message (fullscreen)

Installation

Compatibility

Plugins should always be compatible with higher Kimai versions, the following list contains the plugin version and the required minimum Kimai version.

Bundle version	Minimum Kimai version
1.0 - 1.2.1	1.17

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/

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