diff --git a/community/komga/1.0.0/Chart.lock b/community/komga/1.0.0/Chart.lock new file mode 100644 index 0000000000..f3a114f080 --- /dev/null +++ b/community/komga/1.0.0/Chart.lock @@ -0,0 +1,6 @@ +dependencies: +- name: common + repository: file://../../../common + version: 1.0.9 +digest: sha256:c3eb00f142d5d1cdbff7843940c150a00bd916520363e6ee9f459ce61fa92b40 +generated: "2023-06-30T17:30:44.567540179+03:00" diff --git a/community/komga/1.0.0/Chart.yaml b/community/komga/1.0.0/Chart.yaml new file mode 100644 index 0000000000..fbd4d34323 --- /dev/null +++ b/community/komga/1.0.0/Chart.yaml @@ -0,0 +1,27 @@ +name: komga +description: Komga is a free and open source comics/mangas server. +annotations: + title: Komga +type: application +version: 1.0.0 +apiVersion: v2 +appVersion: '1.1.0' +kubeVersion: '>=1.16.0-0' +maintainers: + - name: truenas + url: https://www.truenas.com/ + email: dev@ixsystems.com +dependencies: + - name: common + repository: file://../../../common + version: 1.0.9 +home: https://komga.org +icon: https://komga.org/assets/media/logo.svg +sources: + - https://github.com/gotson/komga + - https://github.com/truenas/charts/tree/master/library/ix-dev/community/komga + - https://hub.docker.com/r/gotson/komga +keywords: + - media + - comics + - mangas diff --git a/community/komga/1.0.0/README.md b/community/komga/1.0.0/README.md new file mode 100644 index 0000000000..901df05ae6 --- /dev/null +++ b/community/komga/1.0.0/README.md @@ -0,0 +1,8 @@ +# Komga + +[Komga](https://github.com/gotson/komga) is a free and open source comics/mangas server. + +> When application is installed, a container will be launched with **root** privileges. +> This is required in order to apply the correct permissions to the `Komga` directories. +> Afterward, the `Komga` container will run as a **non**-root user (Default: `568`). +> All mounted storage(s) will be `chown`ed only if the parent directory does not match the configured user. diff --git a/community/komga/1.0.0/app-readme.md b/community/komga/1.0.0/app-readme.md new file mode 100644 index 0000000000..901df05ae6 --- /dev/null +++ b/community/komga/1.0.0/app-readme.md @@ -0,0 +1,8 @@ +# Komga + +[Komga](https://github.com/gotson/komga) is a free and open source comics/mangas server. + +> When application is installed, a container will be launched with **root** privileges. +> This is required in order to apply the correct permissions to the `Komga` directories. +> Afterward, the `Komga` container will run as a **non**-root user (Default: `568`). +> All mounted storage(s) will be `chown`ed only if the parent directory does not match the configured user. diff --git a/community/komga/1.0.0/charts/common-1.0.9.tgz b/community/komga/1.0.0/charts/common-1.0.9.tgz new file mode 100644 index 0000000000..635223efbc Binary files /dev/null and b/community/komga/1.0.0/charts/common-1.0.9.tgz differ diff --git a/community/komga/1.0.0/ci/basic-values.yaml b/community/komga/1.0.0/ci/basic-values.yaml new file mode 100644 index 0000000000..68c34063aa --- /dev/null +++ b/community/komga/1.0.0/ci/basic-values.yaml @@ -0,0 +1,11 @@ +komgaNetwork: + webPort: 31000 + +komgaRunAs: + user: 1000 + group: 1000 + +komgaStorage: + config: + type: hostPath + hostPath: /mnt/{{ .Release.Namespace }}/config diff --git a/community/komga/1.0.0/ci/extra-values.yaml b/community/komga/1.0.0/ci/extra-values.yaml new file mode 100644 index 0000000000..d8294bf899 --- /dev/null +++ b/community/komga/1.0.0/ci/extra-values.yaml @@ -0,0 +1,21 @@ +komgaConfig: + additionalEnvs: + - name: KOMGA_SESSIONTIMEOUT + value: 2d + - name: KOMGA_DELETE_EMPTY_READ_LISTS + value: false + +komgaNetwork: + webPort: 31000 + +komgaStorage: + config: + type: hostPath + hostPath: /mnt/{{ .Release.Namespace }}/config + additionalStorages: + - type: hostPath + hostPath: /mnt/{{ .Release.Namespace }}/comics + mountPath: /comics + - type: hostPath + hostPath: /mnt/{{ .Release.Namespace }}/mangas + mountPath: /mangas diff --git a/community/komga/1.0.0/ci/hostNet-values.yaml b/community/komga/1.0.0/ci/hostNet-values.yaml new file mode 100644 index 0000000000..c6ecd8f0ac --- /dev/null +++ b/community/komga/1.0.0/ci/hostNet-values.yaml @@ -0,0 +1,8 @@ +komgaNetwork: + webPort: 30000 + hostNetwork: true + +komgaStorage: + config: + type: hostPath + hostPath: /mnt/{{ .Release.Namespace }}/config diff --git a/community/komga/1.0.0/ix_values.yaml b/community/komga/1.0.0/ix_values.yaml new file mode 100644 index 0000000000..c9e5fd7a7b --- /dev/null +++ b/community/komga/1.0.0/ix_values.yaml @@ -0,0 +1,26 @@ +image: + repository: gotson/komga + pullPolicy: IfNotPresent + tag: '1.1.0' + +resources: + limits: + cpu: 4000m + memory: 8Gi + +komgaConfig: + additionalEnvs: [] + +komgaNetwork: + webPort: 30048 + hostNetwork: false + +komgaRunAs: + user: 568 + group: 568 + +komgaStorage: + config: + type: ixVolume + datasetName: config + additionalStorages: [] diff --git a/community/komga/1.0.0/metadata.yaml b/community/komga/1.0.0/metadata.yaml new file mode 100644 index 0000000000..469812c3a3 --- /dev/null +++ b/community/komga/1.0.0/metadata.yaml @@ -0,0 +1,8 @@ +runAsContext: + - userName: komga + groupName: komga + gid: 568 + uid: 568 + description: Komga can run as any non-root user. +capabilities: [] +hostMounts: [] diff --git a/community/komga/1.0.0/questions.yaml b/community/komga/1.0.0/questions.yaml new file mode 100644 index 0000000000..610001115e --- /dev/null +++ b/community/komga/1.0.0/questions.yaml @@ -0,0 +1,228 @@ +groups: + - name: Komga Configuration + description: Configure Komga + - name: User and Group Configuration + description: Configure User and Group for Komga + - name: Network Configuration + description: Configure Network for Komga + - name: Storage Configuration + description: Configure Storage for Komga + - name: Resources Configuration + description: Configure Resources for Komga + +portals: + web_portal: + protocols: + - "$kubernetes-resource_configmap_portal_protocol" + host: + - "$kubernetes-resource_configmap_portal_host" + ports: + - "$kubernetes-resource_configmap_portal_port" + path: "$kubernetes-resource_configmap_portal_path" + +questions: + - variable: TZ + group: Komga Configuration + label: Timezone + schema: + type: string + default: Etc/UTC + required: true + $ref: + - definitions/timezone + + - variable: komgaConfig + label: "" + group: Komga Configuration + schema: + type: dict + attrs: + - variable: additionalEnvs + label: Additional Environment Variables + description: Configure additional environment variables for Komga. + schema: + type: list + default: [] + items: + - variable: env + label: Environment Variable + schema: + type: dict + attrs: + - variable: name + label: Name + schema: + type: string + required: true + - variable: value + label: Value + schema: + type: string + required: true + + - variable: komgaRunAs + label: "" + group: User and Group Configuration + schema: + type: dict + attrs: + - variable: user + label: User ID + description: The user id that Komga will run as. + schema: + type: int + min: 2 + default: 568 + required: true + - variable: group + label: Group ID + description: The group id that Komga will run as. + schema: + type: int + min: 2 + default: 568 + required: true + + - variable: komgaNetwork + label: "" + group: Network Configuration + schema: + type: dict + attrs: + - variable: webPort + label: Web Port + description: The port for the Komga Web UI. + schema: + type: int + default: 30048 + min: 9000 + max: 65535 + required: true + - variable: hostNetwork + label: Host Network + description: | + Bind to the host network. It's recommended to keep this disabled.
+ schema: + type: boolean + default: false + + - variable: komgaStorage + label: "" + group: Storage Configuration + schema: + type: dict + attrs: + - variable: config + label: Komga Config Storage + description: The path to store Komga Configuration. + schema: + type: dict + attrs: + - variable: type + label: Type + description: | + ixVolume: Is dataset created automatically by the system.
+ Host Path: Is a path that already exists on the system. + schema: + type: string + required: true + default: "ixVolume" + enum: + - value: "hostPath" + description: Host Path (Path that already exists on the system) + - value: "ixVolume" + description: ixVolume (Dataset created automatically by the system) + - variable: datasetName + label: Dataset Name + schema: + type: string + show_if: [["type", "=", "ixVolume"]] + required: true + hidden: true + immutable: true + default: "config" + $ref: + - "normalize/ixVolume" + - variable: hostPath + label: Host Path + schema: + type: hostpath + show_if: [["type", "=", "hostPath"]] + immutable: true + required: true + - variable: additionalStorages + label: Additional Storage + description: Additional storage for Komga. + schema: + type: list + default: [] + items: + - variable: storageEntry + label: Storage Entry + schema: + type: dict + attrs: + - variable: type + label: Type + description: | + ixVolume: Is dataset created automatically by the system.
+ Host Path: Is a path that already exists on the system. + schema: + type: string + required: true + default: "ixVolume" + enum: + - value: "hostPath" + description: Host Path (Path that already exists on the system) + - value: "ixVolume" + description: ixVolume (Dataset created automatically by the system) + - variable: mountPath + label: Mount Path + description: The path inside the container to mount the storage. + schema: + type: path + required: true + - variable: hostPath + label: Host Path + description: The host path to use for storage. + schema: + type: hostpath + show_if: [["type", "=", "hostPath"]] + required: true + - variable: datasetName + label: Dataset Name + description: The name of the dataset to use for storage. + schema: + type: string + show_if: [["type", "=", "ixVolume"]] + required: true + immutable: true + default: "storage_entry" + $ref: + - "normalize/ixVolume" + + - variable: resources + group: Resources Configuration + label: "" + schema: + type: dict + attrs: + - variable: limits + label: Limits + schema: + type: dict + attrs: + - variable: cpu + label: CPU + description: CPU limit for Komga. + schema: + type: string + default: "4000m" + required: true + - variable: memory + label: Memory + description: Memory limit for Komga. + schema: + type: string + default: "8Gi" + required: true diff --git a/community/komga/1.0.0/templates/NOTES.txt b/community/komga/1.0.0/templates/NOTES.txt new file mode 100644 index 0000000000..ba4e01146c --- /dev/null +++ b/community/komga/1.0.0/templates/NOTES.txt @@ -0,0 +1 @@ +{{ include "ix.v1.common.lib.chart.notes" $ }} diff --git a/community/komga/1.0.0/templates/_komga.tpl b/community/komga/1.0.0/templates/_komga.tpl new file mode 100644 index 0000000000..113d196424 --- /dev/null +++ b/community/komga/1.0.0/templates/_komga.tpl @@ -0,0 +1,51 @@ +{{- define "komga.workload" -}} +workload: + komga: + enabled: true + primary: true + type: Deployment + podSpec: + hostNetwork: {{ .Values.komgaNetwork.hostNetwork }} + containers: + komga: + enabled: true + primary: true + imageSelector: image + securityContext: + runAsUser: {{ .Values.komgaRunAs.user }} + runAsGroup: {{ .Values.komgaRunAs.group }} + env: + SERVER_PORT: {{ .Values.komgaNetwork.webPort }} + KOMGA_CONFIGDIR: /config + KOMGA_DATABASE_FILE: /config/database.sqlite + SERVER_SERVLET_CONTEXT_PATH: "/" + {{ with .Values.komgaConfig.additionalEnvs }} + envList: + {{ range $env := . }} + - name: {{ $env.name }} + value: {{ $env.value }} + {{ end }} + {{ end }} + probes: + liveness: + enabled: true + type: http + port: "{{ .Values.komgaNetwork.webPort }}" + path: /actuator/health + readiness: + enabled: true + type: http + port: "{{ .Values.komgaNetwork.webPort }}" + path: /actuator/health + startup: + enabled: true + type: http + port: "{{ .Values.komgaNetwork.webPort }}" + path: /actuator/health + initContainers: + {{- include "ix.v1.common.app.permissions" (dict "containerName" "01-permissions" + "UID" .Values.komgaRunAs.user + "GID" .Values.komgaRunAs.group + "mode" "check" + "type" "init") | nindent 8 }} +{{- end -}} diff --git a/community/komga/1.0.0/templates/_persistence.tpl b/community/komga/1.0.0/templates/_persistence.tpl new file mode 100644 index 0000000000..56979bcc21 --- /dev/null +++ b/community/komga/1.0.0/templates/_persistence.tpl @@ -0,0 +1,34 @@ +{{- define "komga.persistence" -}} +persistence: + config: + enabled: true + type: {{ .Values.komgaStorage.config.type }} + datasetName: {{ .Values.komgaStorage.config.datasetName | default "" }} + hostPath: {{ .Values.komgaStorage.config.hostPath | default "" }} + targetSelector: + komga: + komga: + mountPath: /config + 01-permissions: + mountPath: /mnt/directories/config + tmp: + enabled: true + type: emptyDir + targetSelector: + komga: + komga: + mountPath: /tmp + {{- range $idx, $storage := .Values.komgaStorage.additionalStorages }} + {{ printf "komga-%v" (int $idx) }}: + enabled: true + type: {{ $storage.type }} + datasetName: {{ $storage.datasetName | default "" }} + hostPath: {{ $storage.hostPath | default "" }} + targetSelector: + komga: + komga: + mountPath: {{ $storage.mountPath }} + 01-permissions: + mountPath: /mnt/directories{{ $storage.mountPath }} + {{- end }} +{{- end -}} diff --git a/community/komga/1.0.0/templates/_portal.tpl b/community/komga/1.0.0/templates/_portal.tpl new file mode 100644 index 0000000000..f2413e934e --- /dev/null +++ b/community/komga/1.0.0/templates/_portal.tpl @@ -0,0 +1,12 @@ +{{- define "komga.portal" -}} +--- +apiVersion: v1 +kind: ConfigMap +metadata: + name: portal +data: + path: "/" + port: {{ .Values.komgaNetwork.webPort | quote }} + protocol: http + host: $node_ip +{{- end -}} diff --git a/community/komga/1.0.0/templates/_service.tpl b/community/komga/1.0.0/templates/_service.tpl new file mode 100644 index 0000000000..a51b193f77 --- /dev/null +++ b/community/komga/1.0.0/templates/_service.tpl @@ -0,0 +1,15 @@ +{{- define "komga.service" -}} +service: + komga: + enabled: true + primary: true + type: NodePort + targetSelector: komga + ports: + webui: + enabled: true + primary: true + port: {{ .Values.komgaNetwork.webPort }} + nodePort: {{ .Values.komgaNetwork.webPort }} + targetSelector: komga +{{- end -}} diff --git a/community/komga/1.0.0/templates/common.yaml b/community/komga/1.0.0/templates/common.yaml new file mode 100644 index 0000000000..3c86bc8d88 --- /dev/null +++ b/community/komga/1.0.0/templates/common.yaml @@ -0,0 +1,11 @@ +{{- include "ix.v1.common.loader.init" . -}} + +{{/* Merge the templates with Values */}} +{{- $_ := mustMergeOverwrite .Values (include "komga.workload" $ | fromYaml) -}} +{{- $_ := mustMergeOverwrite .Values (include "komga.persistence" $ | fromYaml) -}} +{{- $_ := mustMergeOverwrite .Values (include "komga.service" $ | fromYaml) -}} + +{{/* Create the configmap for portal manually*/}} +{{- include "komga.portal" $ -}} + +{{- include "ix.v1.common.loader.apply" . -}} diff --git a/community/komga/item.yaml b/community/komga/item.yaml new file mode 100644 index 0000000000..ba8d5fcb7b --- /dev/null +++ b/community/komga/item.yaml @@ -0,0 +1,8 @@ +icon_url: https://komga.org/assets/media/logo.svg +categories: + - media +screenshots: + - https://noted.lol/content/images/size/w1000/2023/01/komga-self-hosted-series.png +tags: + - comics + - mangas