From 32bd8f09765028b947db2f8dfdf43e133fbe0f6f Mon Sep 17 00:00:00 2001
From: alexandra catalina <git@garbage.world>
Date: Thu, 4 Apr 2024 09:44:19 -0700
Subject: [PATCH] docs(values): add more comments and examples to values.yaml

---
 values.yaml | 46 ++++++++++++++++++++++++++++++++++++----------
 1 file changed, 36 insertions(+), 10 deletions(-)

diff --git a/values.yaml b/values.yaml
index 9c29b77..567ff93 100644
--- a/values.yaml
+++ b/values.yaml
@@ -391,17 +391,43 @@ gitea:
     #   customProfileUrl:
     #   customEmailUrl:
 
-  ## @param gitea.config.server.SSH_PORT SSH port for rootlful Forgejo image
-  ## @param gitea.config.server.SSH_LISTEN_PORT SSH port for rootless Forgejo image
+  # Every value described in the [Cheat
+  # Sheet](https://forgejo.org/docs/latest/admin/config-cheat-sheet/) can be set
+  # as a Helm value.  Configuration sections map to (lowercased) YAML blocks,
+  # while the keys themselves remain in all caps.
   config:
-    #  APP_NAME: "Forgejo: Git with a cup of tea"
-    #  RUN_MODE: dev
-    server:
-      SSH_PORT: 22 # rootful image
-      SSH_LISTEN_PORT: 2222 # rootless image
-  #
-  #  security:
-  #    PASSWORD_COMPLEXITY: spec
+    # # values in the DEFAULT section
+    # # (https://forgejo.org/docs/latest/admin/config-cheat-sheet/#overall-default)
+    # # are un-namespaced
+    # #
+    # APP_NAME: "Forgejo: Git with a cup of tea"
+    # RUN_MODE: dev
+    #
+    # # if you're using an externally managed database (recommended;
+    # # https://codeberg.org/forgejo-contrib/forgejo-helm#external-database):
+    # # https://forgejo.org/docs/latest/admin/config-cheat-sheet/#database-database
+    # database:
+    #   DB_TYPE: postgres # supported values are mysql, postgres, mssql, sqlite3
+    #   HOST: postgresql-svc
+    #   NAME: forgejo-db
+    #   USER: forgejo
+    #
+    # # https://forgejo.org/docs/latest/admin/config-cheat-sheet/#server-server
+    # server:
+    #   # @param gitea.config.server.SSH_PORT SSH port for rootlful Forgejo image
+    #   # @param gitea.config.server.SSH_LISTEN_PORT SSH port for rootless Forgejo image
+    #   SSH_PORT: 22 # rootful image
+    #   SSH_LISTEN_PORT: 2222 # rootless image
+    #
+    # # https://forgejo.org/docs/latest/admin/config-cheat-sheet/#security-security
+    # security:
+    #   PASSWORD_COMPLEXITY: spec
+    #
+    # # nested blocks are supported:
+    # ui:
+    #   # https://forgejo.org/docs/latest/admin/config-cheat-sheet/#ui---metadata-uimeta
+    #   metadata:
+    #     AUTHOR: "Forger"
 
   ## @param gitea.additionalConfigSources Additional configuration from secret or configmap
   additionalConfigSources: []