Update env

Set QUEUE_CONNECTION=database as default
Set trusted proxy value to allow invoiceninja to read nginx headers (#356 )
2026-01-01 03:57:25 +01:00 · 2021-06-07 08:01:09 +10:00 · 2021-05-27 00:32:56 +08:00 · 2021-05-21 18:32:42 +08:00 · 2021-05-18 09:55:04 +08:00 · 2021-05-17 09:41:20 +08:00
8 changed files with 112 additions and 15 deletions
--- a/charts/invoiceninja/Chart.yaml
+++ b/charts/invoiceninja/Chart.yaml
@@ -13,11 +13,11 @@ type: application
 # This is the chart version. This version number should be incremented each time you make changes
 # to the chart and its templates, including the app version.
 # Versions are expected to follow Semantic Versioning (https://semver.org/)
-version: 0.4.0
+version: 0.5.1
 # This is the version number of the application being deployed. This version number should be
 # incremented each time you make changes to the application. Versions are not expected to
 # follow Semantic Versioning. They should reflect the version the application is using.
-appVersion: 5.1.61
+appVersion: 5.1.64
 keywords:
  - invoiceninja
 home: https://invoiceninja.github.io/dockerfiles
--- a/charts/invoiceninja/README.md
+++ b/charts/invoiceninja/README.md
@@ -1,6 +1,6 @@
 # Invoice Ninja Helm Chart

-This helm chart installs a Invoice Ninja and its dependencies into a running
+This helm chart installs Invoice Ninja (IN) and its dependencies into a running
 Kubernetes cluster.

 The chart installs the [Invoice Ninja](https://hub.docker.com/r/invoiceninja/invoiceninja) docker image.
@@ -81,15 +81,20 @@ The following table shows the configuration options for the Invoice Ninja helm c
 | `serviceAccountName` | Name of a service account for the Invoice Ninja pods             | `default`                                               |
 | `debug`              | Turn on debug mode on Invoice Ninja                              | `false`                                                 |
 | `appKey`             | Laravel Application Key                                          | _random 32 character alphanumeric string_               |
+| `userEmail`          | Initial user email address                                       | `admin@example.com`                                     |
+| `userPassword`       | Initial user password                                            | `changeme!`                                             |
 | `logChannel`         | Name of log channel to use                                       | `nil`                                                   |
 | `broadcastDriver`    | Name of broadcast driver to use                                  | `nil`                                                   |
 | `cacheDriver`        | Name of cache driver to use                                      | `nil`                                                   |
 | `sessionDriver`      | Name of session driver to use                                    | `nil`                                                   |
 | `queueConnection`    | Name of queue connection to use                                  | `nil`                                                   |
 | `snappdf`            | Use snappdf instead of Phantom JS PDF generation                 | `true`                                                  |
+| `mailer`             | Name of the mailer to use (log, smtp, etc.)                      | `log`                                                   |
+| `requireHttps`       | Force HTTPS for internal connections to Invoice Ninja (see #349) | `false`                                                 |
 | `extraEnvVars`       | Extra environment variables to be set on Invoice Ninja container | `{}`                                                    |
 | `extraEnvVarsCM`     | Name of existing ConfigMap containing extra env vars             | `nil`                                                   |
 | `extraEnvVarsSecret` | Name of existing Secret containing extra env vars                | `nil`                                                   |
+| `trustedProxy`       | List of trusted proxies for Invoice Ninja to communicate with the nginx proxy | `'*'`                                                   |

 ### Invoice Ninja deployment parameters

@@ -236,10 +241,49 @@ The above command sets the number of replicas to 3 for a highly available (HA) s

 Alternatively, a YAML file that specifies the values for the parameters can be provided while [installing](https://helm.sh/docs/helm/helm_install/) the chart. For example,

+```yaml
+# values.yaml
+appKey: changeit
+replicaCount: 3
+nginx:
+  replicaCount: 3
+redis:
+  cluster:
+    slaveCount: 3
+  password: changeit
+mariadb:
+  auth:
+    rootPassword: changeit
+    password: changeit
+```
+
 ```bash
 helm install invoiceninja -f values.yaml invoiceninja/invoiceninja
 ```

+## Setting Environment Variables
+
+Should you need to inject any environment variables such as those in [here](https://github.com/invoiceninja/dockerfiles/blob/master/env) into the `invoiceninja` container, you can use the `extraEnvVars` option:
+
+```yaml
+# ... values.yaml file
+# In this example, we are setting the SMTP MAIL_HOST to be 'smtp.mailtrap.io'
+extraEnvVars:
+  - name: MAIL_HOST
+    value: 'smtp.mailtrap.io' # all values must be strings, so other types must be surrounded in quotes
+```
+
+Alternatively you can provide the name of an existing `configmap` or `secret` object:
+
+```bash
+kubectl create configmap examplemap --from-literal=MAIL_HOST='smtp.mailtrap.io'
+```
+
+```yaml
+# ... values.yaml file
+extraEnvVarsCM: examplemap
+```
+
 ## Upgrading

 Nothing yet.
--- a/charts/invoiceninja/templates/_helpers.tpl
+++ b/charts/invoiceninja/templates/_helpers.tpl
@@ -59,14 +59,14 @@ Create the name of the service account to use
 Return the proper Storage Class
 */}}
 {{- define "invoiceninja.public.storageClass" -}}
-{{- include "common.storage.class" (dict "persistence" .Values.persistence "global" .Values.global) -}}
+{{- include "common.storage.class" (dict "persistence" .Values.persistence.public "global" .Values.global) -}}
 {{- end -}}

 {{/*
 Return the proper Storage Class
 */}}
 {{- define "invoiceninja.storage.storageClass" -}}
-{{- include "common.storage.class" (dict "persistence" .Values.persistence "global" .Values.global) -}}
+{{- include "common.storage.class" (dict "persistence" .Values.persistence.storage "global" .Values.global) -}}
 {{- end -}}

 {{/*
--- a/charts/invoiceninja/templates/configmap.yaml
+++ b/charts/invoiceninja/templates/configmap.yaml
@@ -13,20 +13,25 @@ metadata:
  {{- end }}
 data:
  {{- if .Values.nginx.ingress.enabled }}
+  {{- if .Values.nginx.ingress.tls }}
+  APP_URL: "https://{{ .Values.nginx.ingress.hostname }}"
+  {{- else }}
  APP_URL: "http://{{ .Values.nginx.ingress.hostname }}"
+  {{- end }}
  {{- else }}
  APP_URL: "http://{{ include "common.names.fullname" . }}"
  {{- end }}
  APP_DEBUG: {{ .Values.debug | quote }}
-  DB_HOST1: {{ include "invoiceninja.databaseHost" . | quote }}
-  DB_PORT1: {{ include "invoiceninja.databasePort" . | quote }}
-  DB_USERNAME1: {{ include "invoiceninja.databaseUser" . | quote }}
-  DB_DATABASE1: {{ include "invoiceninja.databaseName" . | quote }}
+  DB_HOST: {{ include "invoiceninja.databaseHost" . | quote }}
+  DB_PORT: {{ include "invoiceninja.databasePort" . | quote }}
+  DB_USERNAME: {{ include "invoiceninja.databaseUser" . | quote }}
+  DB_DATABASE: {{ include "invoiceninja.databaseName" . | quote }}
  {{- if .Values.logChannel }}
  LOG_CHANNEL: {{ .Values.logChannel | quote }}
  {{- else }}
  LOG_CHANNEL: stderr
  {{- end }}
+  MAIL_MAILER: {{ .Values.mailer | quote }}
  {{- if .Values.broadcastDriver }}
  BROADCAST_DRIVER: {{ .Values.broadcastDriver | quote }}
  {{- else if or .Values.redis.enabled .Values.externalRedis.host }}
@@ -56,3 +61,5 @@ data:
  REDIS_CACHE_CONNECTION: {{ include "invoiceninja.redisCacheConnection" . | quote }}
  REDIS_QUEUE_CONNECTION: {{ include "invoiceninja.redisQueueConnection" . | quote }}
  SESSION_CONNECTION: {{ include "invoiceninja.redisSessionConnection" . | quote }}
+  REQUIRE_HTTPS: {{ .Values.requireHttps | quote }}
+  TRUSTED_PROXIES: {{ .Values.trustedProxies | quote }}
--- a/charts/invoiceninja/templates/deployment.yaml
+++ b/charts/invoiceninja/templates/deployment.yaml
@@ -63,12 +63,14 @@ spec:
            - -cx
            - |
              COUNTER=0;
-              while [  $COUNTER -lt 120 ]; do
-                if mysqladmin ping -h "$DB_HOST1" -P $DB_PORT1 --silent; then
+              [[ -z "${DB_HOST1}" ]] || DB_HOST="${DB_HOST1}";
+              [[ -z "${DB_PORT1}" ]] || DB_PORT="${DB_PORT1}";
+              while [ $COUNTER -lt 120 ]; do
+                if mysqladmin ping -h "$DB_HOST" -P $DB_PORT --silent; then
                  exit 0;
                fi;
                let COUNTER=COUNTER+1;
-                echo "Waiting for DB ($DB_HOST1:$DB_PORT1)"
+                echo "Waiting for DB... Trying again in 2s";
                sleep 2;
              done;
              echo "Did NOT see a database after 240 secs!";
@@ -81,6 +83,18 @@ spec:
          envFrom:
            - configMapRef:
                name: {{ include "common.names.fullname" . }}
+            {{- if .Values.extraEnvVarsCM }}
+            - configMapRef:
+                name: {{ include "common.tplvalues.render" (dict "value" .Values.extraEnvVarsCM "context" $) }}
+            {{- end }}
+            {{- if .Values.extraEnvVarsSecret }}
+            - secretRef:
+                name: {{ include "common.tplvalues.render" (dict "value" .Values.extraEnvVarsSecret "context" $) }}
+            {{- end }}
+          env:
+            {{- if .Values.extraEnvVars }}
+              {{- include "common.tplvalues.render" (dict "value" .Values.extraEnvVars "context" $) | nindent 12 }}
+            {{- end }}
        {{- if and .Values.podSecurityContext .Values.volumePermissions.enabled (or .Values.persistence.public.enabled .Values.persistence.storage.enabled) }}
        - name: volume-permissions
          image: {{ include "invoiceninja.volumePermissions.image" . }}
@@ -148,7 +162,7 @@ spec:
                name: {{ include "common.tplvalues.render" (dict "value" .Values.extraEnvVarsSecret "context" $) }}
            {{- end }}
          env:
-            - name: DB_PASSWORD1
+            - name: DB_PASSWORD
              valueFrom:
                secretKeyRef:
                  name: {{ include "invoiceninja.databaseSecretName" . }}
@@ -160,6 +174,10 @@ spec:
                  name: {{ include "invoiceninja.redisSecretName" . }}
                  key: redis-password
            {{- end }}
+            {{- if .Values.userEmail }}
+            - name: IN_USER_EMAIL
+              value: {{ .Values.userEmail | quote }}
+            {{- end }}
            {{- if .Values.extraEnvVars }}
              {{- include "common.tplvalues.render" (dict "value" .Values.extraEnvVars "context" $) | nindent 12 }}
            {{- end }}
--- a/charts/invoiceninja/templates/secret.yaml
+++ b/charts/invoiceninja/templates/secret.yaml
@@ -57,4 +57,7 @@ data:
  APP_KEY: {{ .Values.appKey | b64enc | quote }}
  {{- else }}
  APP_KEY: {{ randAlphaNum 32 | b64enc | quote }}
-  {{- end }}
+  {{- end }}
+  {{- if .Values.userPassword }}
+  IN_PASSWORD: {{ .Values.userPassword | b64enc | quote }}
+  {{- end }}
--- a/charts/invoiceninja/values.yaml
+++ b/charts/invoiceninja/values.yaml
@@ -18,7 +18,7 @@
 image:
  registry: docker.io
  repository: invoiceninja/invoiceninja
-  tag: 5.1.61
+  tag: 5.1.64
  ## Defaults to 'Always' if image tag is 'latest', else set to 'IfNotPresent'
  ## ref: http://kubernetes.io/docs/user-guide/images/#pre-pulling-images
  ##
@@ -38,6 +38,16 @@ debug: false
 ##
 appKey: ""

+## Email of user to create first run
+## If not specified, default user email will be "admin@example.com"
+##
+userEmail: ""
+
+## Password of user to create on first run
+## If not specified, default user password will be "changeme!"
+##
+userPassword: ""
+
 ## Name of log channel to use
 ##
 logChannel: ""
@@ -58,10 +68,24 @@ sessionDriver: ""
 ##
 queueConnection: ""

+## List of trusted proxies for Invoice Ninja to communicate with the nginx proxy
+##
+trustedProxies: "*"
+
 ## Use local or Phantom JS PDF generation
 ##
 snappdf: true

+## Name of queue connection to use (use "log" for debug)
+## Please check the ref below for any other env you may need to define
+## ref: https://github.com/invoiceninja/invoiceninja/blob/v5-stable/config/mail.php
+##
+mailer: log
+
+## Force HTTPS for all connections to Invoice Ninja
+##
+requireHttps: false
+
 ## String to partially override fullname template (will maintain the release name)
 ##
 # nameOverride:
--- a/1
+++ b/1
@@ -4,6 +4,7 @@ APP_KEY=<insert your generated key in here>
 APP_DEBUG=true
 REQUIRE_HTTPS=false
 PHANTOMJS_PDF_GENERATION=false
+QUEUE_CONNECTION=database

 # DB connection
 DB_HOST=db
Author	SHA1	Message	Date
David Bomba	e2db08f207	Update env Set QUEUE_CONNECTION=database as default	2021-06-07 08:01:09 +10:00
Ffaen	59291d8687	Set trusted proxy value to allow invoiceninja to read nginx headers (#356 ) Fixes #355	2021-05-27 00:32:56 +08:00
Ween Jiann	6f747207ec	Add values for initial user creation to Chart (#350 ) * Added user details in values.yaml * Fix grammer in README.md * Remove '1' suffix in DB config * Add user password to secret * Bump version * Updated wait-db * Bump IN version	2021-05-21 18:32:42 +08:00
Ween Jiann	c2aabd14ac	Fix storageClass (#353 )	2021-05-18 09:55:04 +08:00
Ffaen	07f1e601ab	Update README to add information on env variables (#351 ) * Update README to add information on env variables References #349 * Set APP_URL to https if TLS enabled	2021-05-17 09:41:20 +08:00