docs: add description block to ini overrides, clarify dot-style keys
This commit is contained in:
alexandra catalina
parent
1aa7c2cfa3
commit
1c57336426
2 changed files with 68 additions and 60 deletions
103
README.md
103
README.md
|
|
@ -1004,56 +1004,61 @@ To comply with the Forgejo helm chart definition of the digest parameter, a "cus
|
|||
| `gitea.podAnnotations` | Annotations for the Forgejo pod | `{}` |
|
||||
| `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
|
||||
|
||||
| Name | Description | Value |
|
||||
| ----------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------- |
|
||||
| `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.repository` | General repository settings | `{}` |
|
||||
| `gitea.config.cors` | Cross-origin resource sharing settings | `{}` |
|
||||
| `gitea.config.ui` | User interface settings | `{}` |
|
||||
| `gitea.config.markdown` | Markdown parser settings | `{}` |
|
||||
| `gitea.config.server` | General server settings | `{}` |
|
||||
| `gitea.config.database` | Database configuration (only necessary with an [externally managed DB](https://codeberg.org/forgejo-contrib/forgejo-helm#external-database)). | `{}` |
|
||||
| `gitea.config.indexer` | Settings for what content is indexed and how | `{}` |
|
||||
| `gitea.config.queue` | Job queue configuration | `{}` |
|
||||
| `gitea.config.admin` | Admin user settings | `{}` |
|
||||
| `gitea.config.security` | Site security settings | `{}` |
|
||||
| `gitea.config.camo` | Settings for the [camo](https://github.com/cactus/go-camo) media proxy server (disabled by default) | `{}` |
|
||||
| `gitea.config.openid` | Configuration for authentication with OpenID (disabled by default) | `{}` |
|
||||
| `gitea.config.oauth2_client` | OAuth2 client settings | `{}` |
|
||||
| `gitea.config.service` | Configuration for miscellaneous Forgejo services | `{}` |
|
||||
| `gitea.config.ssh` | SSH key requirements | `{}` |
|
||||
| `gitea.config.webhook` | Webhook settings | `{}` |
|
||||
| `gitea.config.mailer` | Mailer configuration (disabled by default) | `{}` |
|
||||
| `gitea.config.email.incoming` | Configuration for handling incoming mail (disabled by default) | `{}` |
|
||||
| `gitea.config.cache` | Cache configuration | `{}` |
|
||||
| `gitea.config.session` | Session/cookie handling | `{}` |
|
||||
| `gitea.config.picture` | User avatar settings | `{}` |
|
||||
| `gitea.config.project` | Project board defaults | `{}` |
|
||||
| `gitea.config.attachment` | Issue and PR attachment configuration | `{}` |
|
||||
| `gitea.config.log` | Logging configuration | `{}` |
|
||||
| `gitea.config.cron` | Cron job configuration | `{}` |
|
||||
| `gitea.config.git` | Global settings for Git | `{}` |
|
||||
| `gitea.config.metrics` | Settings for the Prometheus endpoint (disabled by default) | `{}` |
|
||||
| `gitea.config.api` | Settings for the Swagger API documentation endpoints | `{}` |
|
||||
| `gitea.config.oauth2` | Settings for the [OAuth2 provider](https://forgejo.org/docs/latest/admin/oauth2-provider/) | `{}` |
|
||||
| `gitea.config.i18n` | Internationalization settings | `{}` |
|
||||
| `gitea.config.markup` | Configuration for advanced markup processors | `{}` |
|
||||
| `gitea.config.highlight` | Syntax highlighting configuration | `{}` |
|
||||
| `gitea.config.time` | Locale settings | `{}` |
|
||||
| `gitea.config.migrations` | Settings for Git repository migrations | `{}` |
|
||||
| `gitea.config.federation` | Federation configuration | `{}` |
|
||||
| `gitea.config.packages` | Package registry settings | `{}` |
|
||||
| `gitea.config.mirror` | Configuration for repository mirroring | `{}` |
|
||||
| `gitea.config.lfs` | Large File Storage configuration | `{}` |
|
||||
| `gitea.config.repo-avatar` | Repository avatar storage configuration | `{}` |
|
||||
| `gitea.config.avatar` | User/org avatar storage configuration | `{}` |
|
||||
| `gitea.config.storage` | General storage settings | `{}` |
|
||||
| `gitea.config.proxy` | Proxy configuration (disabled by default) | `{}` |
|
||||
| `gitea.config.actions` | Configuration for [Forgejo Actions](https://forgejo.org/docs/latest/user/actions/) | `{}` |
|
||||
| `gitea.config.other` | Uncategorized configuration options | `{}` |
|
||||
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 |
|
||||
| ------------------------------------ | --------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------- |
|
||||
| `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.repository` | General repository settings | `{}` |
|
||||
| `gitea.config.cors` | Cross-origin resource sharing settings | `{}` |
|
||||
| `gitea.config.ui` | User interface settings | `{}` |
|
||||
| `gitea.config.markdown` | Markdown parser settings | `{}` |
|
||||
| `gitea.config.server` | General server settings | `{}` |
|
||||
| `gitea.config.database` | Database configuration (only necessary with an [externally managed DB](https://codeberg.org/forgejo-contrib/forgejo-helm#external-database)). | `{}` |
|
||||
| `gitea.config.indexer` | Settings for what content is indexed and how | `{}` |
|
||||
| `gitea.config.queue` | Job queue configuration | `{}` |
|
||||
| `gitea.config.admin` | Admin user settings | `{}` |
|
||||
| `gitea.config.security` | Site security settings | `{}` |
|
||||
| `gitea.config.camo` | Settings for the [camo](https://github.com/cactus/go-camo) media proxy server (disabled by default) | `{}` |
|
||||
| `gitea.config.openid` | Configuration for authentication with OpenID (disabled by default) | `{}` |
|
||||
| `gitea.config.oauth2_client` | OAuth2 client settings | `{}` |
|
||||
| `gitea.config.service` | Configuration for miscellaneous Forgejo services | `{}` |
|
||||
| `gitea.config.ssh.minimum_key_sizes` | SSH minimum key sizes | `{}` |
|
||||
| `gitea.config.webhook` | Webhook settings | `{}` |
|
||||
| `gitea.config.mailer` | Mailer configuration (disabled by default) | `{}` |
|
||||
| `gitea.config.email.incoming` | Configuration for handling incoming mail (disabled by default) | `{}` |
|
||||
| `gitea.config.cache` | Cache configuration | `{}` |
|
||||
| `gitea.config.session` | Session/cookie handling | `{}` |
|
||||
| `gitea.config.picture` | User avatar settings | `{}` |
|
||||
| `gitea.config.project` | Project board defaults | `{}` |
|
||||
| `gitea.config.attachment` | Issue and PR attachment configuration | `{}` |
|
||||
| `gitea.config.log` | Logging configuration | `{}` |
|
||||
| `gitea.config.cron` | Cron job configuration | `{}` |
|
||||
| `gitea.config.git` | Global settings for Git | `{}` |
|
||||
| `gitea.config.metrics` | Settings for the Prometheus endpoint (disabled by default) | `{}` |
|
||||
| `gitea.config.api` | Settings for the Swagger API documentation endpoints | `{}` |
|
||||
| `gitea.config.oauth2` | Settings for the [OAuth2 provider](https://forgejo.org/docs/latest/admin/oauth2-provider/) | `{}` |
|
||||
| `gitea.config.i18n` | Internationalization settings | `{}` |
|
||||
| `gitea.config.markup` | Configuration for advanced markup processors | `{}` |
|
||||
| `gitea.config.highlight.mapping` | File extension to language mapping overrides for syntax highlighting | `{}` |
|
||||
| `gitea.config.time` | Locale settings | `{}` |
|
||||
| `gitea.config.migrations` | Settings for Git repository migrations | `{}` |
|
||||
| `gitea.config.federation` | Federation configuration | `{}` |
|
||||
| `gitea.config.packages` | Package registry settings | `{}` |
|
||||
| `gitea.config.mirror` | Configuration for repository mirroring | `{}` |
|
||||
| `gitea.config.lfs` | Large File Storage configuration | `{}` |
|
||||
| `gitea.config.repo-avatar` | Repository avatar storage configuration | `{}` |
|
||||
| `gitea.config.avatar` | User/org avatar storage configuration | `{}` |
|
||||
| `gitea.config.storage` | General storage settings | `{}` |
|
||||
| `gitea.config.proxy` | Proxy configuration (disabled by default) | `{}` |
|
||||
| `gitea.config.actions` | Configuration for [Forgejo Actions](https://forgejo.org/docs/latest/user/actions/) | `{}` |
|
||||
| `gitea.config.other` | Uncategorized configuration options | `{}` |
|
||||
|
||||
### LivenessProbe
|
||||
|
||||
|
|
|
|||
25
values.yaml
25
values.yaml
|
|
@ -408,18 +408,21 @@ gitea:
|
|||
ssh:
|
||||
logLevel: 'INFO'
|
||||
|
||||
# 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.
|
||||
#
|
||||
## @section `app.ini` overrides ([full list](https://forgejo.org/docs/latest/admin/config-cheat-sheet/))
|
||||
## @section `app.ini` overrides
|
||||
## @descriptionStart
|
||||
##
|
||||
## 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.
|
||||
##
|
||||
## @descriptionEnd
|
||||
config:
|
||||
# values in the DEFAULT section
|
||||
# (https://forgejo.org/docs/latest/admin/config-cheat-sheet/#overall-default)
|
||||
# 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.'
|
||||
|
||||
## @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
|
||||
service: {}
|
||||
|
||||
## @param gitea.config.ssh SSH key requirements
|
||||
ssh: {}
|
||||
## @param gitea.config.ssh.minimum_key_sizes SSH minimum key sizes
|
||||
ssh.minimum_key_sizes: {}
|
||||
|
||||
## @param gitea.config.webhook Webhook settings
|
||||
webhook: {}
|
||||
|
|
@ -518,8 +521,8 @@ gitea:
|
|||
## @param gitea.config.markup Configuration for advanced markup processors
|
||||
markup: {}
|
||||
|
||||
## @param gitea.config.highlight Syntax highlighting configuration
|
||||
highlight: {}
|
||||
## @param gitea.config.highlight.mapping File extension to language mapping overrides for syntax highlighting
|
||||
highlight.mapping: {}
|
||||
|
||||
## @param gitea.config.time Locale settings
|
||||
time: {}
|
||||
|
|
|
|||
Loading…
Reference in a new issue