Set default memory limit

unicode emoji for dockerhub

.github/ISSUE_TEMPLATE/bug_report.md

@@ -0,0 +1,58 @@
+---
+name: Bug report
+about: Create a report to help us improve
+title: ''
+labels: ''
+assignees: ''
+
+---
+
+<!-- 
+*** Before creating an issue ***
+*** Be sure the issue isn't yet reported here or dicussed on stackoverflow ***
+-->
+
+**Setup information**
+<!-- Remove accordingly -->
+docker run / docker-compose / Helm
+
+**Describe the bug**
+A clear and concise description of what the bug is.
+
+**To reproduce**
+Steps to reproduce the behavior:
+1. Go to '...'
+2. Click on '....'
+3. Scroll down to '....'
+4. See error
+
+**Expected behavior**
+A clear and concise description of what you expected to happen.
+
+**Screenshots/logs**
+If applicable, add screenshots to help explain your problem.
+
+<!-- Did you check the logs? If any Error is present there please copy/paste it below -->
+```
+Any Error that sucks
+```
+
+**Docker/Kubernetes/Helm**:
+- Output of `docker version`:
+```
+(paste your output here)
+```
+<!-- Additional info if using helm on k8s, add the info below -->
+<!-- Delete this block if not applicable -->
+- Output of `helm version`:
+```
+(paste your output here)
+```
+- Output of `kubectl version`:
+```
+(paste your output here)
+```
+<!-- End Additional info if using helm on k8s -->
+
+**Additional context**
+Add any other context about the problem here.

.github/ct-install.yaml

@@ -0,0 +1,6 @@
+chart-dirs:
+  - charts
+chart-repos:
+  - bitnami=https://charts.bitnami.com/bitnami
+check-version-increment: true
+debug: false

.github/ct-lint.yaml

@@ -0,0 +1,9 @@
+chart-dirs:
+  - charts
+chart-repos:
+  - bitnami=https://charts.bitnami.com/bitnami
+check-version-increment: true
+debug: false
+validate-chart-schema: true
+validate-maintainers: true
+validate-yaml: true

.github/workflows/build-image-octane.yaml

@@ -0,0 +1,48 @@
+name: Build Octane Container Image
+
+on:
+  pull_request:
+    paths:
+      - ".github/**"
+      - "octane/**"
+  push:
+    paths:
+      - ".github/**"
+      - "octane/**"
+
+env:
+  REGISTRY_IMAGE: invoiceninja/invoiceninja-octane
+
+jobs:
+  build:
+    runs-on: ${{ startsWith(matrix.platform, 'linux/arm') && 'ubuntu-24.04-arm' || 'ubuntu-latest' }}
+    strategy:
+      fail-fast: false
+      matrix:
+        platform:
+          - linux/amd64
+          - linux/arm64
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v5
+
+      - name: Docker meta
+        id: meta
+        uses: docker/metadata-action@v5
+        with:
+          images: ${{ env.REGISTRY_IMAGE }}
+
+      - name: Set up Docker Buildx
+        id: buildx
+        uses: docker/setup-buildx-action@v3
+
+      - name: Build
+        id: build
+        uses: docker/build-push-action@v6
+        with:
+          context: octane
+          platforms: ${{ matrix.platform }}
+          tags: ${{ env.REGISTRY_IMAGE }}
+          outputs: type=image,push-by-digest=true,name-canonical=true
+          cache-from: type=gha
+          cache-to: type=gha,mode=max

.github/workflows/publish-image-octane.yaml

@@ -0,0 +1,166 @@
+name: Publish Octane Container Images
+
+on:
+  push:
+    tags-ignore:
+      - "invoiceninja-*"
+
+env:
+  REGISTRY_IMAGE: invoiceninja/invoiceninja-octane
+
+jobs:
+  version:
+    runs-on: ubuntu-latest
+    outputs:
+      version: ${{ steps.version.outputs.version }}
+      major: ${{ steps.version.outputs.major }}
+      minor: ${{ steps.version.outputs.minor }}
+      url: ${{ steps.version.outputs.url }}
+    steps:
+      - id: version
+        run: |
+
+          VERSION=edge
+          if [[ $GITHUB_REF == refs/tags/* ]]; then
+            VERSION=${GITHUB_REF#refs/tags/}
+            # Remove -o or -d suffix if present
+            VERSION=${VERSION%-*}
+          fi
+          MAJOR="$(echo "${VERSION}" | cut -d. -f1)"
+          MINOR="$(echo "${VERSION}" | cut -d. -f2)"
+          URL=https://github.com/invoiceninja/invoiceninja/releases/download/v${VERSION}/invoiceninja.tar.gz
+
+          # Debug output
+          echo "Current version: ${VERSION}"
+          echo "Version pattern check: $([[ $VERSION =~ ^5\.[0-9]{1,3}\.[0-9]{1,3}$ ]] && echo "matches" || echo "doesn't match")"
+
+          echo "version=${VERSION}" >> $GITHUB_OUTPUT
+          echo "major=${MAJOR}" >> $GITHUB_OUTPUT
+          echo "minor=${MINOR}" >> $GITHUB_OUTPUT
+          echo "url=${URL}" >> $GITHUB_OUTPUT
+
+  build:
+    runs-on: ${{ startsWith(matrix.platform, 'linux/arm') && 'ubuntu-24.04-arm' || 'ubuntu-latest' }}
+    needs:
+      - version
+    strategy:
+      fail-fast: false
+      matrix:
+        platform:
+          - linux/amd64
+          - linux/arm64
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v5
+
+      - name: Prepare
+        id: prep
+        run: |
+          platform=${{ matrix.platform }}
+          echo "PLATFORM_PAIR=${platform//\//-}" >> $GITHUB_ENV
+
+      - name: Docker meta
+        id: meta
+        uses: docker/metadata-action@v5
+        with:
+          images: ${{ env.REGISTRY_IMAGE }}
+
+      - name: Login to DockerHub
+        uses: docker/login-action@v3
+        with:
+          username: ${{ secrets.DOCKERHUB_USERNAME }}
+          password: ${{ secrets.DOCKERHUB_PASSWORD }}
+
+      - name: Set up Docker Buildx
+        id: buildx
+        uses: docker/setup-buildx-action@v3
+
+      - name: Build and push by digest
+        id: build
+        uses: docker/build-push-action@v6
+        with:
+          context: octane
+          build-args: URL=${{ needs.version.outputs.url }}
+          platforms: ${{ matrix.platform }}
+          labels: ${{ steps.meta.outputs.labels }}
+          tags: ${{ env.REGISTRY_IMAGE }}
+          outputs: type=image,push-by-digest=true,name-canonical=true,push=${{ github.event_name != 'pull_request' }}
+          cache-from: type=gha
+          cache-to: type=gha,mode=max
+
+      - name: Export digest
+        run: |
+          mkdir -p ${{ runner.temp }}/digests
+          digest="${{ steps.build.outputs.digest }}"
+          touch "${{ runner.temp }}/digests/${digest#sha256:}"
+
+      - name: Upload digest
+        uses: actions/upload-artifact@v4
+        with:
+          name: digests-${{ env.PLATFORM_PAIR }}
+          path: ${{ runner.temp }}/digests/*
+          if-no-files-found: error
+          retention-days: 1
+
+  merge:
+    runs-on: ubuntu-latest
+    needs:
+      - version
+      - build
+    steps:
+      - name: Download digests
+        uses: actions/download-artifact@v4
+        with:
+          path: ${{ runner.temp }}/digests
+          pattern: digests-*
+          merge-multiple: true
+
+      - name: Login to Docker Hub
+        uses: docker/login-action@v3
+        with:
+          username: ${{ secrets.DOCKERHUB_USERNAME }}
+          password: ${{ secrets.DOCKERHUB_PASSWORD }}
+
+      - name: Set up Docker Buildx
+        uses: docker/setup-buildx-action@v3
+
+      - name: Docker meta
+        id: meta
+        uses: docker/metadata-action@v5
+        with:
+          images: ${{ env.REGISTRY_IMAGE }}
+          tags: |
+            ${{ needs.version.outputs.version }}
+            ${{ needs.version.outputs.major }}
+            ${{ needs.version.outputs.major }}.${{ needs.version.outputs.minor }}
+            latest
+
+      - name: Create manifest list and push
+        working-directory: ${{ runner.temp }}/digests
+        if: ${{ github.event_name != 'pull_request' }}
+        run: |
+          docker buildx imagetools create $(jq -cr '.tags | map("-t " + .) | join(" ")' <<< "$DOCKER_METADATA_OUTPUT_JSON") \
+            $(printf '${{ env.REGISTRY_IMAGE }}@sha256:%s ' *)
+
+      - name: Inspect image
+        if: ${{ github.event_name != 'pull_request' }}
+        run: |
+          docker buildx imagetools inspect ${{ env.REGISTRY_IMAGE }}:${{ steps.meta.outputs.version }}
+
+  Description:
+    if: ${{ github.event_name != 'pull_request' }}
+    runs-on: ubuntu-latest
+    needs:
+      - merge
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v5
+        with:
+          sparse-checkout: "README.md"
+
+      - name: Docker Hub Description
+        uses: peter-evans/dockerhub-description@v4
+        with:
+          username: ${{ secrets.DOCKERHUB_USERNAME }}
+          password: ${{ secrets.DOCKERHUB_PASSWORD }}
+          repository: ${{ env.REGISTRY_IMAGE }}

.github/workflows/release-chart.yaml

@@ -0,0 +1,34 @@
+name: Release Charts
+
+on:
+  push:
+    branches:
+      - master
+    paths:
+      - "charts/**"
+
+jobs:
+  release:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+
+      - name: Configure Git
+        run: |
+          git config user.name "$GITHUB_ACTOR"
+          git config user.email "$GITHUB_ACTOR@users.noreply.github.com"
+
+      - name: Set up Helm
+        uses: azure/setup-helm@v3
+
+      - name: Add Helm repos
+        run: |
+          helm repo add bitnami https://charts.bitnami.com/bitnami
+
+      - name: Run chart-releaser
+        uses: helm/chart-releaser-action@v1.4.1
+        env:
+          CR_TOKEN: "${{ secrets.GITHUB_TOKEN }}"

.github/workflows/test-charts.yaml

@@ -0,0 +1,111 @@
+name: Lint and Test Charts
+
+on:
+  pull_request:
+    paths:
+      - "charts/**"
+
+jobs:
+  lint-chart:
+    runs-on: ubuntu-latest
+    outputs:
+      matrix: ${{ steps.set-matrix.outputs.matrix }}
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+
+      - name: Set up Helm
+        uses: azure/setup-helm@v3
+
+      - uses: actions/setup-python@v4
+        with:
+          python-version: "3.9"
+          check-latest: true
+
+      - name: Set up chart-testing
+        uses: helm/chart-testing-action@v2.3.1
+
+      - name: Run chart-testing (list-changed)
+        id: list-changed
+        run: |
+          echo "::set-output name=changed::[\"$(ct list-changed --config .github/ct-lint.yaml)\"]"
+
+      - name: Parse list-changed
+        id: set-matrix
+        env:
+          CHANGED: ${{ steps.list-changed.outputs.changed }}
+        run: |
+          echo "::set-output name=matrix::$(echo "${CHANGED//\\n/\",\"}")"
+
+      - name: Run chart-testing (lint)
+        run: ct lint --config .github/ct-lint.yaml
+
+  kubeconform-chart:
+    runs-on: ubuntu-latest
+    needs:
+      - lint-chart
+    strategy:
+      matrix:
+        chart: ${{ fromJson(needs.lint-chart.outputs.matrix) }}
+        k8s:
+          - "1.25.5"
+          - "1.24.9"
+          - "1.23.15"
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+
+      - name: Update Helm depdendencies
+        env:
+          CHART_DIR: ${{ matrix.chart }}
+        run: |
+          helm dependency update "${CHART_DIR}"
+          mkdir tmp
+          helm template "${CHART_DIR}" > tmp/combined.yaml
+
+      - uses: yokawasa/action-setup-kube-tools@v0.9.2
+        with:
+          setup-tools: |
+            kubeconform
+
+      - name: Run kubeconform
+        if: ${{ matrix.k8s }}
+        run: kubeconform -kubernetes-version ${{ matrix.k8s }} tmp/combined.yaml
+
+  install-chart:
+    name: install-chart
+    runs-on: ubuntu-latest
+    needs:
+      - lint-chart
+      - kubeconform-chart
+    strategy:
+      matrix:
+        k8s:
+          - v1.25.3
+          - v1.24.7
+          - v1.23.13
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v2
+        with:
+          fetch-depth: 0
+
+      - name: Create kind ${{ matrix.k8s }} cluster
+        uses: helm/kind-action@v1.4.0
+        with:
+          node_image: kindest/node:${{ matrix.k8s }}
+
+      - uses: actions/setup-python@v4
+        with:
+          python-version: "3.9"
+          check-latest: true
+
+      - name: Set up chart-testing
+        uses: helm/chart-testing-action@v2.3.1
+
+      - name: Run chart-testing (install)
+        run: ct install --config .github/ct-install.yaml

.gitignore

@@ -1 +0,0 @@
-data

CODE_OF_CONDUCT.md

@@ -0,0 +1,76 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, sex characteristics, gender identity and expression,
+level of experience, education, socio-economic status, nationality, personal
+appearance, race, religion, or sexual identity and orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+ advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+ address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+ professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at contact@invoiceninja.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at https://www.contributor-covenant.org/version/1/4/code-of-conduct.html
+
+[homepage]: https://www.contributor-covenant.org
+
+For answers to common questions about this code of conduct, see
+https://www.contributor-covenant.org/faq

Dockerfile

@@ -1,62 +0,0 @@
-FROM php:fpm
-
-MAINTAINER Samuel Laulhau <sam@lalop.co>
-
-#####
-# SYSTEM REQUIREMENT
-#####
-RUN apt-get update \
-    && apt-get install -y --no-install-recommends \
-        libmcrypt-dev zlib1g-dev git libgmp-dev \
-        libfreetype6-dev libjpeg62-turbo-dev libpng12-dev \
-    && ln -s /usr/include/x86_64-linux-gnu/gmp.h /usr/local/include/ \
-    && docker-php-ext-configure gd --with-freetype-dir=/usr/include/ --with-jpeg-dir=/usr/include/ \
-    && docker-php-ext-configure gmp \
-    && docker-php-ext-install iconv mcrypt mbstring pdo pdo_mysql zip gd gmp \
-    && rm -rf /var/lib/apt/lists/*
-
-#####
-# INSTALL COMPOSER
-#####
-RUN curl -sS https://getcomposer.org/installer | php -- --install-dir=/usr/local/bin --filename=composer
-
-
-#####
-# DOWNLOAD AND INSTALL INVOICE NINJA
-#####
-
-ENV INVOICENINJA_VERSION 2.5.2.2
-
-RUN curl -o invoiceninja.tar.gz -SL https://github.com/hillelcoren/invoice-ninja/archive/v${INVOICENINJA_VERSION}.tar.gz \
-    && tar -xzf invoiceninja.tar.gz -C /var/www/ \
-    && rm invoiceninja.tar.gz \
-    && mv /var/www/invoiceninja-${INVOICENINJA_VERSION} /var/www/app \
-    && chown -R www-data:www-data /var/www/app \
-    && composer install --working-dir /var/www/app -o --no-dev --no-interaction --no-progress \
-    && chown -R www-data:www-data /var/www/app/bootstrap/cache \
-    && mv /var/www/app/storage /var/www/app/docker-backup-storage \
-    && mv /var/www/app/public/logo /var/www/app/docker-backup-public-logo
-
-
-######
-# DEFAULT ENV
-######
-ENV DB_HOST mysql
-ENV DB_DATABASE ninja
-ENV APP_KEY SomeRandomString
-ENV LOG errorlog
-ENV APP_DEBUG 1
-
-
-#use to be mounted into nginx for exemple
-VOLUME /var/www/app/public
-
-WORKDIR /var/www/app
-
-EXPOSE 80
-
-COPY app-entrypoint.sh /entrypoint.sh
-RUN chmod +x /entrypoint.sh
-
-ENTRYPOINT ["/entrypoint.sh"]
-CMD ["php-fpm"]

README.md

@@ -1,29 +1,94 @@
-DockerFile for invoice ninja (https://www.invoiceninja.com/)
+[![Docker Image Size](https://img.shields.io/docker/image-size/invoiceninja/invoiceninja-octane?label=octane)](https://hub.docker.com/r/invoiceninja/invoiceninja-octane)
+[![Docker Pulls](https://img.shields.io/docker/pulls/invoiceninja/invoiceninja-octane)](https://hub.docker.com/r/invoiceninja/invoiceninja-octane)
+[![Publish Status](https://github.com/invoiceninja/dockerfiles/actions/workflows/publish-image-octane.yaml/badge.svg)](https://github.com/invoiceninja/dockerfiles/actions/workflows/publish-image-octane.yaml)
+[![Build Status](https://github.com/invoiceninja/dockerfiles/actions/workflows/build-image-octane.yaml/badge.svg)](https://github.com/invoiceninja/dockerfiles/actions/workflows/build-image-octane.yaml)
 
-This image is based on `php:7` official version.
+# Octane Docker for [Invoice Ninja](https://www.invoiceninja.com/)
 
-The easiest way to try this image is via docker compose :
+👑 **Features**
+
+[FRANKENPHP](https://frankenphp.dev/)  
+Built-in Chrome for PDF generation and other features  
+Saxon XLST 2 engine  
+OPcache  
+Multi language support  
+
+## Get started with Docker Compose
+
+This Debian-based image includes Chrome for enhanced PDF generation and other features. To get started:
+
+```bash
+git clone https://github.com/invoiceninja/dockerfiles.git -b octane
+cd dockerfiles/octane
+```
+
+Instead of defining our environment variables inside our docker-compose.yml file we now define this in the `.env` file, open this file up and insert your `APP_URL`, `APP_KEY` and update the rest of the variables as required.
 
 ```
-db:
-  image: mysql
-  environment:
-    MYSQL_DATABASE: ninja
-    MYSQL_ROOT_PASSWORD: mdp
-
-app:
-  image: invoiceninja/invoiceninja
-  links:
-    - db:mysql
-
-web:
-  image: nginx
-  volumes:
-    - ./nginx.conf:/etc/nginx/nginx.conf:ro
-  links:
-    - app
-  volumes_from:
-    - app
-  ports:
-    - 80
+APP_URL=http://in.localhost:8003/
+APP_KEY=<insert your generated key in here>
+APP_DEBUG=true
+REQUIRE_HTTPS=false
+IN_USER_EMAIL=
+IN_PASSWORD=
 ```
+
+## Initial account setup
+
+### Primary account setup
+Prior to starting the container for the first time, open the .env file and update the IN_USER_EMAIL and IN_PASSWORD variables with your primary account. 
+
+This will take care of the initial account setup. You can later remove these .env variables.
+
+> ⚠️ **Warning**  
+> If `IN_USER_EMAIL` and `IN_PASSWORD` are not set the default user email and password is "admin@example.com" and "changeme!" respectively. 
+
+After the container has completed the first startup you can delete these two environment variables.
+
+### Generate a APP_KEY
+
+The `APP_KEY` can be generated by running:
+
+```bash
+# If you haven't started the containers yet:
+docker run --rm -it invoiceninja/invoiceninja-octane frankenphp php-cli artisan key:generate --show
+
+# Or if your containers are already running:
+docker compose exec app frankenphp php-cli artisan key:generate --show
+```
+
+Copy the entire string and insert in the .env file at `APP_KEY=base64....`
+
+**Note: For PDF generation using localhost, your domain name MUST end in .test for PDFs to generate correctly due to Chrome's DNS resolver.
+
+Start the container with:
+
+```bash
+docker compose up -d
+```
+
+**Note: When performing the setup, the Database host is ```mysql```
+
+### Updating the Image
+
+To upgrade to a newer release image, update your docker-compose.yml first by running:
+
+```bash
+docker compose pull
+docker compose up -d
+```
+
+It is recommended to perform a backup before updating.
+
+### Support
+
+If you discover a bug, please create an issue. For general queries, visit our [Forum](https://forum.invoiceninja.com/)
+
+
+### Todo
+
+This is a new image which should provide much better support for all users, however there are some items left to complete
+
+- [ ] Backup script  
+- [ ] Integrate soketi server  
+- [ ] Add elastic search for site wide search  

app-entrypoint.sh

@@ -1,39 +0,0 @@
-#!/bin/bash
-set -e
-
-
-# if we're linked to MySQL, and we're using the root user, and our linked
-# container has a default "root" password set up and passed through... :)
-: ${DB_USERNAME:=root}
-if [ "$DB_USERNAME" = 'root' ]; then
-	: ${DB_PASSWORD:=$MYSQL_ENV_MYSQL_ROOT_PASSWORD}
-fi
-
-echo "DB_USERNAME=$DB_USERNAME" >> .env
-echo "DB_PASSWORD=$DB_PASSWORD" >> .env
-
-if [ ! -d /var/www/app/storage ]; then
-	cp -Rp /var/www/app/docker-backup-storage /var/www/app/storage
-else
-	IN_STORAGE_BACKUP="$(ls /var/www/app/docker-backup-storage/)"
-	for path in $IN_STORAGE_BACKUP; do
-		if [ ! -e "/var/www/app/storage/$path" ]; then
-			cp -Rp "/var/www/app/docker-backup-storage/$path" "/var/www/app/storage/"
-		fi
-	done
-fi
-
-if [ ! -d /var/www/app/public/logo ]; then
-	cp -Rp /var/www/app/docker-backup-public-logo /var/www/app/public/logo
-else
-	IN_LOGO_BACKUP="$(ls /var/www/app/docker-backup-public-logo/)"
-	for path in $IN_LOGO_BACKUP; do
-		if [ ! -e "/var/www/app/public/logo/$path" ]; then
-			cp -Rp "/var/www/app/docker-backup-public-logo/$path" "/var/www/app/public/logo/"
-		fi
-	done
-fi
-
-chown www-data .env
-
-exec "$@"

nginx.conf

@@ -1,50 +0,0 @@
-user www-data;
-
-events {
-  worker_connections 768;
-}
-
-http {
-    upstream backend {
-        server app:9000;
-    }
-    include /etc/nginx/mime.types;
-    default_type application/octet-stream;
-    gzip on;
-    gzip_disable "msie6";
-
-    server {
-        listen      80 default;
-        server_name your_ininja_site;
-
-        root /var/www/app/public;
-
-        index index.php;
-
-        charset utf-8;
-
-        location / {
-            try_files $uri $uri/ /index.php?$query_string;
-        }
-
-        location = /favicon.ico { access_log off; log_not_found off; }
-        location = /robots.txt  { access_log off; log_not_found off; }
-
-        sendfile off;
-
-        location ~ \.php$ {
-            fastcgi_split_path_info ^(.+\.php)(/.+)$;
-            fastcgi_pass backend;
-            fastcgi_index index.php;
-            include fastcgi_params;
-            fastcgi_param SCRIPT_FILENAME $document_root$fastcgi_script_name;
-            fastcgi_intercept_errors off;
-            fastcgi_buffer_size 16k;
-            fastcgi_buffers 4 16k;
-        }
-
-        location ~ /\.ht {
-            deny all;
-        }
-    }
-}

octane/.env

@@ -0,0 +1,62 @@
+# IN application vars
+APP_URL=http://localhost
+APP_KEY=base64:RR++yx2rJ9kdxbdh3+AmbHLDQu+Q76i++co9Y8ybbno=
+APP_ENV=production
+APP_DEBUG=true
+REQUIRE_HTTPS=false
+PHANTOMJS_PDF_GENERATION=false
+PDF_GENERATOR=snappdf
+TRUSTED_PROXIES='*'
+
+
+CACHE_DRIVER=redis
+QUEUE_CONNECTION=redis
+SESSION_DRIVER=redis
+
+REDIS_HOST=redis
+REDIS_PASSWORD=null
+REDIS_PORT=6379
+
+FILESYSTEM_DISK=debian_docker
+
+# DB connection
+DB_HOST=mysql
+DB_PORT=3306
+DB_DATABASE=ninja
+DB_USERNAME=ninja
+DB_PASSWORD=ninja
+DB_ROOT_PASSWORD=ninjaAdm1nPassword
+DB_CONNECTION=mysql
+
+# Create initial user
+# Default to these values if empty
+IN_USER_EMAIL=admin@example.com
+IN_PASSWORD=changeme!
+# IN_USER_EMAIL=
+# IN_PASSWORD=
+
+# Mail options
+MAIL_MAILER=log
+MAIL_HOST=smtp.mailtrap.io
+MAIL_PORT=2525
+MAIL_USERNAME=null
+MAIL_PASSWORD=null
+MAIL_ENCRYPTION=null
+MAIL_FROM_ADDRESS='user@example.com'
+MAIL_FROM_NAME='Self Hosted User'
+
+# MySQL
+MYSQL_ROOT_PASSWORD=ninjaAdm1nPassword
+MYSQL_USER=ninja
+MYSQL_PASSWORD=ninja
+MYSQL_DATABASE=ninja
+
+# GoCardless/Nordigen API key for banking integration
+NORDIGEN_SECRET_ID=
+NORDIGEN_SECRET_KEY=
+
+IS_DOCKER=true
+SCOUT_DRIVER=null
+#SNAPPDF_CHROMIUM_PATH=/usr/bin/google-chrome-stable
+
+

octane/Dockerfile

@@ -0,0 +1,102 @@
+ARG PHP_VERSION=8.4
+ARG FRANKENPHP_VERSION=1
+ARG DEBIAN_VERSION=trixie
+
+FROM dunglas/frankenphp:${FRANKENPHP_VERSION}-php${PHP_VERSION}-${DEBIAN_VERSION} AS prepare-app
+
+ARG URL=https://github.com/invoiceninja/invoiceninja/releases/latest/download/invoiceninja.tar.gz
+
+ADD ${URL} /tmp/invoiceninja.tar.gz
+
+RUN tar -xf /tmp/invoiceninja.tar.gz \
+    && ln -s ./resources/views/react/index.blade.php ./public/index.html \
+    # Symlink
+    && php artisan storage:link \
+    # Octane
+    && php artisan octane:install --server=frankenphp
+
+# ==================
+# InvoiceNinja image
+# ==================
+FROM dunglas/frankenphp:${FRANKENPHP_VERSION}-php${PHP_VERSION}-${DEBIAN_VERSION}
+
+ARG user=ninja
+
+# PHP modules
+ARG php_require="bcmath gd mbstring pdo_mysql zip"
+ARG php_suggest="exif imagick intl pcntl saxon soap"
+ARG php_extra="opcache"
+
+# Create a system user UID/GID=999
+RUN	useradd -r ${user}
+
+# Allow to bind to privileged ports
+RUN setcap CAP_NET_BIND_SERVICE=+eip /usr/local/bin/frankenphp
+
+# Install system dependencies
+RUN apt-get update && apt-get install -y --no-install-recommends \
+    mariadb-client \
+    gpg \
+    # Unicode support for PDF
+    fonts-noto-cjk-extra \
+    fonts-wqy-microhei \
+    fonts-wqy-zenhei \
+    xfonts-wqy \
+    # Install google-chrome-stable(amd64)/chromium(arm64)
+    && if [ "$(dpkg --print-architecture)" = "amd64" ]; then \
+    mkdir -p /etc/apt/keyrings \
+    && curl -fsSL https://dl.google.com/linux/linux_signing_key.pub | \
+    gpg --dearmor -o /etc/apt/keyrings/google.gpg \
+    && echo "deb [arch=amd64 signed-by=/etc/apt/keyrings/google.gpg] https://dl.google.com/linux/chrome/deb/ stable main" > /etc/apt/sources.list.d/google-chrome.list \
+    && apt-get update \
+    && apt-get install -y --no-install-recommends google-chrome-stable \
+    && mkdir /config/google-chrome \
+    && chown ${user}: /config/google-chrome; \
+    elif [ "$(dpkg --print-architecture)" = "arm64" ]; then \
+    apt-get install -y --no-install-recommends \
+    chromium \
+    && mkdir /config/chromium \
+    && chown ${user}: /config/chromium; \
+    fi \
+    # Cleanup
+    && apt-get purge -y gpg \
+    && apt-get autoremove -y \
+    && apt-get clean \
+    && rm -rf /var/lib/apt/lists/*
+
+# Install PHP extensions
+RUN install-php-extensions \
+    ${php_require} \
+    ${php_suggest} \
+    ${php_extra}
+
+# Configure PHP
+RUN ln -s "${PHP_INI_DIR}/php.ini-production" "${PHP_INI_DIR}/php.ini"
+
+COPY php/php.ini /usr/local/etc/php/conf.d/invoiceninja.ini
+
+# Workaround: Disable SSL for mariadb-client for compatibility with MySQL
+RUN echo "skip-ssl = true" >> /etc/mysql/mariadb.conf.d/50-client.cnf
+
+# Create directory for artisan tinker (init.sh)
+RUN mkdir /config/psysh \
+    && chown ${user}: /config/psysh
+
+# Change owner for caddy directories
+RUN chown -R ${user}: \
+    /data/caddy \
+    /config/caddy
+
+# InvoiceNinja
+COPY --from=prepare-app --chown=${user}:${user} /app /app
+
+# Add initialization script
+COPY --chmod=0755 scripts/init.sh /usr/local/bin/init.sh
+
+USER ${user}
+
+HEALTHCHECK --start-period=100s CMD curl -f http://localhost/health
+
+ENTRYPOINT ["/usr/local/bin/init.sh"]
+
+CMD ["frankenphp", "php-cli", "artisan", "octane:frankenphp"]

octane/docker-compose.yml

@@ -0,0 +1,129 @@
+# name: invoiceninja
+
+x-app-volumes: &volumes
+  volumes:
+    - app_storage:/app/storage
+    - caddy_data:/data
+
+services:
+  app:
+    build:
+      context: .
+    image: invoiceninja/invoiceninja-octane:${TAG:-latest}
+    restart: unless-stopped
+    # php artisan help octane:frankenphp
+    command: --port=80 --workers=2
+    # command: --host=example.com --port=443 --workers=2 --https --http-redirect --log-level=info
+    ports:
+      - "80:80" # HTTP
+      # - "443:443" # HTTPS
+      # - "443:443/udp" # HTTP/3, Works for chromium based browser, but causes H3_GENERAL_PROTOCOL_ERROR for pdf previews in Firefox
+    env_file:
+      - ./.env
+    environment:
+      LARAVEL_ROLE: app
+    <<: *volumes
+    depends_on:
+      mysql:
+        condition: service_healthy
+      redis:
+        condition: service_healthy
+      # mariadb:
+      #   condition: service_healthy
+      # valkey:
+      #   condition: service_healthy
+
+  app-worker:
+    image: invoiceninja/invoiceninja-octane:${TAG:-latest}
+    restart: unless-stopped
+    # php artisan help queue:work
+    command: --verbose --sleep=3 --tries=3 --max-time=3600
+    deploy:
+      mode: replicated
+      replicas: 2
+    env_file:
+      - ./.env
+    environment:
+      LARAVEL_ROLE: worker
+    <<: *volumes
+    healthcheck:
+      test: ["CMD", "pgrep", "-f", "queue:work"]
+    depends_on:
+      app:
+        condition: service_healthy
+
+  app-scheduler:
+    image: invoiceninja/invoiceninja-octane:${TAG:-latest}
+    restart: unless-stopped
+    # php artisan help schedule:work
+    command: --verbose
+    env_file:
+      - ./.env
+    environment:
+      LARAVEL_ROLE: scheduler
+    <<: *volumes
+    healthcheck:
+      test: ["CMD", "pgrep", "-f", "schedule:work"]
+    depends_on:
+      app:
+        condition: service_healthy
+
+  mysql:
+    image: mysql:8
+    restart: unless-stopped
+    environment:
+      MYSQL_DATABASE: ${DB_DATABASE}
+      MYSQL_USER: ${DB_USERNAME}
+      MYSQL_PASSWORD: ${DB_PASSWORD}
+      MYSQL_ROOT_PASSWORD: ${DB_ROOT_PASSWORD}
+    volumes:
+      - mysql_data:/var/lib/mysql
+    healthcheck:
+      test:
+        [
+          "CMD",
+          "mysqladmin",
+          "ping",
+          "-h",
+          "localhost",
+          "-u${MYSQL_USER}",
+          "-p${MYSQL_PASSWORD}",
+        ]
+
+  redis:
+    image: redis:alpine
+    restart: unless-stopped
+    volumes:
+      - redis_data:/data
+    healthcheck:
+      test: ["CMD", "redis-cli", "ping"]
+
+  # mariadb:
+  #   image: mariadb:11.8
+  #   restart: unless-stopped
+  #   environment:
+  #     MARIADB_DATABASE: ${DB_DATABASE}
+  #     MARIADB_USER: ${DB_USERNAME}
+  #     MARIADB_PASSWORD: ${DB_PASSWORD}
+  #     MARIADB_ROOT_PASSWORD: ${DB_ROOT_PASSWORD}
+  #   volumes:
+  #     - mariadb:/var/lib/mysql
+  #   healthcheck:
+  #     test: ["CMD", "healthcheck.sh", "--connect", "--innodb_initialized"]
+
+  # valkey:
+  #   image: valkey/valkey:8
+  #   restart: unless-stopped
+  #   volumes:
+  #     - valkey:/data
+  #   healthcheck:
+  #     test: [ "CMD", "valkey-cli", "ping" ]
+
+
+volumes:
+  app_storage:
+  caddy_data:
+  mysql_data:
+  redis_data:
+  # mariadb:
+  # valkey:

octane/php/php.ini

@@ -0,0 +1,24 @@
+[core]
+; https://www.php.net/manual/en/ini.core.php
+post_max_size=10M
+upload_max_filesize=10M
+memory_limit=512M
+
+[opcache]
+; https://www.php.net/manual/en/opcache.installation.php#opcache.installation.recommended
+opcache.enable_cli=1
+
+[jit]
+; https://wiki.php.net/rfc/jit_config_defaults
+opcache.jit=tracing
+opcache.jit_buffer_size=64M
+
+[extra]
+; https://frankenphp.dev/docs/performance/#php-performance
+; http://symfony.com/doc/current/performance.html
+opcache.memory_consumption=256
+opcache.max_accelerated_files=20000
+opcache.preload=/app/preload.php
+opcache.validate_timestamps=0
+realpath_cache_size = 4096K
+realpath_cache_ttl = 600

octane/scripts/init.sh

@@ -0,0 +1,97 @@
+#!/bin/sh -eu
+
+# Fallback to app
+role=${LARAVEL_ROLE:-app}
+
+# Set PDF generation browser path based on architecture
+export SNAPPDF_CHROMIUM_PATH=/usr/bin/google-chrome-stable
+if [ "$(dpkg --print-architecture)" = "arm64" ]; then
+    export SNAPPDF_CHROMIUM_PATH=/usr/bin/chromium
+fi
+
+# Check for default CMD, flag(s) or empty CMD
+if [ "$*" = 'frankenphp php-cli artisan octane:frankenphp' ] || [ "${1#-}" != "$1" ] || [ "$#" -eq  "0" ]; then
+
+    if [ "--help" = "$1" ]; then
+        echo [CMD]
+        echo "This image will execute specific CMDs based on the environment variable LARAVEL_ROLE"
+        echo
+        echo "LARAVEL_ROLE=app:       frankenphp php-cli artisan octane:frankenphp (default)"
+        echo "LARAVEL_ROLE=worker:    frankenphp php-cli artisan queue:work"
+        echo "LARAVEL_ROLE=scheduler: frankenphp php-cli artisan schedule:work"
+        echo
+        echo [FLAGS]
+        echo To the CMD defined by LARAVEL_ROLE can be extended with flags for artisan commands
+        echo
+        echo Available flags can be displaced:
+        echo docker run --rm invoiceninja/invoiceninja-debian frankenphp php-cli artisan help octane:frankenphp
+        echo docker run --rm invoiceninja/invoiceninja-debian frankenphp php-cli artisan queue:work
+        echo docker run --rm invoiceninja/invoiceninja-debian frankenphp php-cli artisan schedule:work
+        echo
+        echo Example:
+        echo docker run -e LARAVEL_ROLE=worker invoiceninja/invoiceninja-debian --verbose --sleep=3 --tries=3 --max-time=3600
+        echo
+        echo [Deployment]
+        echo Docker compose is recommended
+        echo
+        echo Example:
+        echo https://github.com/invoiceninja/dockerfiles/blob/octane/debian/docker-compose.yml
+        echo
+        exit 0
+    fi
+
+    # Run app
+    if [ "${role}" = "app" ]; then
+        cmd="frankenphp php-cli artisan octane:frankenphp"
+
+        # Check for required folders and create if needed, relevant for bind mounts
+        # It is not possible to chown, as we are not executing this script as root
+        [ -d /var/www/html/storage/app/public ] || mkdir -p /var/www/html/storage/app/public
+        [ -d /app/storage/framework/sessions ] || mkdir -p /app/storage/framework/sessions
+        [ -d /app/storage/framework/views ] || mkdir -p /app/storage/framework/views
+        [ -d /app/storage/framework/cache ] || mkdir -p /app/storage/framework/cache
+        [ -d /app/storage/logs ] || mkdir -p /app/storage/logs
+
+        if [ "$APP_ENV" = "production" ]; then
+            frankenphp php-cli artisan migrate --force
+            frankenphp php-cli artisan cache:clear # Clear after the migration
+            frankenphp php-cli artisan ninja:design-update
+            frankenphp php-cli artisan optimize
+
+            # If first IN run, it needs to be initialized
+            if [ "$(frankenphp php-cli artisan tinker --execute='echo Schema::hasTable("accounts") && !App\Models\Account::all()->first();')" = "1" ]; then
+                echo "Running initialization..."
+
+                frankenphp php-cli artisan db:seed --force
+
+                if [ -n "${IN_USER_EMAIL}" ] && [ -n "${IN_PASSWORD}" ]; then
+                    frankenphp php-cli artisan ninja:create-account --email "${IN_USER_EMAIL}" --password "${IN_PASSWORD}"
+                else
+                    echo "Initialization failed - Set IN_USER_EMAIL and IN_PASSWORD in .env"
+                    exit 1
+                fi
+            fi
+        fi
+
+        echo "Production setup completed"
+    # Run worker
+    elif [ "${role}" = "worker" ]; then
+        cmd="frankenphp php-cli artisan queue:work"
+    # Run scheduler
+    elif [ "${role}" = "scheduler" ]; then
+        cmd="frankenphp php-cli artisan schedule:work"
+    # Invalid role
+    else
+        echo "Invalid role: ${role}"
+        exit 1
+    fi
+
+    # Append flag(s) to role cmd
+    if [ "${1#-}" != "$1" ]; then
+        set -- ${cmd} "$@"
+    else
+        set -- ${cmd}
+    fi
+fi
+
+exec "$@"