docs: add description block to ini overrides, clarify dot-style keys

This commit is contained in:
alexandra catalina 2024-04-21 12:56:39 -07:00
parent 1aa7c2cfa3
commit 1c57336426
2 changed files with 68 additions and 60 deletions

View file

@ -1004,11 +1004,16 @@ To comply with the Forgejo helm chart definition of the digest parameter, a "cus
| `gitea.podAnnotations` | Annotations for the Forgejo pod | `{}` | | `gitea.podAnnotations` | Annotations for the Forgejo pod | `{}` |
| `gitea.ssh.logLevel` | Configure OpenSSH's log level. Only available for root-based Forgejo image. | `INFO` | | `gitea.ssh.logLevel` | Configure OpenSSH's log level. Only available for root-based Forgejo image. | `INFO` |
### `app.ini` overrides ([full list](https://forgejo.org/docs/latest/admin/config-cheat-sheet/)) ### `app.ini` overrides
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.
| Name | Description | Value | | Name | Description | Value |
| ----------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------- | | ------------------------------------ | --------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------- |
| `gitea.config.APP_NAME` | Application name, used in the page title. | `Forgejo: Beyond coding. We forge.` | | `gitea.config.APP_NAME` | Application name, used in the page title | `Forgejo: Beyond coding. We forge.` |
| `gitea.config.RUN_MODE` | Application run mode, affects performance and debugging: `dev` or `prod` | `prod` | | `gitea.config.RUN_MODE` | Application run mode, affects performance and debugging: `dev` or `prod` | `prod` |
| `gitea.config.repository` | General repository settings | `{}` | | `gitea.config.repository` | General repository settings | `{}` |
| `gitea.config.cors` | Cross-origin resource sharing settings | `{}` | | `gitea.config.cors` | Cross-origin resource sharing settings | `{}` |
@ -1024,7 +1029,7 @@ To comply with the Forgejo helm chart definition of the digest parameter, a "cus
| `gitea.config.openid` | Configuration for authentication with OpenID (disabled by default) | `{}` | | `gitea.config.openid` | Configuration for authentication with OpenID (disabled by default) | `{}` |
| `gitea.config.oauth2_client` | OAuth2 client settings | `{}` | | `gitea.config.oauth2_client` | OAuth2 client settings | `{}` |
| `gitea.config.service` | Configuration for miscellaneous Forgejo services | `{}` | | `gitea.config.service` | Configuration for miscellaneous Forgejo services | `{}` |
| `gitea.config.ssh` | SSH key requirements | `{}` | | `gitea.config.ssh.minimum_key_sizes` | SSH minimum key sizes | `{}` |
| `gitea.config.webhook` | Webhook settings | `{}` | | `gitea.config.webhook` | Webhook settings | `{}` |
| `gitea.config.mailer` | Mailer configuration (disabled by default) | `{}` | | `gitea.config.mailer` | Mailer configuration (disabled by default) | `{}` |
| `gitea.config.email.incoming` | Configuration for handling incoming mail (disabled by default) | `{}` | | `gitea.config.email.incoming` | Configuration for handling incoming mail (disabled by default) | `{}` |
@ -1041,7 +1046,7 @@ To comply with the Forgejo helm chart definition of the digest parameter, a "cus
| `gitea.config.oauth2` | Settings for the [OAuth2 provider](https://forgejo.org/docs/latest/admin/oauth2-provider/) | `{}` | | `gitea.config.oauth2` | Settings for the [OAuth2 provider](https://forgejo.org/docs/latest/admin/oauth2-provider/) | `{}` |
| `gitea.config.i18n` | Internationalization settings | `{}` | | `gitea.config.i18n` | Internationalization settings | `{}` |
| `gitea.config.markup` | Configuration for advanced markup processors | `{}` | | `gitea.config.markup` | Configuration for advanced markup processors | `{}` |
| `gitea.config.highlight` | Syntax highlighting configuration | `{}` | | `gitea.config.highlight.mapping` | File extension to language mapping overrides for syntax highlighting | `{}` |
| `gitea.config.time` | Locale settings | `{}` | | `gitea.config.time` | Locale settings | `{}` |
| `gitea.config.migrations` | Settings for Git repository migrations | `{}` | | `gitea.config.migrations` | Settings for Git repository migrations | `{}` |
| `gitea.config.federation` | Federation configuration | `{}` | | `gitea.config.federation` | Federation configuration | `{}` |

View file

@ -408,18 +408,21 @@ gitea:
ssh: ssh:
logLevel: 'INFO' logLevel: 'INFO'
# Every value described in the [Cheat ## @section `app.ini` overrides
# Sheet](https://forgejo.org/docs/latest/admin/config-cheat-sheet/) can be set ## @descriptionStart
# as a Helm value. Configuration sections map to (lowercased) YAML blocks, ##
# while the keys themselves remain in all caps. ## Every value described in the [Cheat
# ## Sheet](https://forgejo.org/docs/latest/admin/config-cheat-sheet/) can be
## @section `app.ini` overrides ([full list](https://forgejo.org/docs/latest/admin/config-cheat-sheet/)) ## set as a Helm value. Configuration sections map to (lowercased) YAML
## blocks, while the keys themselves remain in all caps.
##
## @descriptionEnd
config: config:
# values in the DEFAULT section # values in the DEFAULT section
# (https://forgejo.org/docs/latest/admin/config-cheat-sheet/#overall-default) # (https://forgejo.org/docs/latest/admin/config-cheat-sheet/#overall-default)
# are un-namespaced # are un-namespaced
## @param gitea.config.APP_NAME Application name, used in the page title. ## @param gitea.config.APP_NAME Application name, used in the page title
APP_NAME: 'Forgejo: Beyond coding. We forge.' APP_NAME: 'Forgejo: Beyond coding. We forge.'
## @param gitea.config.RUN_MODE Application run mode, affects performance and debugging: `dev` or `prod` ## @param gitea.config.RUN_MODE Application run mode, affects performance and debugging: `dev` or `prod`
@ -467,8 +470,8 @@ gitea:
## @param gitea.config.service Configuration for miscellaneous Forgejo services ## @param gitea.config.service Configuration for miscellaneous Forgejo services
service: {} service: {}
## @param gitea.config.ssh SSH key requirements ## @param gitea.config.ssh.minimum_key_sizes SSH minimum key sizes
ssh: {} ssh.minimum_key_sizes: {}
## @param gitea.config.webhook Webhook settings ## @param gitea.config.webhook Webhook settings
webhook: {} webhook: {}
@ -518,8 +521,8 @@ gitea:
## @param gitea.config.markup Configuration for advanced markup processors ## @param gitea.config.markup Configuration for advanced markup processors
markup: {} markup: {}
## @param gitea.config.highlight Syntax highlighting configuration ## @param gitea.config.highlight.mapping File extension to language mapping overrides for syntax highlighting
highlight: {} highlight.mapping: {}
## @param gitea.config.time Locale settings ## @param gitea.config.time Locale settings
time: {} time: {}