docs(readme): clarify Helm values configuration, add more examples
This commit is contained in:
parent
32bd8f0976
commit
c00ee7cdfe
1 changed files with 16 additions and 6 deletions
22
README.md
22
README.md
|
@ -143,14 +143,23 @@ See the [HA Setup](docs/ha-setup.md) document for more details.
|
||||||
## Configuration
|
## Configuration
|
||||||
|
|
||||||
Forgejo offers lots of configuration options.
|
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
|
```yaml
|
||||||
gitea:
|
gitea:
|
||||||
config:
|
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:
|
repository:
|
||||||
ROOT: '~/gitea-repositories'
|
ROOT: '~/gitea-repositories'
|
||||||
|
#
|
||||||
|
# https://forgejo.org/docs/latest/admin/config-cheat-sheet/#repository---pull-request-repositorypull-request
|
||||||
repository.pull-request:
|
repository.pull-request:
|
||||||
WORK_IN_PROGRESS_PREFIXES: 'WIP:,[WIP]:'
|
WORK_IN_PROGRESS_PREFIXES: 'WIP:,[WIP]:'
|
||||||
```
|
```
|
||||||
|
@ -367,7 +376,7 @@ stringData:
|
||||||
#### User defined environment variables in app.ini
|
#### User defined environment variables in app.ini
|
||||||
|
|
||||||
Users are able to define their own environment variables, which are loaded into the containers.
|
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.
|
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.
|
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
|
```yaml
|
||||||
gitea:
|
gitea:
|
||||||
|
config:
|
||||||
|
database:
|
||||||
|
HOST: my.own.host
|
||||||
additionalConfigFromEnvs:
|
additionalConfigFromEnvs:
|
||||||
- name: FORGEJO__DATABASE__HOST
|
|
||||||
value: my.own.host
|
|
||||||
- name: FORGEJO__DATABASE__PASSWD
|
- name: FORGEJO__DATABASE__PASSWD
|
||||||
valueFrom:
|
valueFrom:
|
||||||
secretKeyRef:
|
secretKeyRef:
|
||||||
|
@ -406,7 +416,7 @@ If an external database is used, no matter which type, make sure to set `postgre
|
||||||
gitea:
|
gitea:
|
||||||
config:
|
config:
|
||||||
database:
|
database:
|
||||||
DB_TYPE: mysql
|
DB_TYPE: mysql # supported values are mysql, postgres, mssql, sqlite3
|
||||||
HOST: <mysql HOST>
|
HOST: <mysql HOST>
|
||||||
NAME: gitea
|
NAME: gitea
|
||||||
USER: root
|
USER: root
|
||||||
|
|
Loading…
Reference in a new issue