docs(values): add more comments and examples to values.yaml

This commit is contained in:
alexandra catalina 2024-04-04 09:44:19 -07:00
parent 4b33a8b103
commit 32bd8f0976

View file

@ -391,17 +391,43 @@ gitea:
# customProfileUrl: # customProfileUrl:
# customEmailUrl: # customEmailUrl:
## @param gitea.config.server.SSH_PORT SSH port for rootlful Forgejo image # Every value described in the [Cheat
## @param gitea.config.server.SSH_LISTEN_PORT SSH port for rootless Forgejo image # 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: config:
# APP_NAME: "Forgejo: Git with a cup of tea" # # values in the DEFAULT section
# RUN_MODE: dev # # (https://forgejo.org/docs/latest/admin/config-cheat-sheet/#overall-default)
server: # # are un-namespaced
SSH_PORT: 22 # rootful image # #
SSH_LISTEN_PORT: 2222 # rootless image # APP_NAME: "Forgejo: Git with a cup of tea"
# # RUN_MODE: dev
# security: #
# PASSWORD_COMPLEXITY: spec # # 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 ## @param gitea.additionalConfigSources Additional configuration from secret or configmap
additionalConfigSources: [] additionalConfigSources: []