docs: add more comments and examples of Helm values configuration (#407)
Reviewed-on: https://codeberg.org/forgejo-contrib/forgejo-helm/pulls/407 Reviewed-by: Michael Kriese <michael.kriese@gmx.de> Co-authored-by: egirl <egirl@noreply.codeberg.org> Co-committed-by: egirl <egirl@noreply.codeberg.org>
This commit is contained in:
egirl
Michael Kriese
parent
62a6dcb49c
commit
fe75ae7610
2 changed files with 224 additions and 20 deletions
80
README.md
80
README.md
|
|
@ -143,14 +143,23 @@ See the [HA Setup](docs/ha-setup.md) document for more details.
|
|||
## Configuration
|
||||
|
||||
Forgejo offers lots of configuration options.
|
||||
This is fully described in the [Cheat Sheet](https://forgejo.org/docs/latest/admin/config-cheat-sheet/).
|
||||
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.
|
||||
|
||||
```yaml
|
||||
gitea:
|
||||
config:
|
||||
APP_NAME: 'Forgejo: With a cup of tea.'
|
||||
# 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'
|
||||
#
|
||||
# https://forgejo.org/docs/latest/admin/config-cheat-sheet/#repository-repository
|
||||
repository:
|
||||
ROOT: '~/gitea-repositories'
|
||||
#
|
||||
# https://forgejo.org/docs/latest/admin/config-cheat-sheet/#repository---pull-request-repositorypull-request
|
||||
repository.pull-request:
|
||||
WORK_IN_PROGRESS_PREFIXES: 'WIP:,[WIP]:'
|
||||
```
|
||||
|
|
@ -367,7 +376,7 @@ stringData:
|
|||
#### User defined environment variables in app.ini
|
||||
|
||||
Users are able to define their own environment variables, which are loaded into the containers.
|
||||
We also support to directly interact with the generated _app.ini_.
|
||||
We also support interacting directly with the generated _app.ini_.
|
||||
|
||||
To inject self defined variables into the _app.ini_ a certain format needs to be honored.
|
||||
This is described in detail on the [env-to-ini](https://github.com/go-gitea/gitea/tree/main/contrib/environment-to-ini) page.
|
||||
|
|
@ -378,9 +387,10 @@ For example a database setting needs to have the following format:
|
|||
|
||||
```yaml
|
||||
gitea:
|
||||
config:
|
||||
database:
|
||||
HOST: my.own.host
|
||||
additionalConfigFromEnvs:
|
||||
- name: FORGEJO__DATABASE__HOST
|
||||
value: my.own.host
|
||||
- name: FORGEJO__DATABASE__PASSWD
|
||||
valueFrom:
|
||||
secretKeyRef:
|
||||
|
|
@ -406,7 +416,7 @@ If an external database is used, no matter which type, make sure to set `postgre
|
|||
gitea:
|
||||
config:
|
||||
database:
|
||||
DB_TYPE: mysql
|
||||
DB_TYPE: mysql # supported values are mysql, postgres, mssql, sqlite3
|
||||
HOST: <mysql HOST>
|
||||
NAME: gitea
|
||||
USER: root
|
||||
|
|
@ -989,13 +999,67 @@ To comply with the Forgejo helm chart definition of the digest parameter, a "cus
|
|||
| `gitea.metrics.serviceMonitor.enabled` | Enable Forgejo metrics service monitor | `false` |
|
||||
| `gitea.ldap` | LDAP configuration | `[]` |
|
||||
| `gitea.oauth` | OAuth configuration | `[]` |
|
||||
| `gitea.config.server.SSH_PORT` | SSH port for rootlful Forgejo image | `22` |
|
||||
| `gitea.config.server.SSH_LISTEN_PORT` | SSH port for rootless Forgejo image | `2222` |
|
||||
| `gitea.additionalConfigSources` | Additional configuration from secret or configmap | `[]` |
|
||||
| `gitea.additionalConfigFromEnvs` | Additional configuration sources from environment variables | `[]` |
|
||||
| `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
|
||||
|
||||
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
|
||||
|
||||
| Name | Description | Value |
|
||||
|
|
|
|||
164
values.yaml
164
values.yaml
|
|
@ -391,18 +391,6 @@ 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
|
||||
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
|
||||
|
||||
## @param gitea.additionalConfigSources Additional configuration from secret or configmap
|
||||
additionalConfigSources: []
|
||||
# - secret:
|
||||
|
|
@ -420,6 +408,158 @@ gitea:
|
|||
ssh:
|
||||
logLevel: 'INFO'
|
||||
|
||||
## @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
|
||||
APP_NAME: 'Forgejo: Beyond coding. We forge.'
|
||||
|
||||
## @param gitea.config.RUN_MODE Application run mode, affects performance and debugging: `dev` or `prod`
|
||||
RUN_MODE: prod
|
||||
|
||||
## @param gitea.config.repository General repository settings
|
||||
repository: {}
|
||||
|
||||
## @param gitea.config.cors Cross-origin resource sharing settings
|
||||
cors: {}
|
||||
|
||||
## @param gitea.config.ui User interface settings
|
||||
ui: {}
|
||||
|
||||
## @param gitea.config.markdown Markdown parser settings
|
||||
markdown: {}
|
||||
|
||||
## @param gitea.config.server General server settings
|
||||
server: {}
|
||||
|
||||
## @param gitea.config.database Database configuration (only necessary with an [externally managed DB](https://codeberg.org/forgejo-contrib/forgejo-helm#external-database)).
|
||||
database: {}
|
||||
|
||||
## @param gitea.config.indexer Settings for what content is indexed and how
|
||||
indexer: {}
|
||||
|
||||
## @param gitea.config.queue Job queue configuration
|
||||
queue: {}
|
||||
|
||||
## @param gitea.config.admin Admin user settings
|
||||
admin: {}
|
||||
|
||||
## @param gitea.config.security Site security settings
|
||||
security: {}
|
||||
|
||||
## @param gitea.config.camo Settings for the [camo](https://github.com/cactus/go-camo) media proxy server (disabled by default)
|
||||
camo: {}
|
||||
|
||||
## @param gitea.config.openid Configuration for authentication with OpenID (disabled by default)
|
||||
openid: {}
|
||||
|
||||
## @param gitea.config.oauth2_client OAuth2 client settings
|
||||
oauth2_client: {}
|
||||
|
||||
## @param gitea.config.service Configuration for miscellaneous Forgejo services
|
||||
service: {}
|
||||
|
||||
## @param gitea.config.ssh.minimum_key_sizes SSH minimum key sizes
|
||||
ssh.minimum_key_sizes: {}
|
||||
|
||||
## @param gitea.config.webhook Webhook settings
|
||||
webhook: {}
|
||||
|
||||
## @param gitea.config.mailer Mailer configuration (disabled by default)
|
||||
mailer: {}
|
||||
|
||||
## @param gitea.config.email.incoming Configuration for handling incoming mail (disabled by default)
|
||||
email.incoming: {}
|
||||
|
||||
## @param gitea.config.cache Cache configuration
|
||||
cache: {}
|
||||
|
||||
## @param gitea.config.session Session/cookie handling
|
||||
session: {}
|
||||
|
||||
## @param gitea.config.picture User avatar settings
|
||||
picture: {}
|
||||
|
||||
## @param gitea.config.project Project board defaults
|
||||
project: {}
|
||||
|
||||
## @param gitea.config.attachment Issue and PR attachment configuration
|
||||
attachment: {}
|
||||
|
||||
## @param gitea.config.log Logging configuration
|
||||
log: {}
|
||||
|
||||
## @param gitea.config.cron Cron job configuration
|
||||
cron: {}
|
||||
|
||||
## @param gitea.config.git Global settings for Git
|
||||
git: {}
|
||||
|
||||
## @param gitea.config.metrics Settings for the Prometheus endpoint (disabled by default)
|
||||
metrics: {}
|
||||
|
||||
## @param gitea.config.api Settings for the Swagger API documentation endpoints
|
||||
api: {}
|
||||
|
||||
## @param gitea.config.oauth2 Settings for the [OAuth2 provider](https://forgejo.org/docs/latest/admin/oauth2-provider/)
|
||||
oauth2: {}
|
||||
|
||||
## @param gitea.config.i18n Internationalization settings
|
||||
i18n: {}
|
||||
|
||||
## @param gitea.config.markup Configuration for advanced markup processors
|
||||
markup: {}
|
||||
|
||||
## @param gitea.config.highlight.mapping File extension to language mapping overrides for syntax highlighting
|
||||
highlight.mapping: {}
|
||||
|
||||
## @param gitea.config.time Locale settings
|
||||
time: {}
|
||||
|
||||
## @param gitea.config.migrations Settings for Git repository migrations
|
||||
migrations: {}
|
||||
|
||||
## @param gitea.config.federation Federation configuration
|
||||
federation: {}
|
||||
|
||||
## @param gitea.config.packages Package registry settings
|
||||
packages: {}
|
||||
|
||||
## @param gitea.config.mirror Configuration for repository mirroring
|
||||
mirror: {}
|
||||
|
||||
## @param gitea.config.lfs Large File Storage configuration
|
||||
lfs: {}
|
||||
|
||||
## @param gitea.config.repo-avatar Repository avatar storage configuration
|
||||
repo-avatar: {}
|
||||
|
||||
## @param gitea.config.avatar User/org avatar storage configuration
|
||||
avatar: {}
|
||||
|
||||
## @param gitea.config.storage General storage settings
|
||||
storage: {}
|
||||
|
||||
## @param gitea.config.proxy Proxy configuration (disabled by default)
|
||||
proxy: {}
|
||||
|
||||
## @param gitea.config.actions Configuration for [Forgejo Actions](https://forgejo.org/docs/latest/user/actions/)
|
||||
actions: {}
|
||||
|
||||
## @param gitea.config.other Uncategorized configuration options
|
||||
other: {}
|
||||
|
||||
## @section LivenessProbe
|
||||
#
|
||||
## @param gitea.livenessProbe.enabled Enable liveness probe
|
||||
|
|
|
|||
Loading…
Reference in a new issue