Readd Removed Documentation

README.md

@@ -10,13 +10,43 @@ This Helm Chart deploys both the Vikunja [frontend](https://hub.docker.com/r/vik
 
 ## Quickstart
 
-The majority of default values defined in `values.yaml` should be compatible for your deployment. Additionally, if you utilize an Ingress for both the API and Frontend, you will be able to access the frontend out of the box. However, it won't have any default credentials. So, you'll need to create an account using the registration button.
+Define ingress settings according to your controller (for both API and Frontend) to access the application.
+You can set all Vikunja API options as yaml under `api.configMaps.config.data`: https://vikunja.io/docs/config-options
 
-That should be it!
+For example, you can disable registration (if you do not with to allow others to register on your Vikunja), by providing the following values in your `values.yaml`:
+
+```yaml
+api:
+  configMaps:
+    config:
+      enabled: true
+      data:
+        config.yml:
+          service:
+            enableregistration: false
+```
+
+You can still create new users by executing the following command in the `api` container:
+
+```bash
+./vikunja user create --email <user@email.com> --user <user1> --password <password123>
+```
+
+## Advanced Features
+
+### Replicas
+
+Both Frontend and API can be configured to have replicas including autoscaling.
+When replicating the API, make sure to set up the redis cache as well
+by setting `api.configMaps.config.data.keyvalue.type` to `redis`,
+configuring the redis subchart (see [values.yaml](./values.yaml#L119))
+and the connection to Vikunja:
+https://vikunja.io/docs/config-options/#redis
 
 ### Use an existing file volume claim
 
-In the `values.yaml` file, you can either define your own existing Persistent Volume Claim (PVC) or have the chart create one on your behalf.
+In the `values.yaml` file, you can either define your own existing Persistent Volume Claim (PVC) 
+or have the chart create one on your behalf.
 
 To have the chart use your pre-existing PVC:
 
@@ -45,9 +75,12 @@ api:
 
 ### Utilizing environment variables from Kubernetes secrets
 
-Each environment variable that is "injected" into a pod can be sourced from a Kubernetes secret. This is useful when you wish to add values that you would rather keep as secrets in your GitOps repo, as environment variables in the pods.
+Each environment variable that is "injected" into a pod can be sourced from a Kubernetes secret.
+This is useful when you wish to add values that you would rather keep as secrets in your GitOps repo
+as environment variables in the pods.
 
-Assuming that you had a Kubernetes secret named `vikunja-env`, this is how you would add the value stored at key `VIKUNJA_DATABASE_PASSWORD` as the environment variable named `VIKUNJA_DATABASE_PASSWORD`:
+Assuming that you had a Kubernetes secret named `vikunja-env`, 
+this is how you would add the value stored at key `VIKUNJA_DATABASE_PASSWORD` as the environment variable named `VIKUNJA_DATABASE_PASSWORD`:
 
 ```yaml
 api:
@@ -60,7 +93,8 @@ api:
     VIKUNJA_DATABASE_USERNAME: "db-user"
 ```
 
-Alternatively, instead of defining each and every key, if the keys within the secret are the names of environment variables, you could also do the following:
+If the keys within the secret are the names of environment variables,
+you can simplify passing multiple values to this:
 
 ```yaml
 api:
@@ -126,27 +160,6 @@ frontend:
     type: daemonset
 ```  
 
-### Another Example of Modifying `config.yml` (Enabling Registration)
-
-You can disable registration (if you do not with to allow others to register on your Vikunja), by providing the following values in your `values.yaml`:
-
-```yaml
-api:
-  configMaps:
-    config:
-      enabled: true
-      data:
-        config.yml:
-          service:
-            enableregistration: false
-```
-
-If you need to create another user, you could opt to execute the following command on the `api` container:
-
-```bash
-./vikunja user create --email <user@email.com> --user <user1> --password <password123>
-```
-
 ## Publishing
 
 The following steps are automatically performed when a git tag for a new version is pushed to the repository.

values.yaml

@@ -97,16 +97,21 @@ frontend:
           paths:
             - path: "/"
       tls: []
-  # If you've used the "built-in" ingress in the api section, you don't need to specify VIKUNJA_API_URL as an environment variable here.
-  # If you've used something else, you'll need to provide the URL to the API here.
-  # env:
-  # VIKUNJA_API_URL: http://vikunja.local/api
+  # You only need to provide the URL to the API as environment variable here if you deviate from the "built-in" ingress in the api section.
+  #env:
+  #  VIKUNJA_API_URL: http://vikunja.local/api
 
 ##########################
 # END VIKUNJA COMPONENTS #
 ##########################
 
 # Optional Dependencies
+
+#  ┬─┐┌─┐┐─┐┌┐┐┌─┐┬─┐┬─┐┐─┐┐─┐┬
+#  │─┘│ │└─┐ │ │ ┬│┬┘├─ └─┐│ ││
+#  ┘  ┘─┘──┘ ┘ ┘─┘┘└┘┴─┘──┘└─\┘─┘
+# Please refer to PostgreSQL subchart for a full list of possible values
+# https://github.com/bitnami/charts/tree/main/bitnami/postgresql/#parameters
 postgresql:
   enabled: true
   global:
@@ -116,6 +121,11 @@ postgresql:
         database: vikunja
         password: vikunja
 
+#  ┬─┐┬─┐┬─┐o┐─┐
+#  │┬┘├─ │ ││└─┐
+#  ┘└┘┴─┘┘─┘┘──┘
+# Please refer to Redis subchart for a full list of possible values
+# https://github.com/bitnami/charts/tree/main/bitnami/redis/#parameters
 redis:
   enabled: false
   architecture: standalone