[BUG] composer require symfony/sendgrid-mailer fails

[amammes]

Hi, I am trying to add sendgrid support and kimai instructions say that I need to add the symfony/sendgrid-mailer package. However, "composer require symfony/sendgrid-mailer" fails with the following output:

root@d06b1d3c4ad0:/var/www/html# cd /opt/kimai
root@d06b1d3c4ad0:/opt/kimai# composer require symfony/sendgrid-mailer

In ArtifactRepository.php line 76:

  RecursiveDirectoryIterator::__construct(var/packages/): Failed to open directory: No such file or directory  

require [--dev] [--dry-run] [--prefer-source] [--prefer-dist] [--prefer-install PREFER-INSTALL] [--fixed] [--no-suggest] [--no-progress] [--no-update] [--no-install] [--no-audit] [--audit-format AUDIT-FORMAT] [--update-no-dev] [-w|--update-with-dependencies] [-W|--update-with-all-dependencies] [--with-dependencies] [--with-all-dependencies] [--ignore-platform-req IGNORE-PLATFORM-REQ] [--ignore-platform-reqs] [--prefer-stable] [--prefer-lowest] [--sort-packages] [-o|--optimize-autoloader] [-a|--classmap-authoritative] [--apcu-autoloader] [--apcu-autoloader-prefix APCU-AUTOLOADER-PREFIX] [--] [<packages>...]

I checked out /opt/kimai/composer.json and it has the following repository which does not exist on the file system.

"repositories": [
        {
            "type": "artifact",
            "url": "var/packages/"
        }
    ],

I am sorry but I am not experienced in php and much less with composer parameters, but I believe the repository path is incorrect in /opt/kimai/composer.json

Desktop (please complete the following information):

• Hypervisor is Proxmox 8.1. Docker host is Debian 12 bookworm.
• Docker version:

  
  Client: Docker Engine - Community
  Version:           24.0.7
  API version:       1.43
  Go version:        go1.20.10
  Git commit:        afdd53b
  Built:             Thu Oct 26 09:08:02 2023
  OS/Arch:           linux/amd64
  Context:           default

Server: Docker Engine - Community Engine: Version: 24.0.7 API version: 1.43 (minimum version 1.12) Go version: go1.20.10 Git commit: 311b9ff Built: Thu Oct 26 09:08:02 2023 OS/Arch: linux/amd64 Experimental: false containerd: Version: 1.6.25 GitCommit: d8f198a4ed8892c764191ef7b3b06d8a2eeb5c7f runc: Version: 1.1.10 GitCommit: v1.1.10-0-g18a0cb0 docker-init: Version: 0.19.0 GitCommit: de40ad0

**Command used to run the container**
docker compose up -d

**Docker compose file (with passwords redacted)**

version: '3.5' services:

mysql: image: mysql:5.7 container_name : kimai1-mysql environment:

• MYSQL_DATABASE=kimai
• MYSQL_USER=kimaiuser
• MYSQL_PASSWORD=redacted
• MYSQL_ROOT_PASSWORD=redacted volumes:
• ./mysql:/var/lib/mysql command: --default-storage-engine innodb restart: unless-stopped healthcheck: test: mysqladmin -p$$MYSQL_ROOT_PASSWORD ping -h localhost interval: 20s start_period: 10s timeout: 10s retries: 3 networks:

• default

  kimai: image: kimai/kimai2:apache container_name : kimai1-kimai volumes:

• ./kimai/var:/opt/kimai/var ports:
• 8022:22 environment:
• ADMINMAIL=redacted
• ADMINPASS=redacted
• "DATABASE_URL=mysql://kimaiuser:redacted@kimai1-mysql/kimai?charset=utf8"
• MAILER_FROM=redacted@example.com
• MAILER_URL=sendgrid+smtp://redacted_senddrid_key@default
• TRUSTED_HOSTS=localhost,127.0.0.1 restart: unless-stopped networks:
• nginx-proxy-manager_default

• default

  phpmyadmin: image: phpmyadmin container_name : kimai1-phpmyadmin restart: always environment: PMA_HOST: kimai1-mysql PMA_ABSOLUTE_URI: redacted UPLOAD_LIMIT: 768M PMA_PORT: 3306 networks:

• nginx-proxy-manager_default
• default

networks: nginx-proxy-manager_default: external: true default:

[amammes]

Fixed by adding

"repositories": [
    {
        "type": "composer",
        "url": "https://repo.packagist.org"
    }
],

[kevinpapst]

You could just create the directory /opt/kimai/var/packages/

You do not need these mailer packages. They just "simplify" how to setup the MAILER DSN.

[kevinpapst]

@tobybatch any idea why the directory is missing? It is in git: https://github.com/kimai/kimai/tree/main/var/packages

[amammes]

This is what I see in my container based on image: kimai/kimai2:apache

root@71ce333c1353:/opt/kimai/var# ls -la total 24 drwxr-xr-x 5 www-data www-data 4096 Dec 4 23:08 . drwxr-xr-x 1 www-data www-data 4096 Dec 5 14:45 .. drwxr-xr-x 3 www-data www-data 4096 Dec 5 14:46 cache drwxr-xr-x 2 www-data www-data 4096 Dec 4 23:08 data -rw-r--r-- 1 www-data www-data 6 Dec 5 14:41 installed drwxr-xr-x 2 www-data www-data 4096 Dec 4 22:58 log

[amammes]

The kimai documentation says this, but does not give an example for Sendgrid. I tried several configs, none of them worked.

Be aware that you can achieve the same in most cases (without installing composer packages) by rewriting the MAILER_URL, e.g.:

Gmail: smtps://{username}:{password}@smtp.gmail.com:465 Sendinblue: smtps://{username}:{password}@smtp-relay.sendinblue.com:465

[amammes]

mkdir /opt/kimai/var/packages solved the composer require error. Thanks, all is working now with some manual intervention

[tobybatch]

  kimai:
    image: kimai/kimai2:apache
    container_name : kimai1-kimai
    volumes:
      - ./kimai/var:/opt/kimai/var
    ports:
      - 8022:22

Here you mount the entire var directory in to the image. This means that dir will be empty when the container starts. You want to look at bind mounts instead

https://docs.docker.com/storage/bind-mounts/

[kevinpapst]

Usually you shouldn't use composer inside the container anyway... But is that something for the docs?

[amammes]

@tobybatch thanks for the tip about the volume. You were right, I was screwing up the container by mounting var like that.

@kevinpapst you are correct about "composer require" or "composer update" from inside the container screwing up the container. The file permissions leave a broken kimai instance.

@kevinpapst you are also correct that Sendgrid doesn't need extra packages. I set it up like this and it worked fine: MAILER_URL=smtps://apikey:redacted_apikey_goes_here@smtp.sendgrid.net:465