kimai / kimai

Kimai is a web-based multi-user time-tracking application. Works great for everyone: freelancers, companies, organizations - everyone can track their times, generate reports, create invoices and do so much more. SaaS version available at https://www.kimai.cloud

Kimai - time-tracker

Kimai is a professional grade time-tracking application, free and open-source. It handles use-cases of freelancers as well as companies with dozens or hundreds of users. Kimai was build to track your project times and ships with many advanced features, including but not limited to:

JSON API, invoicing, data exports, multi-timer and punch-in punch-out mode, tagging, multi-user - multi-timezones - multi-language (over 30 translations existing!), authentication via SAML/LDAP/Database, two-factor authentication (2FA) with TOTP, customizable role and team permissions, responsive design, user/customer/project specific rates, advanced search & filtering, money and time budgets, advanced reporting, support for plugins and so much more.

Versions

There are two versions of Kimai existing:

• Version 2 — the current stable release (PHP 8.1+)
• Version 1 — EOL since mid of 2023 (PHP 7.4)

Do NOT use Version 1, it won't get any more updates!

Links

• Home — Kimai project homepage
• Blog — Read the latest news
• Documentation — Learn how to use Kimai

Requirements

• PHP 8.1.3 minimum
• MariaDB or MySQL
• A webserver and subdomain (subdirectory is not supported)
• PHP extensions: gd, intl, json, mbstring, pdo, tokenizer, xml, xsl, zip

Support for PHP 8.2 and 8.3.

Installation

• Native setup — with Git and Composer
• Docker — containerized by @tobybatch

There are also documentations for:

• developer setups — on your local machine
• shared hostings — the least favorable option
• Synology — you could try to host the Docker version instead
• 1-click installer — hosted environments

And if you don't want to host Kimai, you can use the Cloud version of it.

Updating Kimai

• Update Kimai — get the latest version
• UPGRADING guide — version specific steps

Plugins

• Plugin marketplace — find existing plugins here
• Developer documentation — how to create a plugin

Roadmap and releases

You can see a rough development roadmap in the Milestones sections. It is open for changes and input from the community, your ideas and questions are welcome.

Release versions will be created on a regular basis, every couple of weeks latest. Every code change, whether it's a new feature or a bugfix, will be done on the main branch.

Contributing

You want to contribute to this repository? This is so great! The best way to start is to open a new issue for bugs or feature requests or a discussion for questions, support and such.

In case you want to contribute, but you wouldn't know how, here are some suggestions:

• Spread the word: Please [write a testimonial for our Wall of love]{https://love.kimai.org}, vote for Kimai on any software platform, you can toot or tweet about it, share it on LinkedIn, Reddit and any other social media platform!
• Answer questions: You know the answer to another user's problem? Share your knowledge.
• Something can be done better? An essential feature is missing? Create a feature request.
• Report bugs makes Kimai better for everyone.
• You don't have to be programmer, the documentation and translation could always use some attention.
• Sponsor the project: free software costs money to create!

There is one simple rule in our "Code of conduct": Don't be an ass!

Credits

Kimai is based on modern technologies and frameworks such as PHP, Symfony and Doctrine, Bootstrap and Tabler, and countless others.

kimai's Issues

Do not show hidden Activities

• hide in recent activities navbar
• hide in "create timesheet" form
• hide in "edit timesheet" form, unless it is currently assigned

Change to users language after login

The original idea was to respect user language after login, which could result in a redirect to another language after seeing the login form.

I decided to remove the language setting completely from the users profile instead.
Kimai uses the http header and URL routing to choose the display language.
I don't want to work around the RedirectToPreferredLocaleListener which is working perfectly with the browsers language setting.

If a user still wants to switch the language its possible through the control sidebar. And to go even a step further: browser support bookmarks ^^ and the user can add /de or /en to his bookmarks.

Disallow login for inactive user

• check on login if User isActive()

Add Timesheet Voter

• add a Voter class for Timesheet entries
• use the Voter on the existing Timesheet Controller
• use the Voter on the existing Admin Timesheet Controller

Add filter to Customer admin

• page size
• filter by Visibility

Add configurable system configuration

• database to store system specific key-value configurations
• settings need a name, value, type
• defaults will be stored in config model
• fetch settings with an event, so modules can extend them
• admin section to change the settings
• add setting: color scheme
• add setting: migrate from twig.globals.kimai_context

Edit users role

• add select box to user profile
• make sure only admins can change the users role

Delete Project

• add function to fetch project statistics
• use is_granted('delete', entry) twig function for delete action button
• show warning (including the statistics) form if a project owns time-records
• only admin can delete projects

Add basic security Voter

• for Customer and usage in Admin\CustomerController
• for Project and usage in Admin\ProjectController
• for Activity and usage in Admin\ActivityController

Translate LanguageType choices

Currently the choices for the LanguageType form type are using the \Locale::getDefault().
Use the current locale instead.

Using the %locale% as argument from services.yaml doesn't work, as it contains the default locale.

Add filter to Timesheet admin

• add toolbar from #11

Add toolbar to filter user screen

• add toolbar to user screen
• add filter for user state (active, inactive)
• add filter for users role

Developer improvements

• add basic phpcs support
• cleanup current phpcs problems
• add basic phpunit support
• add command for "kimai:install" which performs all the basic boostrapping for a fresh install
• add command for "kimai:dev:reset" which cleans the cache, resets the database and loads the fixtures

Upgrade to latest Avanzu version

Switch to using the master of https://github.com/avanzu/AdminThemeBundle/ including the 2.x branch.

Delete Customer

• add function to fetch statistics by customer 
• use is_granted('delete', entry) twig function for delete action button
• show warning (including the customer statistics) form if a customer owns time-records
• only admins can delete projects

Delete activity

• use is_granted('delete', entry) twig function to check if delete is possible
• add function to fetch activity statistics
• show warning before before deleting if any time-record is attached (including activity statistics)
• only admin can delete activity

Translate dashboard widgets

• all dashboard widgets should be translated

Add filter to Timesheet (user)

• change page size
• filter by Customer
• filter by Project
• filter by Activity
• filter by all / running / stopped

Add edit Timesheet entry for Teamleads

• add new form to edit other users time recordings
• use Timesheet voter for security
• allow to switch the user on the record

Add filter to Activity admin

• page size
• filter by Customer
• filter by Project
• filter by Visibility

AdminLTE login screen

• use AdminLTE login layout
• cleanup bootstrap ressources

Support composer create-project

Add a working packages.json, see https://github.com/symfony/demo/blob/master/package.json

Support app.json for heroku deployments

Example:

{
    "name": "Kimai v2",
    "description": "The reloaded Kimai Time-tracking application",
    "keywords": [
        "php",
        "kimai"
    ],
    "website": "https://www.kimai.org.com/",
    "repository": "https://github.com/kevinpapst/kimai2",
    "logo": "",
    "success_url": "/",
    "scripts": {
        "postdeploy": "php bin/console doctrine:schema:create && php bin/console doctrine:fixtures:load -n"
    },
    "env": {
        "SYMFONY_ENV": "prod",
        "SYMFONY_SECRET": {
            "description": "Extra entropy for %kernel.secret%; used for CSRF tokens, cookies and signed URLs.",
            "generator": "secret"
        }
    },
    "addons": [
        "heroku-postgresql"
    ],
    "image": "heroku/php"
}

For more information see:

• https://github.com/symfony/demo/blob/master/app.json
• https://devcenter.heroku.com/articles/app-json-schema

Add filter to Project admin

• page size
• filter by Customer
• filter by Visibility

Add english translation

• AvanzuAdminTheme
• flashmessages
• exceptions
• messages
• validation

Add user settings

• add database to store user specific key-value settings
• defaults will be stored in model
• fetch by using an event, to allow bundles to add settings
• the form to render uses the dynamically configured UserPreferences for rendering and validation
• only users should be able to change these settings, so add a tab to the control_sidebar for handling these settings

Base class for repository and query objects

• add base class for all repository Query classes
• add base class for all Repositories

Reason:
Prevent code duplication and remove already existing one

Add "create timesheet record" form

• add form to create new timesheet records
• default start time is now
• link navbar button to form
• add action button to users timesheet

Display user avatar in navbar

• use avatar widget/twig function in navbar
• use avatar widget/twig function in profile fly-out

Do not show hidden Projects

• hide in "new activity" form
• hide in "edit activity" form, unless it is currently assigned

Teamlead can see all user times

• rename to from /admin/timsheet to /team/timesheet
• teamlead can access admin timesheet

Add "create activity" functionality

• new form to add a activity
• only allow ADMIN to perform the action

Add audit logs

Add automated audit logs

For example:

• https://github.com/DamienHarper/DoctrineAuditBundle

Probably outdated:

• https://github.com/simplethings/EntityAuditBundle
• https://github.com/xiidea/EasyAuditBundle
• https://github.com/DATA-DOG/DataDogAuditBundle

Add remember me login

• activate checkbox in login screen

• support remember me functionality (see symfony docu)

• menu items are (depending on the users role) visible, but opening the admin screens leads to log-in

• own timesheet entries can be worked on, except for deleting

• Check token_provider (default value: null)

Defines the service id of a token provider to use. By default, tokens are stored in a cookie. For example, you might want to store the token in a database, to not have a (hashed) version of the password in a cookie. The DoctrineBridge comes with a Symfony\Bridge\Doctrine\Security\RememberMe\DoctrineTokenProvider that you can use.

Add console command to create user

• Add a new console command to create a user with the most important fields:
• username
• email
• password
• language (optional)
• role (optional)
• validate user before inserting

Reason for this feature request:
This is requested, so people can install Kimai properly, as long as there is no installer

Add "create user" functionality

• new form to add a user
• only allow SUPER_ADMIN to perform the action

Do not show hidden Customer

• in "create project form"
• in "edit project form" unless the customer is the selected one

Fix Doctrine extensions config loader

• Remove DATABASE_ENGINE from .env.dist and read it from the DATABASE_URL
• fix DoctrineCompilerPass in Kernel.php

Add preferences sidebar

• enable configurable sidebar via twig config

Possible contents:

• language switcher
• a tab pane for Kimai announcements (currently static)

Upgrade to Symfony 4 and Flex

Follow the guides:

• http://symfony.com/doc/current/setup/flex.html#upgrade-to-flex
• https://symfony.com/doc/current/setup.html

Add installation docu

• document the kimai:install command
• document the kimai:dev:reset command
• document development install
• document production install
   

Show revenue only for Admin (wrong currency shown)

• Currently the Dashboard statistic widget uses the money filter and threfore always displays the default currency
• The user profile shows two money fields

Intermediate solution:

• Display all values without currency
• All widgets/values should only be visible for ROLE_ADMIN

Delete other users timesheet entries

Delete timesheet entries for other users:

• use is_granted('delete', entry) twig function to check if delete is possible
• add action to admin controller
• admin can delete all user entries
• teamleads can stop all user entries

Delete timesheet entries

Delete own timesheet entries:

• use is_granted('delete', entry) twig function to check if delete is possible
• add action to users timesheet controller
• only user can delete their own entries
• admin can delete other user entries

Roles should become a real table

• change the roles table to be a real linked table from the User entity
• adjust entity methods
• adjust findByQuery method
• add default join to always fetch roles

Add role SUPER_ADMIN

• add a user with the role ROLE_SUPER_ADMIN to LoadFixtures
• The new role is the only one to access the admin controller "edit users"

The normal ADMIN role should be used to configure Customers, Projects and Actvities.

Hide inactive delete user button

As deleting a user is an expensive task (also unclear what should happen with his time logs) and not yet implemented, hide the delete user button for now.

Rename Timesheet query class

• rename from Query\Timesheet to Query\TimesheetQuery
• extend from BaseQuery

Add "create project" functionality

• new form to add a project
• only allow ADMIN to perform the action

Add "create customer" functionality

• new form to add a customer
• only allow ADMIN to perform the action