mirror of
https://github.com/k8s-at-home/charts.git
synced 2025-01-23 23:49:12 +00:00
[firefly-iii] Added firefly-iii chart (#1576)
* Added firefly-iii chart * pre-commit check fixes * Fixed helm lint * Fixed review comments * Updated Values.yaml for helm-docs
This commit is contained in:
parent
f4dde05b33
commit
3cf5a1b679
26
charts/stable/firefly-iii/.helmignore
Normal file
26
charts/stable/firefly-iii/.helmignore
Normal file
@ -0,0 +1,26 @@
|
|||||||
|
# Patterns to ignore when building packages.
|
||||||
|
# This supports shell glob matching, relative path matching, and
|
||||||
|
# negation (prefixed with !). Only one pattern per line.
|
||||||
|
.DS_Store
|
||||||
|
# Common VCS dirs
|
||||||
|
.git/
|
||||||
|
.gitignore
|
||||||
|
.bzr/
|
||||||
|
.bzrignore
|
||||||
|
.hg/
|
||||||
|
.hgignore
|
||||||
|
.svn/
|
||||||
|
# Common backup files
|
||||||
|
*.swp
|
||||||
|
*.bak
|
||||||
|
*.tmp
|
||||||
|
*~
|
||||||
|
# Various IDEs
|
||||||
|
.project
|
||||||
|
.idea/
|
||||||
|
*.tmproj
|
||||||
|
.vscode/
|
||||||
|
# OWNERS file for Kubernetes
|
||||||
|
OWNERS
|
||||||
|
# helm-docs templates
|
||||||
|
*.gotmpl
|
43
charts/stable/firefly-iii/Chart.yaml
Normal file
43
charts/stable/firefly-iii/Chart.yaml
Normal file
@ -0,0 +1,43 @@
|
|||||||
|
---
|
||||||
|
apiVersion: v2
|
||||||
|
appVersion: version-5.6.14
|
||||||
|
description: "Firefly III: a personal finances manager"
|
||||||
|
name: firefly-iii
|
||||||
|
version: 0.0.1
|
||||||
|
kubeVersion: ">=1.16.0-0"
|
||||||
|
keywords:
|
||||||
|
- firefly-iii
|
||||||
|
- firefly
|
||||||
|
home: "https://github.com/k8s-at-home/charts/tree/master/charts/stable/firefly-iii"
|
||||||
|
icon: "https://www.firefly-iii.org/assets/logo/color.png"
|
||||||
|
sources:
|
||||||
|
- https://github.com/firefly-iii/firefly-iii
|
||||||
|
maintainers:
|
||||||
|
- name: "bikram990"
|
||||||
|
url: "https://github.com/bikram990"
|
||||||
|
dependencies:
|
||||||
|
- name: common
|
||||||
|
repository: https://library-charts.k8s-at-home.com
|
||||||
|
version: 4.4.1
|
||||||
|
- name: mariadb
|
||||||
|
version: 11.0.2
|
||||||
|
repository: https://charts.bitnami.com/bitnami
|
||||||
|
condition: mariadb.enabled
|
||||||
|
- name: postgresql
|
||||||
|
version: 11.1.28
|
||||||
|
repository: https://charts.bitnami.com/bitnami
|
||||||
|
condition: postgresql.enabled
|
||||||
|
- name: redis
|
||||||
|
version: 16.9.0
|
||||||
|
repository: https://charts.bitnami.com/bitnami
|
||||||
|
condition: redis.enabled
|
||||||
|
annotations:
|
||||||
|
artifacthub.io/changes: |-
|
||||||
|
- kind: changed
|
||||||
|
description: Added `common` chart dependency to version 4.4.1
|
||||||
|
- kind: changed
|
||||||
|
description: Added `mariadb` chart dependency to version 11.0.2
|
||||||
|
- kind: changed
|
||||||
|
description: Added `postgresql` chart dependency to version 11.1.28
|
||||||
|
- kind: changed
|
||||||
|
description: Added `redis` chart dependency to version 16.9.0
|
1
charts/stable/firefly-iii/templates/NOTES.txt
Normal file
1
charts/stable/firefly-iii/templates/NOTES.txt
Normal file
@ -0,0 +1 @@
|
|||||||
|
{{- include "common.notes.defaultNotes" . -}}
|
110
charts/stable/firefly-iii/templates/common.tpl
Normal file
110
charts/stable/firefly-iii/templates/common.tpl
Normal file
@ -0,0 +1,110 @@
|
|||||||
|
{{- define "firefly.DB_CONNECTION" -}}
|
||||||
|
{{- if .Values.postgresql.enabled }}
|
||||||
|
{{- printf "pgsql" -}}
|
||||||
|
{{- else if .Values.mariadb.enabled }}
|
||||||
|
{{- printf "mysql" -}}
|
||||||
|
{{- else -}}
|
||||||
|
{{- printf "sqlite" -}}
|
||||||
|
{{- end -}}
|
||||||
|
{{ end }}
|
||||||
|
|
||||||
|
{{- define "firefly.DB_HOST" -}}
|
||||||
|
{{- if .Values.postgresql.enabled }}
|
||||||
|
{{- $postgrestmp := printf "%s-%s" .Release.Name "postgresql"}}
|
||||||
|
{{- printf "%s" $postgrestmp -}}
|
||||||
|
{{- else if .Values.mariadb.enabled }}
|
||||||
|
{{- $mysqltmp := printf "%s-%s" .Release.Name "mariadb"}}
|
||||||
|
{{- printf "%s" $mysqltmp -}}
|
||||||
|
{{- else -}}
|
||||||
|
{{- printf "localhost" -}}
|
||||||
|
{{- end -}}
|
||||||
|
{{ end }}
|
||||||
|
|
||||||
|
{{- define "firefly.DB_PORT" -}}
|
||||||
|
{{- if .Values.postgresql.enabled }}
|
||||||
|
{{- printf "%s" "5432" -}}
|
||||||
|
{{- else if .Values.mariadb.enabled }}
|
||||||
|
{{- printf "%s" "3306" -}}
|
||||||
|
{{- else -}}
|
||||||
|
{{- printf "0" -}}
|
||||||
|
{{- end -}}
|
||||||
|
{{ end }}
|
||||||
|
|
||||||
|
{{- define "firefly.DB_USERNAME" -}}
|
||||||
|
{{- if .Values.postgresql.enabled }}
|
||||||
|
{{- printf "%s" .Values.postgresql.auth.username -}}
|
||||||
|
{{- else if .Values.mariadb.enabled }}
|
||||||
|
{{- printf "%s" .Values.mariadb.auth.username -}}
|
||||||
|
{{- else -}}
|
||||||
|
{{- printf "firefly" -}}
|
||||||
|
{{- end -}}
|
||||||
|
{{ end }}
|
||||||
|
|
||||||
|
{{- define "firefly.DB_DATABASE" -}}
|
||||||
|
{{- if .Values.postgresql.enabled }}
|
||||||
|
{{- printf "%s" .Values.postgresql.auth.database -}}
|
||||||
|
{{- else if .Values.mariadb.enabled }}
|
||||||
|
{{- printf "%s" .Values.mariadb.auth.database -}}
|
||||||
|
{{- else -}}
|
||||||
|
{{- printf "" -}}
|
||||||
|
{{- end -}}
|
||||||
|
{{ end }}
|
||||||
|
|
||||||
|
{{- define "firefly.DB_PASSWORD_SECRET" -}}
|
||||||
|
{{- if .Values.postgresql.enabled }}
|
||||||
|
{{- printf "%s-%s" .Release.Name "postgresql" -}}
|
||||||
|
{{- else if .Values.mariadb.enabled }}
|
||||||
|
{{- printf "%s-%s" .Release.Name "mariadb" -}}
|
||||||
|
{{- else -}}
|
||||||
|
{{- printf "firefly" -}}
|
||||||
|
{{- end -}}
|
||||||
|
{{ end }}
|
||||||
|
|
||||||
|
{{- define "firefly.DB_PASSWORD_SECRET_KEY" -}}
|
||||||
|
{{- if .Values.postgresql.enabled }}
|
||||||
|
{{- printf "%s" "password" -}}
|
||||||
|
{{- else if .Values.mariadb.enabled }}
|
||||||
|
{{- printf "%s" "mariadb-password" -}}
|
||||||
|
{{- else -}}
|
||||||
|
{{- printf "firefly" -}}
|
||||||
|
{{- end -}}
|
||||||
|
{{ end }}
|
||||||
|
|
||||||
|
|
||||||
|
# Database credentials. Make sure the database exists. I recommend a dedicated user for Firefly III
|
||||||
|
# For other database types, please see the FAQ: https://docs.firefly-iii.org/support/faq
|
||||||
|
# If you use Docker or similar, you can set these variables from a file by appending them with _FILE
|
||||||
|
# Use "pgsql" for PostgreSQL
|
||||||
|
# Use "mysql" for MySQL and MariaDB.
|
||||||
|
# Use "sqlite" for SQLite.
|
||||||
|
# DB_CONNECTION=mysql
|
||||||
|
# DB_HOST=db
|
||||||
|
# DB_PORT=3306
|
||||||
|
# DB_DATABASE=firefly
|
||||||
|
# DB_USERNAME=firefly
|
||||||
|
# DB_PASSWORD=secret_firefly_password
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
{{- include "common.values.setup" . }}
|
||||||
|
|
||||||
|
{{/* Append the hardcoded settings */}}
|
||||||
|
{{- define "firefly.harcodedValues" -}}
|
||||||
|
env:
|
||||||
|
DB_CONNECTION: {{ include "firefly.DB_CONNECTION" . | quote }}
|
||||||
|
DB_HOST: {{ include "firefly.DB_HOST" . | quote }}
|
||||||
|
DB_PORT: {{ include "firefly.DB_PORT" . | quote }}
|
||||||
|
DB_DATABASE: {{ include "firefly.DB_DATABASE" . | quote }}
|
||||||
|
DB_USERNAME: {{ include "firefly.DB_USERNAME" . | quote }}
|
||||||
|
DB_PASSWORD:
|
||||||
|
{{ if or (.Values.postgresql.enabled) (.Values.mariadb.enabled) }}
|
||||||
|
valueFrom:
|
||||||
|
secretKeyRef:
|
||||||
|
name: {{ include "firefly.DB_PASSWORD_SECRET" . | quote }}
|
||||||
|
key: {{ include "firefly.DB_PASSWORD_SECRET_KEY" . | quote }}
|
||||||
|
{{- end }}
|
||||||
|
{{- end -}}
|
||||||
|
{{- $_ := mergeOverwrite .Values (include "firefly.harcodedValues" . | fromYaml) -}}
|
||||||
|
|
||||||
|
{{/* Render the templates */}}
|
||||||
|
{{ include "common.all" . }}
|
108
charts/stable/firefly-iii/templates/importer.yaml
Normal file
108
charts/stable/firefly-iii/templates/importer.yaml
Normal file
@ -0,0 +1,108 @@
|
|||||||
|
{{- include "common.values.setup" . -}}
|
||||||
|
{{- if .Values.importer.enabled -}}
|
||||||
|
{{- range .Values.importer.specs }}
|
||||||
|
---
|
||||||
|
apiVersion: apps/v1
|
||||||
|
kind: Deployment
|
||||||
|
metadata:
|
||||||
|
name: {{ printf "%s-%s-importer" (include "common.names.fullname" $) ( .importerName ) | quote }}
|
||||||
|
labels:
|
||||||
|
{{- include "common.labels" $ | nindent 4 }}
|
||||||
|
{{- with $.Values.importer.controllerLabels }}
|
||||||
|
{{- toYaml . | nindent 4 }}
|
||||||
|
{{- end }}
|
||||||
|
{{- with $.Values.importer.controllerAnnotations }}
|
||||||
|
annotations:
|
||||||
|
{{- toYaml . | nindent 4 }}
|
||||||
|
{{- end }}
|
||||||
|
spec:
|
||||||
|
replicas: {{ .replicaCount }}
|
||||||
|
selector:
|
||||||
|
matchLabels:
|
||||||
|
app.kubernetes.io/name: {{ printf "%s-%s-importer" (include "common.names.name" $) ( .importerName ) | quote }}
|
||||||
|
app.kubernetes.io/instance: {{ printf "%s-%s" ( $.Release.Name ) ( .importerName ) | quote }}
|
||||||
|
template:
|
||||||
|
metadata:
|
||||||
|
{{- with $.Values.importer.podAnnotations }}
|
||||||
|
annotations:
|
||||||
|
{{- toYaml . | nindent 8 }}
|
||||||
|
{{- end }}
|
||||||
|
labels:
|
||||||
|
app.kubernetes.io/name: {{ printf "%s-%s-importer" (include "common.names.name" $) ( .importerName ) | quote }}
|
||||||
|
app.kubernetes.io/instance: {{ printf "%s-%s" ( $.Release.Name ) ( .importerName ) | quote }}
|
||||||
|
spec:
|
||||||
|
{{- with $.Values.importer.imagePullSecrets }}
|
||||||
|
imagePullSecrets:
|
||||||
|
{{- toYaml . | nindent 8 }}
|
||||||
|
{{- end }}
|
||||||
|
{{- with $.Values.importer.podSecurityContext }}
|
||||||
|
securityContext:
|
||||||
|
{{- toYaml . | nindent 8 }}
|
||||||
|
{{- end }}
|
||||||
|
containers:
|
||||||
|
- name: {{ printf "%s-%s-importer" (include "common.names.name" $) ( .importerName ) | quote }}
|
||||||
|
{{- with $.Values.importer.securityContext }}
|
||||||
|
securityContext:
|
||||||
|
{{- toYaml . | nindent 12 }}
|
||||||
|
{{- end }}
|
||||||
|
image: "{{ $.Values.importer.image.repository }}:{{ $.Values.importer.image.tag }}"
|
||||||
|
imagePullPolicy: {{ $.Values.importer.image.pullPolicy }}
|
||||||
|
env:
|
||||||
|
- name: FIREFLY_III_ACCESS_TOKEN
|
||||||
|
value: {{ .accessToken }}
|
||||||
|
- name: FIREFLY_III_URL
|
||||||
|
value: "http://{{ include "common.names.fullname" $ }}:{{ $.Values.service.main.ports.http.port }}"
|
||||||
|
{{- if .vanityUrl }}
|
||||||
|
- name: VANITY_URL
|
||||||
|
value: {{ .vanityUrl }}
|
||||||
|
{{- end }}
|
||||||
|
- name: TRUSTED_PROXIES
|
||||||
|
value: {{ $.Values.env.TRUSTED_PROXIES | quote }}
|
||||||
|
ports:
|
||||||
|
- name: http
|
||||||
|
containerPort: 8080
|
||||||
|
protocol: TCP
|
||||||
|
livenessProbe:
|
||||||
|
tcpSocket:
|
||||||
|
port: http
|
||||||
|
readinessProbe:
|
||||||
|
tcpSocket:
|
||||||
|
port: http
|
||||||
|
{{- with $.Values.importer.resources }}
|
||||||
|
resources:
|
||||||
|
{{- toYaml . | nindent 12 }}
|
||||||
|
{{- end }}
|
||||||
|
{{- with $.Values.importer.nodeSelector }}
|
||||||
|
nodeSelector:
|
||||||
|
{{- toYaml . | nindent 8 }}
|
||||||
|
{{- end }}
|
||||||
|
{{- with $.Values.importer.affinity }}
|
||||||
|
affinity:
|
||||||
|
{{- toYaml . | nindent 8 }}
|
||||||
|
{{- end }}
|
||||||
|
{{- with $.Values.importer.tolerations }}
|
||||||
|
tolerations:
|
||||||
|
{{- toYaml . | nindent 8 }}
|
||||||
|
{{- end }}
|
||||||
|
---
|
||||||
|
apiVersion: v1
|
||||||
|
kind: Service
|
||||||
|
metadata:
|
||||||
|
name: {{ printf "%s-%s-importer" (include "common.names.fullname" $) ( .importerName ) | quote }}
|
||||||
|
labels:
|
||||||
|
{{- include "common.labels" $ | nindent 4 }}
|
||||||
|
{{- with $.Values.importer.controllerLabels }}
|
||||||
|
{{- toYaml . | nindent 4 }}
|
||||||
|
{{- end }}
|
||||||
|
spec:
|
||||||
|
type: ClusterIP
|
||||||
|
ports:
|
||||||
|
- port: {{ .port }}
|
||||||
|
targetPort: http
|
||||||
|
protocol: TCP
|
||||||
|
name: http
|
||||||
|
selector:
|
||||||
|
app.kubernetes.io/name: {{ printf "%s-%s-importer" (include "common.names.name" $) ( .importerName ) | quote }}
|
||||||
|
app.kubernetes.io/instance: {{ printf "%s-%s" ( $.Release.Name ) ( .importerName ) | quote }}
|
||||||
|
{{- end }}
|
||||||
|
{{- end }}
|
70
charts/stable/firefly-iii/templates/recurring-cron.yaml
Normal file
70
charts/stable/firefly-iii/templates/recurring-cron.yaml
Normal file
@ -0,0 +1,70 @@
|
|||||||
|
{{- include "common.values.setup" . -}}
|
||||||
|
{{- if .Values.cronjobs.recurring.enabled -}}
|
||||||
|
---
|
||||||
|
# ------------------- CronJob ------------------- #
|
||||||
|
{{- if .Capabilities.APIVersions.Has "batch/v1" }}
|
||||||
|
apiVersion: batch/v1
|
||||||
|
{{- else -}}
|
||||||
|
apiVersion: batch/v1beta1
|
||||||
|
{{- end }}
|
||||||
|
kind: CronJob
|
||||||
|
metadata:
|
||||||
|
name: {{ include "common.names.fullname" . }}-recurring-transactions
|
||||||
|
labels:
|
||||||
|
{{- include "common.labels" . | nindent 4 }}
|
||||||
|
spec:
|
||||||
|
schedule: {{ .Values.cronjobs.recurring.schedule | quote }}
|
||||||
|
concurrencyPolicy: Replace
|
||||||
|
{{- with .Values.cronjobs.recurring.successfulJobsHistoryLimit }}
|
||||||
|
successfulJobsHistoryLimit: {{ . }}
|
||||||
|
{{- end }}
|
||||||
|
{{- with .Values.cronjobs.recurring.failedJobsHistoryLimit }}
|
||||||
|
failedJobsHistoryLimit: {{ . }}
|
||||||
|
{{- end }}
|
||||||
|
jobTemplate:
|
||||||
|
spec:
|
||||||
|
template:
|
||||||
|
metadata:
|
||||||
|
name: {{ include "common.names.fullname" . }}-recurring-transactions
|
||||||
|
labels:
|
||||||
|
{{- include "common.labels.selectorLabels" . | nindent 12 }}
|
||||||
|
{{- with .Values.cronjobs.recurring.podAnnotations }}
|
||||||
|
annotations: {{- toYaml . | nindent 12 }}
|
||||||
|
{{- end }}
|
||||||
|
spec:
|
||||||
|
containers:
|
||||||
|
- name: recurring-transactions
|
||||||
|
image: "{{ .Values.cronjobs.recurring.image.repository }}:{{ .Values.cronjobs.recurring.image.tag }}"
|
||||||
|
imagePullPolicy: {{ .Values.cronjobs.recurring.image.pullPolicy }}
|
||||||
|
command:
|
||||||
|
- /usr/bin/curl
|
||||||
|
args:
|
||||||
|
- --silent
|
||||||
|
- --show-error
|
||||||
|
- --fail
|
||||||
|
- "http://{{ include "common.names.fullname" . }}:{{ .Values.service.main.ports.http.port }}/api/v1/cron/$(FIREFLY_III_TOKEN)"
|
||||||
|
resources:
|
||||||
|
{{- .Values.cronjobs.recurring.resources | toYaml | nindent 16 }}
|
||||||
|
env:
|
||||||
|
- name: FIREFLY_III_TOKEN
|
||||||
|
value: {{ .Values.env.STATIC_CRON_TOKEN }}
|
||||||
|
{{- with .Values.cronjobs.recurring.securityContext }}
|
||||||
|
securityContext: {{- toYaml . | nindent 16 }}
|
||||||
|
{{- end }}
|
||||||
|
{{- with .Values.cronjobs.recurring.nodeSelector }}
|
||||||
|
nodeSelector: {{- toYaml . | nindent 12 }}
|
||||||
|
{{- end }}
|
||||||
|
{{- with .Values.cronjobs.recurring.affinity }}
|
||||||
|
affinity: {{- toYaml . | nindent 12 }}
|
||||||
|
{{- end }}
|
||||||
|
{{- with .Values.cronjobs.recurring.tolerations }}
|
||||||
|
tolerations: {{- toYaml . | nindent 12 }}
|
||||||
|
{{- end }}
|
||||||
|
{{- with .Values.cronjobs.recurring.imagePullSecrets }}
|
||||||
|
imagePullSecrets: {{- toYaml . | nindent 12 }}
|
||||||
|
{{- end }}
|
||||||
|
{{- with .Values.cronjobs.recurring.podSecurityContext }}
|
||||||
|
securityContext: {{- toYaml . | nindent 12 }}
|
||||||
|
{{- end }}
|
||||||
|
restartPolicy: {{ .Values.cronjobs.recurring.restartPolicy }}
|
||||||
|
{{- end -}}
|
475
charts/stable/firefly-iii/values.yaml
Normal file
475
charts/stable/firefly-iii/values.yaml
Normal file
@ -0,0 +1,475 @@
|
|||||||
|
#
|
||||||
|
# IMPORTANT NOTE
|
||||||
|
#
|
||||||
|
# This chart inherits from our common library chart. You can check the default values/options here:
|
||||||
|
# https://github.com/k8s-at-home/library-charts/tree/main/charts/stable/common/values.yaml
|
||||||
|
#
|
||||||
|
|
||||||
|
image:
|
||||||
|
# -- image repository
|
||||||
|
repository: fireflyiii/core
|
||||||
|
# -- image pull policy
|
||||||
|
pullPolicy: IfNotPresent
|
||||||
|
# @default -- chart.appVersion
|
||||||
|
tag:
|
||||||
|
|
||||||
|
strategy:
|
||||||
|
type: Recreate
|
||||||
|
|
||||||
|
cronjobs:
|
||||||
|
recurring:
|
||||||
|
# -- Enable cronjob for creating recurring transactions
|
||||||
|
enabled: false
|
||||||
|
# -- Schedule time in UTC
|
||||||
|
schedule: "0 3 * * *"
|
||||||
|
image:
|
||||||
|
repository: curlimages/curl
|
||||||
|
pullPolicy: IfNotPresent
|
||||||
|
tag: 7.81.0
|
||||||
|
|
||||||
|
# -- How many pods to keep around for successful jobs
|
||||||
|
successfulJobsHistoryLimit: 3
|
||||||
|
|
||||||
|
# -- How many pods to keep around for failed jobs
|
||||||
|
failedJobsHistoryLimit: 1
|
||||||
|
|
||||||
|
# -- How to treat failed jobs
|
||||||
|
restartPolicy: OnFailure
|
||||||
|
|
||||||
|
imagePullSecrets: []
|
||||||
|
|
||||||
|
podAnnotations: {}
|
||||||
|
|
||||||
|
securityContext: {}
|
||||||
|
|
||||||
|
podSecurityContext: {}
|
||||||
|
|
||||||
|
resources: {}
|
||||||
|
|
||||||
|
nodeSelector: {}
|
||||||
|
|
||||||
|
tolerations: []
|
||||||
|
|
||||||
|
affinity: {}
|
||||||
|
|
||||||
|
importer:
|
||||||
|
# -- Deploy transaction importer
|
||||||
|
enabled: false
|
||||||
|
controllerAnnotations: {}
|
||||||
|
|
||||||
|
controllerLabels: {}
|
||||||
|
|
||||||
|
imagePullSecrets: []
|
||||||
|
|
||||||
|
podAnnotations: {}
|
||||||
|
|
||||||
|
securityContext: {}
|
||||||
|
|
||||||
|
podSecurityContext: {}
|
||||||
|
|
||||||
|
resources: {}
|
||||||
|
|
||||||
|
nodeSelector: {}
|
||||||
|
|
||||||
|
tolerations: []
|
||||||
|
|
||||||
|
affinity: {}
|
||||||
|
image:
|
||||||
|
repository: fireflyiii/data-importer
|
||||||
|
pullPolicy: IfNotPresent
|
||||||
|
tag: "version-0.8.0"
|
||||||
|
specs:
|
||||||
|
- importerName: default-importer
|
||||||
|
|
||||||
|
port: 8080
|
||||||
|
|
||||||
|
# -- Fill your user's personal access token here
|
||||||
|
accessToken: ""
|
||||||
|
|
||||||
|
replicaCount: 1
|
||||||
|
|
||||||
|
vanityUrl: ""
|
||||||
|
|
||||||
|
# -- environment variables. See [image docs](https://github.com/firefly-iii/firefly-iii/blob/main/.env.example) for more details.
|
||||||
|
# @default -- See below
|
||||||
|
env:
|
||||||
|
# -- You can leave this on "local". If you change it to production most console commands will ask for extra confirmation.
|
||||||
|
# Never set it to "testing".
|
||||||
|
APP_ENV: local
|
||||||
|
|
||||||
|
# -- Set to true if you want to see debug information in error screens.
|
||||||
|
APP_DEBUG: false
|
||||||
|
|
||||||
|
# This should be your email address.
|
||||||
|
# If you use Docker or similar, you can set this variable from a file by using SITE_OWNER_FILE
|
||||||
|
SITE_OWNER: mail@example.com
|
||||||
|
|
||||||
|
# The encryption key for your sessions. Keep this very secure.
|
||||||
|
# Change it to a string of exactly 32 chars or use something like `php artisan key:generate` to generate it.
|
||||||
|
# If you use Docker or similar, you can set this variable from a file by using APP_KEY_FILE
|
||||||
|
APP_KEY: SomeRandomStringOf32CharsExactly
|
||||||
|
|
||||||
|
# Firefly III will launch using this language (for new users and unauthenticated visitors)
|
||||||
|
# For a list of available languages: https://github.com/firefly-iii/firefly-iii/tree/main/resources/lang
|
||||||
|
#
|
||||||
|
# If text is still in English, remember that not everything may have been translated.
|
||||||
|
DEFAULT_LANGUAGE: en_US
|
||||||
|
|
||||||
|
# The locale defines how numbers are formatted.
|
||||||
|
# by default this value is the same as whatever the language is.
|
||||||
|
DEFAULT_LOCALE: equal
|
||||||
|
|
||||||
|
# -- Change this value to your preferred time zone.
|
||||||
|
# Example: Europe/Amsterdam
|
||||||
|
# For a list of supported time zones, see [this](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones)
|
||||||
|
TZ: Europe/Amsterdam
|
||||||
|
|
||||||
|
# TRUSTED_PROXIES is a useful variable when using Docker and/or a reverse proxy.
|
||||||
|
# Set it to ** and reverse proxies work just fine.
|
||||||
|
TRUSTED_PROXIES: "**"
|
||||||
|
|
||||||
|
# The log channel defines where your log entries go to.
|
||||||
|
# Several other options exist. You can use 'single' for one big fat error log (not recommended).
|
||||||
|
# Also available are 'syslog', 'errorlog' and 'stdout' which will log to the system itself.
|
||||||
|
# A rotating log option is 'daily', creates 5 files that (surprise) rotate.
|
||||||
|
# A cool option is 'papertrail' for cloud logging
|
||||||
|
# Default setting 'stack' will log to 'daily' and to 'stdout' at the same time.
|
||||||
|
LOG_CHANNEL: stack
|
||||||
|
|
||||||
|
#
|
||||||
|
# Used when logging to papertrail:
|
||||||
|
#
|
||||||
|
PAPERTRAIL_HOST: ""
|
||||||
|
PAPERTRAIL_PORT: ""
|
||||||
|
|
||||||
|
# Log level. You can set this from least severe to most severe:
|
||||||
|
# debug, info, notice, warning, error, critical, alert, emergency
|
||||||
|
# If you set it to debug your logs will grow large, and fast. If you set it to emergency probably
|
||||||
|
# nothing will get logged, ever.
|
||||||
|
APP_LOG_LEVEL: notice
|
||||||
|
|
||||||
|
# Audit log level.
|
||||||
|
# Set this to "emergency" if you dont want to store audit logs, leave on info otherwise.
|
||||||
|
AUDIT_LOG_LEVEL: info
|
||||||
|
|
||||||
|
# # Database credentials. Make sure the database exists. I recommend a dedicated user for Firefly III
|
||||||
|
# # For other database types, please see the FAQ: https://docs.firefly-iii.org/support/faq
|
||||||
|
# # If you use Docker or similar, you can set these variables from a file by appending them with _FILE
|
||||||
|
# # Use "pgsql" for PostgreSQL
|
||||||
|
# # Use "mysql" for MySQL and MariaDB.
|
||||||
|
# # Use "sqlite" for SQLite.
|
||||||
|
# DB_CONNECTION=mysql
|
||||||
|
# DB_HOST=db
|
||||||
|
# DB_PORT=3306
|
||||||
|
# DB_DATABASE=firefly
|
||||||
|
# DB_USERNAME=firefly
|
||||||
|
# DB_PASSWORD=secret_firefly_password
|
||||||
|
# leave empty or omit when not using a socket connection
|
||||||
|
DB_SOCKET: ""
|
||||||
|
|
||||||
|
# MySQL supports SSL. You can configure it here.
|
||||||
|
# If you use Docker or similar, you can set these variables from a file by appending them with _FILE
|
||||||
|
MYSQL_USE_SSL: false
|
||||||
|
MYSQL_SSL_VERIFY_SERVER_CERT: true
|
||||||
|
# You need to set at least of these options
|
||||||
|
MYSQL_SSL_CAPATH: /etc/ssl/certs/
|
||||||
|
MYSQL_SSL_CA: ""
|
||||||
|
MYSQL_SSL_CERT: ""
|
||||||
|
MYSQL_SSL_KEY: ""
|
||||||
|
MYSQL_SSL_CIPHER: ""
|
||||||
|
|
||||||
|
# PostgreSQL supports SSL. You can configure it here.
|
||||||
|
# If you use Docker or similar, you can set these variables from a file by appending them with _FILE
|
||||||
|
PGSQL_SSL_MODE: prefer
|
||||||
|
PGSQL_SSL_ROOT_CERT: ""
|
||||||
|
PGSQL_SSL_CERT: ""
|
||||||
|
PGSQL_SSL_KEY: ""
|
||||||
|
PGSQL_SSL_CRL_FILE: ""
|
||||||
|
|
||||||
|
# more PostgreSQL settings
|
||||||
|
PGSQL_SCHEMA: public
|
||||||
|
|
||||||
|
# If you're looking for performance improvements, you could install memcached or redis
|
||||||
|
CACHE_DRIVER: file
|
||||||
|
SESSION_DRIVER: file
|
||||||
|
|
||||||
|
# If you set either of the options above to 'redis', you might want to update these settings too
|
||||||
|
# If you use Docker or similar, you can set REDIS_HOST_FILE, REDIS_PASSWORD_FILE or
|
||||||
|
# REDIS_PORT_FILE to set the value from a file instead of from an environment variable
|
||||||
|
|
||||||
|
# can be tcp, unix or http
|
||||||
|
REDIS_SCHEME: tcp
|
||||||
|
|
||||||
|
# use only when using 'unix' for REDIS_SCHEME. Leave empty otherwise.
|
||||||
|
REDIS_PATH: ""
|
||||||
|
|
||||||
|
# use only when using 'tcp' or 'http' for REDIS_SCHEME. Leave empty otherwise.
|
||||||
|
REDIS_HOST: 127.0.0.1
|
||||||
|
REDIS_PORT: 6379
|
||||||
|
REDIS_PASSWORD: ""
|
||||||
|
|
||||||
|
# always use quotes and make sure redis db "0" and "1" exists. Otherwise change accordingly.
|
||||||
|
REDIS_DB: "0"
|
||||||
|
REDIS_CACHE_DB: "1"
|
||||||
|
|
||||||
|
# Cookie settings. Should not be necessary to change these.
|
||||||
|
# If you use Docker or similar, you can set COOKIE_DOMAIN_FILE to set
|
||||||
|
# the value from a file instead of from an environment variable
|
||||||
|
# Setting samesite to "strict" may give you trouble logging in.
|
||||||
|
COOKIE_PATH: "/"
|
||||||
|
COOKIE_DOMAIN: ""
|
||||||
|
COOKIE_SECURE: false
|
||||||
|
COOKIE_SAMESITE: lax
|
||||||
|
|
||||||
|
# -- If you want Firefly III to email you, update these settings
|
||||||
|
# For instructions, see [this](https://docs.firefly-iii.org/advanced-installation/email)
|
||||||
|
# If you use Docker or similar, you can set these variables from a file by appending them with _FILE
|
||||||
|
MAIL_MAILER: log
|
||||||
|
MAIL_HOST: ""
|
||||||
|
MAIL_PORT: 2525
|
||||||
|
MAIL_FROM: changeme@example.com
|
||||||
|
MAIL_USERNAME: ""
|
||||||
|
MAIL_PASSWORD: ""
|
||||||
|
MAIL_ENCRYPTION: ""
|
||||||
|
|
||||||
|
# Other mail drivers:
|
||||||
|
# If you use Docker or similar, you can set these variables from a file by appending them with _FILE
|
||||||
|
MAILGUN_DOMAIN: ""
|
||||||
|
MAILGUN_SECRET: ""
|
||||||
|
|
||||||
|
# If you are on EU region in mailgun, use api.eu.mailgun.net, otherwise use api.mailgun.net
|
||||||
|
# If you use Docker or similar, you can set this variable from a file by appending it with _FILE
|
||||||
|
MAILGUN_ENDPOINT: api.mailgun.net
|
||||||
|
|
||||||
|
# If you use Docker or similar, you can set these variables from a file by appending them with _FILE
|
||||||
|
MANDRILL_SECRET: ""
|
||||||
|
SPARKPOST_SECRET: ""
|
||||||
|
|
||||||
|
# -- Send mail on new registrations.
|
||||||
|
SEND_REGISTRATION_MAIL: true
|
||||||
|
# -- Send mail on errors.
|
||||||
|
SEND_ERROR_MESSAGE: true
|
||||||
|
# -- Send mail on logins from new IP.
|
||||||
|
SEND_LOGIN_NEW_IP_WARNING: true
|
||||||
|
|
||||||
|
# -- Send mail on recurring transactions.
|
||||||
|
# These messages contain (sensitive) transaction information:
|
||||||
|
SEND_REPORT_JOURNALS: false
|
||||||
|
|
||||||
|
# Set this value to true if you want to set the location
|
||||||
|
# of certain things, like transactions. Since this involves an external service, it's optional
|
||||||
|
# and disabled by default.
|
||||||
|
ENABLE_EXTERNAL_MAP: false
|
||||||
|
|
||||||
|
# The map will default to this location:
|
||||||
|
MAP_DEFAULT_LAT: 51.983333
|
||||||
|
MAP_DEFAULT_LONG: 5.916667
|
||||||
|
MAP_DEFAULT_ZOOM: 6
|
||||||
|
|
||||||
|
#
|
||||||
|
# Firefly III authentication settings
|
||||||
|
#
|
||||||
|
|
||||||
|
#
|
||||||
|
# Firefly III supports a few authentication methods:
|
||||||
|
# - 'web' (default, uses built in DB)
|
||||||
|
# - 'remote_user_guard' for Authelia etc
|
||||||
|
# Read more about these settings in the documentation.
|
||||||
|
# https://docs.firefly-iii.org/advanced-installation/authentication
|
||||||
|
#
|
||||||
|
# LDAP is no longer supported :(
|
||||||
|
#
|
||||||
|
AUTHENTICATION_GUARD: web
|
||||||
|
|
||||||
|
#
|
||||||
|
# Remote user guard settings
|
||||||
|
#
|
||||||
|
AUTHENTICATION_GUARD_HEADER: REMOTE_USER
|
||||||
|
AUTHENTICATION_GUARD_EMAIL: ""
|
||||||
|
|
||||||
|
#
|
||||||
|
# Extra authentication settings
|
||||||
|
#
|
||||||
|
CUSTOM_LOGOUT_URL: ""
|
||||||
|
|
||||||
|
# You can disable the X-Frame-Options header if it interferes with tools like
|
||||||
|
# Organizr. This is at your own risk. Applications running in frames run the risk
|
||||||
|
# of leaking information to their parent frame.
|
||||||
|
DISABLE_FRAME_HEADER: false
|
||||||
|
|
||||||
|
# You can disable the Content Security Policy header when you're using an ancient browser
|
||||||
|
# or any version of Microsoft Edge / Internet Explorer (which amounts to the same thing really)
|
||||||
|
# This leaves you with the risk of not being able to stop XSS bugs should they ever surface.
|
||||||
|
# This is at your own risk.
|
||||||
|
DISABLE_CSP_HEADER: false
|
||||||
|
|
||||||
|
# If you wish to track your own behavior over Firefly III, set valid analytics tracker information here.
|
||||||
|
# Nobody uses this except for me on the demo site. But hey, feel free to use this if you want to.
|
||||||
|
# Do not prepend the TRACKER_URL with http:// or https://
|
||||||
|
# The only tracker supported is Matomo.
|
||||||
|
# You can set the following variables from a file by appending them with _FILE:
|
||||||
|
TRACKER_SITE_ID: ""
|
||||||
|
TRACKER_URL: ""
|
||||||
|
|
||||||
|
#
|
||||||
|
# Firefly III supports webhooks. These are security sensitive and must be enabled manually first.
|
||||||
|
#
|
||||||
|
ALLOW_WEBHOOKS: false
|
||||||
|
|
||||||
|
#
|
||||||
|
# -- The static cron job token can be useful when you use Docker and wish to manage cron jobs.
|
||||||
|
# 1. Set this token to any 32-character value (this is important!).
|
||||||
|
# 2. Use this token in the cron URL instead of a user's command line token.
|
||||||
|
#
|
||||||
|
# For more info: https://docs.firefly-iii.org/firefly-iii/advanced-installation/cron/
|
||||||
|
#
|
||||||
|
# You can set this variable from a file by appending it with _FILE
|
||||||
|
#
|
||||||
|
STATIC_CRON_TOKEN: ""
|
||||||
|
|
||||||
|
# You can fine tune the start-up of a Docker container by editing these environment variables.
|
||||||
|
# Use this at your own risk. Disabling certain checks and features may result in lost of inconsistent data.
|
||||||
|
# However if you know what you're doing you can significantly speed up container start times.
|
||||||
|
# Set each value to true to enable, or false to disable.
|
||||||
|
|
||||||
|
# Set this to true to build all locales supported by Firefly III.
|
||||||
|
# This may take quite some time (several minutes) and is generally not recommended.
|
||||||
|
# If you wish to change or alter the list of locales, start your Docker container with
|
||||||
|
# `docker run -v locale.gen:/etc/locale.gen -e DKR_BUILD_LOCALE=true`
|
||||||
|
# and make sure your preferred locales are in your own locale.gen.
|
||||||
|
DKR_BUILD_LOCALE: false
|
||||||
|
|
||||||
|
# Check if the SQLite database exists. Can be skipped if you're not using SQLite.
|
||||||
|
# Won't significantly speed up things.
|
||||||
|
DKR_CHECK_SQLITE: true
|
||||||
|
|
||||||
|
# Run database creation and migration commands. Disable this only if you're 100% sure the DB exists
|
||||||
|
# and is up to date.
|
||||||
|
DKR_RUN_MIGRATION: true
|
||||||
|
|
||||||
|
# Run database upgrade commands. Disable this only when you're 100% sure your DB is up-to-date
|
||||||
|
# with the latest fixes (outside of migrations!)
|
||||||
|
DKR_RUN_UPGRADE: true
|
||||||
|
|
||||||
|
# Verify database integrity. Includes all data checks and verifications.
|
||||||
|
# Disabling this makes Firefly III assume your DB is intact.
|
||||||
|
DKR_RUN_VERIFY: true
|
||||||
|
|
||||||
|
# Run database reporting commands. When disabled, Firefly III won't go over your data to report current state.
|
||||||
|
# Disabling this should have no impact on data integrity or safety but it won't warn you of possible issues.
|
||||||
|
DKR_RUN_REPORT: true
|
||||||
|
|
||||||
|
# Generate OAuth2 keys.
|
||||||
|
# When disabled, Firefly III won't attempt to generate OAuth2 Passport keys. This won't be an issue, IFF (if and only if)
|
||||||
|
# you had previously generated keys already and they're stored in your database for restoration.
|
||||||
|
DKR_RUN_PASSPORT_INSTALL: true
|
||||||
|
|
||||||
|
# Leave the following configuration vars as is.
|
||||||
|
# Unless you like to tinker and know what you're doing.
|
||||||
|
APP_NAME: FireflyIII
|
||||||
|
BROADCAST_DRIVER: log
|
||||||
|
QUEUE_DRIVER: sync
|
||||||
|
CACHE_PREFIX: firefly
|
||||||
|
PUSHER_KEY: ""
|
||||||
|
IPINFO_TOKEN: ""
|
||||||
|
PUSHER_SECRET: ""
|
||||||
|
PUSHER_ID: ""
|
||||||
|
DEMO_USERNAME: ""
|
||||||
|
DEMO_PASSWORD: ""
|
||||||
|
IS_HEROKU: false
|
||||||
|
|
||||||
|
# -- Set UI layout version
|
||||||
|
FIREFLY_III_LAYOUT: v1
|
||||||
|
|
||||||
|
#
|
||||||
|
# If you have trouble configuring your Firefly III installation, DON'T BOTHER setting this variable.
|
||||||
|
# It won't work. It doesn't do ANYTHING. Don't believe the lies you read online. I'm not joking.
|
||||||
|
# This configuration value WILL NOT HELP.
|
||||||
|
#
|
||||||
|
# Notable exception to this rule is Synology, which, according to some users, will use APP_URL to rewrite stuff.
|
||||||
|
#
|
||||||
|
# This variable is ONLY used in some of the emails Firefly III sends around. Nowhere else.
|
||||||
|
# So when configuring anything WEB related this variable doesn't do anything. Nothing
|
||||||
|
#
|
||||||
|
# If you're stuck I understand you get desperate but look SOMEWHERE ELSE.
|
||||||
|
#
|
||||||
|
APP_URL: http://localhost
|
||||||
|
|
||||||
|
# -- Configures service settings for the chart. Normally this does not need to be modified.
|
||||||
|
# @default -- See values.yaml
|
||||||
|
service:
|
||||||
|
main:
|
||||||
|
ports:
|
||||||
|
http:
|
||||||
|
port: 8080
|
||||||
|
|
||||||
|
ingress:
|
||||||
|
# -- Enable and configure ingress settings for the chart under this key.
|
||||||
|
# @default -- See values.yaml
|
||||||
|
main:
|
||||||
|
enabled: false
|
||||||
|
hosts:
|
||||||
|
- host: chart-example.local
|
||||||
|
paths:
|
||||||
|
- path: /
|
||||||
|
pathType: Prefix
|
||||||
|
service:
|
||||||
|
port: http
|
||||||
|
|
||||||
|
# -- Configure persistence settings for the chart under this key.
|
||||||
|
# @default -- See values.yaml
|
||||||
|
persistence:
|
||||||
|
config:
|
||||||
|
enabled: false
|
||||||
|
uploads:
|
||||||
|
# -- Enable persistence for uploading attachments for transactions
|
||||||
|
enabled: false
|
||||||
|
type: pvc
|
||||||
|
mountPath: "/var/www/html/storage/upload"
|
||||||
|
readOnly: false
|
||||||
|
accessMode: ReadWriteOnce
|
||||||
|
size: 1Gi
|
||||||
|
retain: true
|
||||||
|
|
||||||
|
# -- Enable and configure mariadb subchart under this key.
|
||||||
|
# For more options see [mariadb chart documentation](https://github.com/bitnami/charts/tree/master/bitnami/mariadb)
|
||||||
|
# @default -- See values.yaml
|
||||||
|
# https://github.com/bitnami/charts/tree/master/bitnami/mariadb/#installing-the-chart
|
||||||
|
mariadb:
|
||||||
|
enabled: false
|
||||||
|
# primary:
|
||||||
|
# persistence:
|
||||||
|
# enabled: true
|
||||||
|
auth:
|
||||||
|
rootPassword: ""
|
||||||
|
username: "firefly"
|
||||||
|
# password: "password"
|
||||||
|
database: "firefly"
|
||||||
|
|
||||||
|
# -- Enable and configure postgresql subchart under this key.
|
||||||
|
# For more options see [postgresql chart documentation](https://github.com/bitnami/charts/tree/master/bitnami/postgresql)
|
||||||
|
# @default -- See values.yaml
|
||||||
|
# https://github.com/bitnami/charts/tree/master/bitnami/postgresql/#installing-the-chart
|
||||||
|
postgresql:
|
||||||
|
enabled: false
|
||||||
|
auth:
|
||||||
|
# postgresPassword: ""
|
||||||
|
username: "firefly"
|
||||||
|
# password: ""
|
||||||
|
database: "firefly"
|
||||||
|
# postgresqlUsername: "firefly"
|
||||||
|
# postgresqlPassword: ""
|
||||||
|
# postgresqlDatabase: "firefly"
|
||||||
|
# persistence:
|
||||||
|
# enabled: true
|
||||||
|
# storageClass:
|
||||||
|
# accessModes:
|
||||||
|
# - ReadWriteOnce
|
||||||
|
|
||||||
|
# -- Enable and configure redis subchart under this key.
|
||||||
|
# For more options see [redis chart documentation](https://github.com/bitnami/charts/tree/master/bitnami/redis)
|
||||||
|
# @default -- See values.yaml
|
||||||
|
redis:
|
||||||
|
enabled: false
|
||||||
|
# auth:
|
||||||
|
# enabled: false
|
Loading…
Reference in New Issue
Block a user