Add InvoiceShelf (formerly Crater) as a service

[rihards-simanovics]

Docker version of the app available here: https://github.com/InvoiceShelf/docker

[rihards-simanovics]

confirmed working SQLite version of the application

docker-compose.yml

services:
  invoiceshelf:
    image: 'invoiceshelf/invoiceshelf:latest'
    container_name: invoiceshelf
    volumes:
      - './invoiceshelf_sqlite/data:/data'
      - './invoiceshelf_sqlite/conf:/conf'
    networks:
      - invoiceshelf
    environment:
      - SERVICE_FQDN_FRONTEND
      - PHP_TZ=UTC
      - TIMEZONE=UTC
      - APP_NAME=Laravel
      - APP_ENV=local
      - APP_DEBUG=true
      - 'APP_URL=http://localhost:80'
      - DB_CONNECTION=sqlite
      - DB_DATABASE=/var/www/html/InvoiceShelf/database/database.sqlite
      - CACHE_STORE=file
      - SESSION_DRIVER=file
      - SESSION_LIFETIME=120
      - SESSION_ENCRYPT=false
      - SESSION_PATH=/
      - SESSION_DOMAIN=localhost
      - 'SANCTUM_STATEFUL_DOMAINS=localhost:90'
      - STARTUP_DELAY=
      - 'MAIL_DRIVER=${MAIL_DRIVER:-smtp}'
      - MAIL_HOST=$MAIL_HOST
      - 'MAIL_PORT=${MAIL_PORT:-587}'
      - MAIL_USERNAME=$MAIL_USERNAME
      - MAIL_PASSWORD=$MAIL_PASSWORD
      - 'MAIL_ENCRYPTION=${MAIL_ENCRYPTION:-tls}'
    restart: unless-stopped
    healthcheck:
      test:
        - CMD
        - curl
        - '-f'
        - 'http://127.0.0.1:80'
      interval: 2s
      timeout: 10s
      retries: 15
networks:
  invoiceshelf: null

[rihards-simanovics]

here is another MySQL version

• Database HostName: mariadb
• Database Name: invoiceshelf
• Database Username: check generated env
• Database Password: check generated env

docker-compose.yml

services:
  invoiceshelf:
    image: 'invoiceshelf/invoiceshelf:latest'
    volumes:
      - 'invoiceshelf-files:/data'
    environment:
      - SERVICE_FQDN_INVOICESHELF
      - PHP_TZ=UTC
      - TIMEZONE=UTC
      - APP_NAME=Laravel
      - APP_ENV=local
      - APP_DEBUG=true
      - APP_URL=$SERVICE_FQDN_INVOICESHELF
      - DB_CONNECTION=mysql
      - DB_HOST=mariadb
      - DB_PORT=3306
      - DB_DATABASE=invoiceshelf
      - DB_USERNAME=$SERVICE_USER_INVOICESHELF
      - DB_PASSWORD=$SERVICE_PASSWORD_INVOICESHELF
      - DB_PASSWORD_FILE=
      - CACHE_STORE=file
      - SESSION_DRIVER=file
      - SESSION_LIFETIME=120
      - SESSION_ENCRYPT=false
      - SESSION_PATH=/
      - SESSION_DOMAIN=localhost
      - 'SANCTUM_STATEFUL_DOMAINS=localhost:90'
      - STARTUP_DELAY=
    depends_on:
      - mariadb
    healthcheck:
      test:
        - CMD
        - curl
        - '-f'
        - 'http://127.0.0.1'
      interval: 2s
      timeout: 10s
      retries: 10
  mariadb:
    image: 'mariadb:11.5'
    volumes:
      - 'mariadb-data:/var/lib/mysql'
    environment:
      - MYSQL_ROOT_PASSWORD=$SERVICE_PASSWORD_ROOT
      - MYSQL_DATABASE=invoiceshelf
      - MYSQL_USER=$SERVICE_USER_INVOICESHELF
      - MYSQL_PASSWORD=$SERVICE_PASSWORD_INVOICESHELF
    healthcheck:
      test:
        - CMD
        - healthcheck.sh
        - '--connect'
        - '--innodb_initialized'
      interval: 5s
      timeout: 20s
      retries: 10

[rihards-simanovics]

here is another MySQL version

• Database Host: postgres
• Database Port: 5432
• Database Name: invoiceshelf
• Database Username: invoiceshelf
• Database Password: invoiceshelf

docker-compose.yml

services:
  postgres:
    image: postgres:15
    volumes:
      - postgres-files:/var/lib/postgresql/data
    environment:
      - POSTGRES_PASSWORD=invoiceshelf
      - POSTGRES_USER=invoiceshelf
      - POSTGRES_DB=invoiceshelf
    healthcheck:
      test: ["CMD-SHELL", "pg_isready -U $${POSTGRES_USER} -d $${POSTGRES_DB}"]
      interval: 5s
      timeout: 20s
      retries: 10
  invoiceshelf:
    image: 'invoiceshelf/invoiceshelf:latest'
    volumes:
      - 'invoiceshelf-files:/data'
    environment:
      - SERVICE_FQDN_FRONTEND
      - PHP_TZ=UTC
      - TIMEZONE=UTC
      - APP_NAME=Laravel
      - APP_ENV=local
      - APP_DEBUG=true
      - APP_URL=http://localhost:90
      - DB_CONNECTION=pgsql
      - DB_HOST=postgres
      - DB_PORT=5432
      - DB_DATABASE=invoiceshelf
      - DB_USERNAME=invoiceshelf
      - DB_PASSWORD=invoiceshelf
      - CACHE_STORE=file
      - SESSION_DRIVER=file
      - SESSION_LIFETIME=120
      - SESSION_ENCRYPT=false
      - SESSION_PATH=/
      - SESSION_DOMAIN=localhost
      - SANCTUM_STATEFUL_DOMAINS=localhost:90
      - STARTUP_DELAY=
      #- MAIL_DRIVER=smtp
      #- MAIL_HOST=smtp.mailtrap.io
      #- MAIL_PORT=2525
      #- MAIL_USERNAME=null
      #- MAIL_PASSWORD=null
      #- MAIL_PASSWORD_FILE=<filename>
      #- MAIL_ENCRYPTION=null
    depends_on:
      - postgres
    healthcheck:
      test:
        - CMD
        - curl
        - '-f'
        - 'http://127.0.0.1'
      interval: 2s
      timeout: 10s
      retries: 10

[peaklabs-dev]

@rihards-simanovics Please create a PR for this service make sure to use the Coolify magic https://coolify.io/docs/knowledge-base/docker/compose#coolifys-magic-environment-variables

[rihards-simanovics]

Will do thanks for pointing out the docs for env vars, haven't seen it before.

[rihards-simanovics]

Hi @peaklabs-dev, had some time today to look at the env vars, and already made some changes to the MySQL one.

Also just to clarify, and not sure if this would be a problem, but Invoice Shelf has been designed to be hosted like a traditional LEMP/LAMP Web App, which does means it still wants the user to fill the information about DB and mailing through the Setup Wizard.

We do need to change the project initialisation to ensure that env vars are used during the setup and make sure some setup steps are bypassed, however for the time being the user will unfortunately, still need to enter the details twice.

[peaklabs-dev]

A setup wizard is perfectly fine and should work, Nextcloud does that as well for example. If the user has to enter the details manually, that is also normal and there is not much we can do about it as some services are built that way.

[mrakus-sofomo]

How its going? If you do not have time then I can take it :D

[rihards-simanovics]

How its going? If you do not have time then I can take it :D

Hey @mrakus-sofomo, yeah if you have time you can absolutely have a look into it. I've done the MySQL version already, you only need to copy the env to the PostgreSQL and SQLite. here is the MySQL config: #3634 (comment)

One thing to note is that we've found an issue in the container where if it gets restarted almost all .env values get reset and not populated - see InvoiceShelf/InvoiceShelf#218 known issues under CSRF issue. I will be working on a fix some time between now and early January, just have some uni assessments to take care of first.