fix(kiwix-serve): Serve all .zim files in the data dir (#3848)

* fix(kiwix-serve): Serve all .zim files in the data dir

* whops

* add installation notes

* move to stable

* Update charts/stable/kiwix-serve/questions.yaml

Signed-off-by: Stavros Kois <47820033+stavros-k@users.noreply.github.com>

Signed-off-by: Stavros Kois <47820033+stavros-k@users.noreply.github.com>

charts/stable/kiwix-serve/Chart.yaml

@@ -1,7 +1,3 @@
-annotations:
-  truecharts.org/SCALE-support: "true"
-  truecharts.org/catagories: |
-    - Productivity
 apiVersion: v2
 appVersion: "latest"
 dependencies:
@@ -9,7 +5,7 @@ dependencies:
     repository: https://library-charts.truecharts.org
     version: 10.5.10
 deprecated: false
-description: Kiwix enables you to have the whole Wikipedia at hand wherever you go! [br]Remove download link after download complete.[/br]
+description: Kiwix enables you to have the whole Wikipedia at hand wherever you go!
 home: https://truecharts.org/docs/charts/incubator/kiwix-serve
 icon: https://truecharts.org/img/hotlink-ok/chart-icons/kiwix-serve.png
 keywords:
@@ -25,5 +21,10 @@ sources:
   - https://github.com/truecharts/charts/tree/master/charts/incubator/kiwix-serve
   - https://www.kiwix.org/
   - https://hub.docker.com/r/kiwix/kiwix-serve/
+  - https://github.com/kiwix/kiwix-tools/blob/master/docker/server
 type: application
-version: 0.0.27
+version: 1.0.0
+annotations:
+  truecharts.org/SCALE-support: "true"
+  truecharts.org/catagories: |
+    - Productivity

charts/stable/kiwix-serve/docs/installation_notes.md

@@ -0,0 +1,16 @@
+# Installation Notes
+
+You need to have at least one `.zim` file.
+
+You can download a `.zim` file from [here](https://wiki.kiwix.org/wiki/Content)
+
+## ZIM Files
+
+For 1 `.zim` file:
+
+- Enter the download link in the `DOWNLOAD` field box. You have to remove the link afterwards,
+  otherwise it will keep re-downloading the file on each start.
+
+For 1 or more `.zim` files:
+
+- Mount `Data Storage` to a Host Path, and place your `.zim` files there.

charts/stable/kiwix-serve/questions.yaml

@@ -13,23 +13,23 @@ questions:
 # Include{controllerExpert}
 # Include{controllerExpertExtraArgs}
   - variable: env
-    group: "Container Configuration"
+    group: Container Configuration
-    label: "Image Environment"
+    label: Image Environment
     schema:
       additional_attrs: true
       type: dict
       attrs:
         - variable: DOWNLOAD
-          label: "DOWNLOAD"
+          label: DOWNLOAD
-          description: "Add download link here to download contents httpswiki.kiwix.orgwikiContent"
+          description: Add download link here to download contents https://wiki.kiwix.org/wiki/Content. You have to remove link after it's downloaded.
           schema:
             type: string
-            default: "http://download.kiwix.org/zim/wikipedia_en_chemistry_nopic.zim"
+            default: ""
 # Include{containerConfig}
 # Include{serviceRoot}
         - variable: main
-          label: "Main Service"
+          label: Main Service
-          description: "The Primary service on which the healthcheck runs, often the webUI"
+          description: The Primary service on which the healthcheck runs, often the webUI
           schema:
             additional_attrs: true
             type: dict
@@ -37,22 +37,22 @@ questions:
 # Include{serviceSelectorLoadBalancer}
 # Include{serviceSelectorExtras}
                     - variable: main
-                      label: "Main Service Port Configuration"
+                      label: Main Service Port Configuration
                       schema:
                         additional_attrs: true
                         type: dict
                         attrs:
                           - variable: port
-                            label: "Port"
+                            label: Port
-                            description: "This port exposes the container port on the service"
+                            description: This port exposes the container port on the service
                             schema:
                               type: int
-                              default: 8040
+                              default: 10323
                               required: true
-# Include{advancedPortTCP}
+# Include{advancedPortHTTP}
                                 - variable: targetPort
-                                  label: "Target Port"
+                                  label: Target Port
-                                  description: "The internal(!) port on the container the Application runs on"
+                                  description: The internal(!) port on the container the Application runs on
                                   schema:
                                     type: int
                                     default: 80
@@ -62,8 +62,8 @@ questions:
 # Include{serviceList}
 # Include{persistenceRoot}
         - variable: data
-          label: "data Storage"
+          label: data Storage
-          description: "Container Path data"
+          description: Container Path data
           schema:
             additional_attrs: true
             type: dict
@@ -73,7 +73,7 @@ questions:
 # Include{persistenceList}
 # Include{ingressRoot}
         - variable: main
-          label: "Main Ingress"
+          label: Main Ingress
           schema:
             additional_attrs: true
             type: dict
@@ -86,42 +86,42 @@ questions:
 # Include{security}
 # Include{securityContextAdvancedRoot}
               - variable: privileged
-                label: "Privileged mode"
+                label: Privileged mode
                 schema:
                   type: boolean
                   default: false
               - variable: readOnlyRootFilesystem
-                label: "ReadOnly Root Filesystem"
+                label: ReadOnly Root Filesystem
                 schema:
                   type: boolean
                   default: false
               - variable: allowPrivilegeEscalation
-                label: "Allow Privilege Escalation"
+                label: Allow Privilege Escalation
                 schema:
                   type: boolean
                   default: false
               - variable: runAsNonRoot
-                label: "runAsNonRoot"
+                label: runAsNonRoot
                 schema:
                   type: boolean
                   default: false
 # Include{securityContextAdvanced}
 # Include{podSecurityContextRoot}
         - variable: runAsUser
-          label: "runAsUser"
+          label: runAsUser
-          description: "The UserID of the user running the application"
+          description: The UserID of the user running the application
           schema:
             type: int
             default: 0
         - variable: runAsGroup
-          label: "runAsGroup"
+          label: runAsGroup
-          description: The groupID this App of the user running the application"
+          description: The groupID this App of the user running the application
           schema:
             type: int
             default: 0
         - variable: fsGroup
-          label: "fsGroup"
+          label: fsGroup
-          description: "The group that should own ALL storage."
+          description: The group that should own ALL storage.
           schema:
             type: int
             default: 568

charts/stable/kiwix-serve/values.yaml

@@ -1,26 +1,33 @@
-env:
-  DOWNLOAD: http://download.kiwix.org/zim/wikipedia_en_chemistry_nopic.zim
 image:
   pullPolicy: IfNotPresent
   repository: tccr.io/truecharts/kiwix-serve
-  tag: latest@sha256:30bc36fa6d197997987d2f11d3beb6b7f7d87cdff5fbabc30763441a106515de
+  tag: v3.3.0@sha256:1b4f364630ed6bf4431ab7c79551fee25f594555b84f31d3449af2397b880fa5
-persistence:
+
-  data:
+args: ["*.zim"]
-    enabled: true
+
-    mountPath: /data
 podSecurityContext:
   runAsGroup: 0
   runAsUser: 0
+
 securityContext:
   readOnlyRootFilesystem: false
   runAsNonRoot: false
+
+env:
+  DOWNLOAD: http://download.kiwix.org/zim/wikipedia_en_chemistry_nopic.zim
+
 service:
   main:
     ports:
       main:
-        port: 8040
+        port: 10323
-        protocol: TCP
+        protocol: HTTP
         targetPort: 80
 
+persistence:
+  data:
+    enabled: true
+    mountPath: /data
+
 portal:
   enabled: true

cspell.config.yaml

@@ -61,9 +61,9 @@ words:
   - entrypoints
   - eptgmk
   - fireshare
+  - flatnotes
   - flemarr
   - Flemmarr
-  - flatnotes
   - flushtables
   - forcegc
   - fullname
@@ -100,6 +100,7 @@ words:
   - jovyan
   - keepalive
   - killswitch
+  - Kiwix
   - kjeld
   - kube
   - kubeconfig