How to Set Up and Enable GPS Info Feature

Modified on Tue, 20 Jan at 9:40 AM

Starting from Kimai Mobile version 1.3.19, we introduced the GPS Info feature, a Kimai plugin that enables GPS location tracking for timesheet entries. When enabled, the app automatically captures user's device's GPS coordinates when user start or stop a timer, or when user create a new timesheet entry. This location data is then stored on your Kimai server and can be viewed on an interactive map.


Important: This feature is only available for enterprise license users. It is not available for licenses purchased through the Google Play Store or Apple App Store.


Note: this feature requires you to install an additional plugin in your Kimai server instance.


Install Kimai Mobile GPS Info Plugin

  1. Download the latest release of the Kimai Mobile Setup plugin: https://github.com/cloudrizon/kimai-mobile-gps-info-bundle/releases
  2. Extract the KimaiMobileGPSInfoBundle_vx.x.x.zip file and place the KimaiMobileSetupBundle folder in the var/plugins/ directory of your Kimai server instance.
  3. Reload your Kimai instance cache system. Please refer to the documentation: https://www.kimai.org/documentation/cache.html
  4. Verify the installation by navigating to System > Plugins, and check if "Kimai Mobile GPS Info Plugin" is listed on the installed plugins list.

Plugin Configuration in Kimai Server

GPS tracking requires both global and user-level settings to be enabled before it will work.


Global GPS Tracking

Go to Admin → Settings → GPS Tracking and enable GPS tracking system-wide. This setting is disabled by default for privacy reasons.


User-Level GPS Tracking

Go to Admin → Users → [Select User] → Preferences to enable or disable GPS tracking for individual users. This setting is enabled by default for new users.


How the settings work together

Both settings must be ON for GPS tracking to work.


Global SettingUser SettingResult
OFFOFFDisabled
OFFONDisabled
ONOFFDisabled
ONONEnabled


Usage in Kimai Mobile App

Once the plugin is installed and configured on your Kimai server, the GPS Info feature works automatically in Kimai Mobile.


How it works

When you start or stop a timer, or create a new timesheet entry, the app will automatically capture your device's current GPS coordinates and send them to your Kimai server along with the timesheet data.


Requirements on your device

  • GPS/Location Services must be enabled on your device
  • Location permission must be granted to the Kimai Mobile app


For more detailed documentation, please check the README file of the plugin repository: https://github.com/cloudrizon/kimai-mobile-gps-info-bundle

Was this article helpful?

That’s Great!

Thank you for your feedback

Sorry! We couldn't be helpful

Thank you for your feedback

Let us know how can we improve this article!

Select at least one of the reasons

Feedback sent

We appreciate your effort and will try to fix the article