How to Log In with QR Code

Connect your Kimai time tracking software with the Kimai Mobile app using a secure QR code for quick and easy setup.

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

Step 1: Install the Kimai Mobile Setup Plugin*

1. Download the latest release of the Kimai Mobile Setup plugin.
2. Extract the KimaiMobileSetupBundle_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.
4. Verify the installation, a new "Kimai Mobile Setup" page will appear in your Kimai navigation bar (in the browser version).

Step 2: Generate Your API Token

1. Open your Kimai instance in a web browser.
2. Navigate to the "Kimai Mobile Setup" page.
3. Click "Create" to generate a new API token.
4. Enter a descriptive name for your token (e.g., "My Phone" or "Kimai Mobile App").
5. Set expiry date (optional). Please note that you'll need to generate a new token when it expires.
6. Click "Save" to generate your unique QR code.
7. Keep this page open. Don't close or refresh the browser tab during the next step.

Step 3: Connect Your Kimai Mobile App

1. Open the Kimai Mobile app on your device.
2. Tap "Create new workspace".
3. Select the "QR-Code" option to activate your camera.
4. Scan the QR code displayed in your browser.
5. Tap "Log In" once the code is detected (the button will become enabled).
6. Customize your workspace by adding a name and selecting a color.
7. Tap "Create a new workspace" to complete the setup.

Your Kimai Mobile app is now connected and ready to use! The workspace information will be automatically populated from the QR code, ensuring a secure connection to your Kimai server.

Tip: For security purposes, each QR code should only be used once. If you need to set up additional devices, generate a new API token for each one.

* Version Aug. 2025