Kimai

https://www.kimai.org/documentation
Admin
Kimai is a modern, open-source time tracking application for managing timesheets, projects,...
Tokens:157,707
Snippets:1,549
Trust Score:9.8
Update:1 month ago
Show doc for...
Tokens:
Raw
### Install Kimai

Source: https://www.kimai.org/documentation/shared-hosting.html

Run the Kimai installation command.

```bash
php bin/console kimai:install -n
```

--------------------------------

### Start Database Container

Source: https://www.kimai.org/documentation/developers.html

Starts a MySQL database container for Kimai development.

```bash
 docker run --rm --name kimai-mysql-dev \
     -e MYSQL_DATABASE=kimai \
     -e MYSQL_USER=kimai \
     -e MYSQL_PASSWORD=kimai \
     -e MYSQL_ROOT_PASSWORD=kimai \
     -p 3457:3306 -d mysql
```

--------------------------------

### Domainfactory PHP 8.1.5 CLI commands

Source: https://www.kimai.org/documentation/shared-hosting.html

Examples for installing composer and running Kimai commands using the php8.1.5-cli binary.

```bash
curl -sS https://getcomposer.org/installer | php8.1.5-cli
```

```bash
php8.1.5-cli composer.phar install --no-dev --optimize-autoloader
```

```bash
php8.1.5-cli bin/console kimai:install -n
```

--------------------------------

### Start the Kimai application container

Source: https://www.kimai.org/documentation/docker.html

Starts the Kimai container and connects it to the previously initialized database.

```bash
 docker run --rm --name kimai-test \
     -d \
     -ti \
     -p 8001:8001 \
     -e APP_ENV="prod" \
     -e DATABASE_URL="mysql://kimai:kimai@host.docker.internal:3456/kimai?charset=utf8mb4&serverVersion=9.5.0" \
     kimai/kimai2:apache
```

--------------------------------

### Install base software packages

Source: https://www.kimai.org/documentation/fresh-ubuntu-20.html

Updates the system and installs essential utilities, MariaDB, and Nginx.

```bash
apt update
apt upgrade
apt install git unzip curl vim
apt install mariadb-server mariadb-client
apt install nginx
```

--------------------------------

### Install and configure Certbot for SSL

Source: https://www.kimai.org/documentation/fresh-ubuntu-22.html

Install Certbot and the Nginx plugin, then run the interactive setup to obtain an SSL certificate.

```bash
apt-get install certbot python3-certbot-nginx
certbot --nginx
```

--------------------------------

### Finalize Composer installation

Source: https://www.kimai.org/documentation/fresh-ubuntu-22.html

Run the installer, clean up the setup file, and move the composer binary to the system path.

```bash
php composer-setup.php
php -r "unlink('composer-setup.php');"
chmod +x composer.phar
mv composer.phar /usr/bin/composer
```

--------------------------------

### Run Kimai installation and create admin

Source: https://www.kimai.org/documentation/fresh-ubuntu-22.html

Execute the Kimai installation script and create the initial super administrator account.

```bash
bin/console kimai:install -n
bin/console kimai:user:create admin admin@example.com ROLE_SUPER_ADMIN
```

--------------------------------

### Install Frontend Dependencies

Source: https://www.kimai.org/documentation/developers.html

Install the required frontend dependencies using PNPM.

```bash
pnpm install
```

--------------------------------

### Clone and Install Kimai

Source: https://www.kimai.org/documentation/fresh-ubuntu-18.html

Clones the repository, sets permissions, installs dependencies, and opens the .env file for configuration.

```bash
cd /var/www/
git clone -b 2.65.0 --depth 1 https://github.com/kimai/kimai.git
cd kimai/
chown -R :www-data .
chmod -R g+r .
chmod -R g+rw var/
composer install --no-dev --optimize-autoloader
vim .env
```

--------------------------------

### Ionos PHP 8.1 CLI commands

Source: https://www.kimai.org/documentation/shared-hosting.html

Examples for running composer and the Kimai installer using a specific PHP 8.1 CLI path.

```bash
/usr/bin/php8.1-cli composer.phar install --no-dev --optimize-autoloader
```

```bash
/usr/bin/php8.1-cli bin/console kimai:install -n
```

--------------------------------

### Install dependencies on HostEurope

Source: https://www.kimai.org/documentation/shared-hosting.html

Install PHP dependencies using the standard PHP binary.

```bash
php composer.phar install --no-dev --optimize-autoloader
```

--------------------------------

### Install software stack

Source: https://www.kimai.org/documentation/fresh-ubuntu-18.html

Update package lists and install PHP, MySQL, Nginx, and utility tools.

```bash
apt-get update
apt-get install php-fpm php-cli php-common php-json php-opcache php-readline php-xml php-zip php-intl php-gd php-mbstring php-mysql php-curl
apt-get install mysql-server mysql-client
apt-get install nginx
apt-get install git unzip curl
```

--------------------------------

### Install Composer

Source: https://www.kimai.org/documentation/shared-hosting.html

Download and install the Composer dependency manager.

```bash
curl -sS https://getcomposer.org/installer | /usr/bin/php
```

--------------------------------

### Install PHP 8.3

Source: https://www.kimai.org/documentation/fresh-ubuntu-22.html

Install PHP 8.3 and the required extensions for Kimai.

```bash
apt-get install php8.3 php8.3-curl php8.3-fpm php8.3-gd php8.3-intl php8.3-mbstring php8.3-mysql php8.3-opcache php8.3-xml php8.3-zip
```

--------------------------------

### Install system dependencies

Source: https://www.kimai.org/documentation/fresh-ubuntu-22.html

Update the system and install essential packages including git, unzip, curl, vim, MariaDB, and Nginx.

```bash
apt-get update
apt-get upgrade
apt-get install git unzip curl vim mariadb-server mariadb-client nginx
apt-get install software-properties-common
```

--------------------------------

### Start Kimai Container

Source: https://www.kimai.org/documentation/developers.html

Starts the Kimai application container configured for the development environment.

```bash
 docker run --rm --name kimai-dev \
     -d \
     -ti \
     -p 8001:8001 \
     -e APP_ENV="dev" \
     -e DATABASE_URL="mysql://kimai:kimai@host.docker.internal:3457/kimai?charset=utf8mb4&serverVersion=9.5.0" \
     kimai/kimai2:dev
```

--------------------------------

### SAML Role Mapping Example

Source: https://www.kimai.org/documentation/saml-keycloak.html

A working example showing the mapping between SAML roles and Kimai roles.

```text
{ saml: Admins, kimai: ROLE_SUPER_ADMIN }
{ saml: Management, kimai: ROLE_ADMIN }
{ saml: Teamlead, kimai: ROLE_TEAMLEAD }
```

--------------------------------

### Run Kimai Installer

Source: https://www.kimai.org/documentation/installation.html

Execute the Kimai installer script. You may need to prefix this command with your PHP executable path.

```bash
bin/console kimai:install -n
```

--------------------------------

### Start Symfony Web Server

Source: https://www.kimai.org/documentation/developers.html

Starts the local Symfony web server on port 8010 to access Kimai.

```bash
symfony serve --port=8010
```

--------------------------------

### Install LDAP library via Composer

Source: https://www.kimai.org/documentation/ldap.html

Run this command to install the required laminas-ldap library for Kimai.

```bash
composer require laminas/laminas-ldap --update-no-dev --optimize-autoloader
```

--------------------------------

### Start Kimai and Caddy with Docker Compose

Source: https://www.kimai.org/documentation/hosting-digital-ocean.html

Use this command to initialize the containers. DNS propagation and SSL certificate generation may cause initial errors, so wait a few minutes before retrying if necessary.

```bash
docker compose up -d
```

--------------------------------

### PHP LDAP extension missing error

Source: https://www.kimai.org/documentation/ldap.html

Example of the error message displayed when the PHP LDAP extension is not installed on the system.

```text
laminas/laminas-ldap requires ext-ldap * -> it is missing from your system. Install or enable PHP's ldap extension.
```

--------------------------------

### Plesk Kimai Installation Commands

Source: https://www.kimai.org/documentation/shared-hosting.html

Commands to install composer, clone the repository, install dependencies, and initialize the database using the Plesk PHP 8.1 path.

```bash
curl -sS https://getcomposer.org/installer | /opt/plesk/php/8.1/bin/php
```

```bash
git clone -b 2.65.0 --depth 1 https://github.com/kimai/kimai.git
```

```bash
cd kimai
```

```bash
/opt/plesk/php/8.1/bin/php ../composer.phar install --no-dev --optimize-autoloader
```

```bash
/opt/plesk/php/8.1/bin/php bin/console kimai:install -n
```

--------------------------------

### Build Development Image with Apache

Source: https://www.kimai.org/documentation/building-docker.html

Example command to build a development image using the Apache bundled web server.

```bash
docker build --target=dev --build-arg KIMAI=2.65.0 --build-arg BASE=apache .
```

--------------------------------

### Full SAML Configuration Example

Source: https://www.kimai.org/documentation/saml-authentik.html

A complete configuration block for Kimai SAML integration with Authentik, including provider, roles, connection, and security settings.

```yaml
kimai:
    saml:
        provider: authentik
        activate: true
        title: Login with SAML
        mapping:
            - { saml: $http://schemas.xmlsoap.org/ws/2005/05/identity/claims/emailaddress, kimai: email }
            - { saml: $http://schemas.xmlsoap.org/ws/2005/05/identity/claims/name, kimai: alias }
        roles:
            resetOnLogin: true
            attribute: http://schemas.xmlsoap.org/claims/Group
            mapping:
                # Insert your roles here (ROLE_USER is added automatically)
                - { saml: admin.group, kimai: ROLE_ADMIN }
        connection:
            # You SAML provider
            # Your Authentik instance, replace https://authentik.company with your authentik URL
            idp:
                entityId: "https://authentik.company/"
                singleSignOnService:
                    url: "https://authentik.company/application/saml/<application-slug>/sso/binding/redirect/"
                    binding: "urn:oasis:names:tc:SAML:2.0:bindings:HTTP-Redirect"
                # the "single logout" feature was not yet tested, if you want to help, please let me know!
                singleLogoutService:
                    url: "https://authentik.company/if/session-end/<application-slug>/"
                    binding: "urn:oasis:names:tc:SAML:2.0:bindings:HTTP-Redirect"
                # Signing certificate from *Advanced protocol settings*
                x509cert: "XXXXXXXXXXXXXXXXXXXXXXXXXXX=="
            # Service Provider Data that we are deploying.
            # Your Kimai instance, replace https://kimai.company with your Kimai URL
            sp:
                entityId: "https://kimai.company/"
                assertionConsumerService:
                    url: "https://kimai.company/auth/saml/acs"
                    binding: "urn:oasis:names:tc:SAML:2.0:bindings:HTTP-POST"
                singleLogoutService:
                    url: "https://kimai.company/auth/saml/logout"
                    binding: "urn:oasis:names:tc:SAML:2.0:bindings:HTTP-Redirect"
                #privateKey: ''
            # only set baseurl, if auto-detection doesn't work
            baseurl: "https://kimai.company/auth/saml/"
            strict: false
            debug: true
            security:
                nameIdEncrypted: false
                authnRequestsSigned: false
                logoutRequestSigned: false
                logoutResponseSigned: false
                wantMessagesSigned: false
                wantAssertionsSigned: false
                wantNameIdEncrypted: false
                requestedAuthnContext: true
                signMetadata: false
                wantXMLValidation: true
                signatureAlgorithm: "http://www.w3.org/2001/04/xmldsig-more#rsa-sha256"
                digestAlgorithm: "http://www.w3.org/2001/04/xmlenc#sha256"
            contactPerson:
                technical:
                    givenName: "Kimai Admin"
                    emailAddress: "admin@example.com"
            organization:
                en:
                    name: "Kimai"
                    displayname: "Kimai"
                    url: "https://kimai.company"
```

--------------------------------

### Install PHP Dependencies

Source: https://www.kimai.org/documentation/installation.html

Install the required PHP dependencies using Composer.

```bash
composer install --no-dev --optimize-autoloader
```

--------------------------------

### Install PHP 8.1

Source: https://www.kimai.org/documentation/fresh-ubuntu-20.html

Installs the required PHP 8.1 modules for Kimai.

```bash
apt install php8.1-cli php8.1-common php8.1-curl php8.1-fpm php8.1-gd php8.1-intl php8.1-mbstring php8.1-mysql php8.1-opcache php8.1-readline php8.1-xml php8.1-zip
```

--------------------------------

### Manitu database connection string

Source: https://www.kimai.org/documentation/shared-hosting.html

Example DATABASE_URL configuration for the .env file on Manitu.

```text
DATABASE_URL=mysql://user:pwd@yourDbServer.manitu.net:3306/YourDbName?charset=utf8mb4&serverVersion=10.11.4-MariaDB-log
```

--------------------------------

### Configure Kimai Database URL

Source: https://www.kimai.org/documentation/fresh-ubuntu-20.html

Example configuration for the DATABASE_URL in the .env file.

```text
DATABASE_URL=mysql://kimai2:my-super-secret-password@127.0.0.1:3306/kimai2?charset=utf8mb4&serverVersion=5.7.40
```

--------------------------------

### Create user account and set password

Source: https://www.kimai.org/documentation/fresh-ubuntu-22.html

Connect to the server as root and create a new user account with a bash shell.

```bash
ssh root@IP-of-myserver

useradd -m -s /bin/bash kevin
passwd kevin
```

--------------------------------

### Environment Configuration

Source: https://www.kimai.org/documentation/developers.html

Example configuration for the .env file to set the application environment to dev and define the database connection string.

```text
APP_ENV=dev
DATABASE_URL=mysql://user:password@127.0.0.1:3306/database?charset=utf8mb4&serverVersion=8.3.0
```

--------------------------------

### Start OpenLDAP service

Source: https://www.kimai.org/documentation/ldap-example.html

Command to start the slapd service with debug level 3.

```bash
/usr/libexec/slapd -d3 -f /opt/homebrew/etc/openldap/slapd.conf
```

--------------------------------

### Configure DATABASE_URL with serverVersion

Source: https://www.kimai.org/documentation/installation.html

Example of a correctly formatted DATABASE_URL including the specific server version.

```text
DATABASE_URL=mysql://kimai:kimai@sqldb/kimai?charset=utf8mb4&serverVersion=11.1.2-MariaDB
```

--------------------------------

### Install dependencies on Netcup

Source: https://www.kimai.org/documentation/shared-hosting.html

Install PHP dependencies with increased memory limits for the Netcup environment.

```bash
COMPOSER_MEMORY_LIMIT=-1 php -d memory_limit=-1 composer.phar install --no-dev --optimize-autoloader
```

--------------------------------

### Install tzdata-legacy

Source: https://www.kimai.org/documentation/public-holiday.html

Command to install the missing OS library required for timezone handling during imports.

```bash
apt install tzdata-legacy
```

--------------------------------

### Switch to Kimai directory

Source: https://www.kimai.org/documentation/shared-hosting.html

Navigate into the newly created Kimai directory.

```bash
cd kimai
```

--------------------------------

### Install OpenLDAP on MacOS

Source: https://www.kimai.org/documentation/ldap-example.html

Commands to install OpenLDAP via Homebrew and prepare the data directory.

```bash
brew install openldap
mkdir /opt/homebrew/var/openldap-data
chmod 777 /opt/homebrew/var/openldap-data
```

--------------------------------

### Install Fail2Ban

Source: https://www.kimai.org/documentation/fresh-ubuntu-22.html

Installs the fail2ban service and clones the Kimai Fail2Ban plugin into the application directory.

```bash
apt-get install fail2ban
cd /var/www/kimai/var/plugins/
git clone https://github.com/Keleo/Fail2BanBundle.git
```
Tokens:
Raw