From da0cc9af6480a060dfcb188b27f025a8af50a260 Mon Sep 17 00:00:00 2001 From: xeruf Date: Tue, 23 Jan 2024 18:10:13 +0000 Subject: [PATCH] Update a few links and formulations in README.md --- README.md | 40 +++++++++++++++++++++------------------- 1 file changed, 21 insertions(+), 19 deletions(-) diff --git a/README.md b/README.md index e28f821..b3953ab 100644 --- a/README.md +++ b/README.md @@ -70,7 +70,7 @@ Additionally, this chart allows to provide LDAP and admin user configuration wit ## Update and versioning policy The Forgejo helm chart versioning does not follow Forgejo's versioning. -The latest chart version can be looked up in or in the [repository releases](https://codeberg.org/forgejo-contrib/forgejo-helm/releases). +The latest chart version can be looked up in or in the [repository releases](https://codeberg.org/forgejo-contrib/forgejo-helm/releases). The chart aims to follow Forgejo's releases closely. There might be times when the chart is behind the latest Forgejo release. @@ -160,14 +160,15 @@ gitea: This chart will set a few defaults in the Forgejo configuration based on the service and ingress settings. All defaults can be overwritten in `gitea.config`. -INSTALL_LOCK is always set to true, since we want to configure Forgejo with this helm chart and everything is taken care of. +INSTALL_LOCK is always set to true because the configuration in this helm chart +makes any configuration via installer superfluous. -_All default settings are made directly in the generated `app.ini`, not in the Values._ +_All default settings are directly in the generated `app.ini`, not in the Values._ #### Database defaults -If a builtIn database is enabled the database configuration is set automatically. -For example, PostgreSQL builtIn will appear in the `app.ini` as: +If the inbuilt database is enabled, the database configuration is set automatically. +For example, PostgreSQL built will appear in the `app.ini` as: ```ini [database] @@ -533,8 +534,7 @@ postgresql: This chart enables you to create a default admin user. It is also possible to update the password for this user by upgrading or redeploying the chart. -It is not possible to delete an admin user after it has been created. -This has to be done in the ui. +Deleting the admin user can only be done from the UI. You cannot use `admin` as username. ```yaml @@ -620,9 +620,8 @@ Affected options: ### OAuth2 Settings Like the admin user, OAuth2 settings can be updated and disabled but not deleted. -Deleting OAuth2 settings has to be done in the ui. -All OAuth2 values, which are documented [here](https://docs.gitea.com/administration/command-line#admin), are -available. +Deleting OAuth2 settings has to be done in the UI. +[All OAuth2 values](https://docs.gitea.com/administration/command-line#admin) are available. Multiple OAuth2 sources can be configured with additional OAuth list items. @@ -663,11 +662,13 @@ gitea: ## Configure commit signing -When using the rootless image the gpg key folder is not persistent by default. -If you consider using signed commits for internal Forgejo activities (e.g. initial commit), you'd need to provide a signing key. -Prior to [PR186](https://gitea.com/gitea/helm-chart/pulls/186), imported keys had to be re-imported once the container got replaced by another. +When using the rootless image, the gpg key folder is not persistent by default. +If you want commits by Forgejo (e.g. initial commit) to be signed, +you need to provide a signing key. +Prior to [PR186](https://gitea.com/gitea/helm-chart/pulls/186), +imported keys had to be re-imported once the container got replaced by another. -The mentioned PR introduced a new configuration object `signing` allowing you to configure prerequisites for commit signing. +The mentioned PR introduced a new configuration object `signing` so you can configure prerequisites for commit signing. By default this section is disabled to maintain backwards compatibility. ```yaml @@ -677,7 +678,8 @@ signing: ``` Regardless of the used container image the `signing` object allows to specify a private gpg key. -Either using the `signing.privateKey` to define the key inline, or refer to an existing secret containing the key data by using `signing.existingSecret`. +Either using the `signing.privateKey` to define the key inline, +or refering to an existing secret containing the key data with `signing.existingSecret`. ```yaml apiVersion: v1 @@ -697,7 +699,7 @@ signing: existingSecret: custom-gitea-gpg-key ``` -To use the gpg key, Forgejo needs to be configured accordingly. +To use the GPG key, Forgejo needs to be configured accordingly. A detailed description can be found in the [official Gitea documentation](https://docs.gitea.com/administration/signing#general-configuration). ## Metrics and profiling @@ -1066,7 +1068,7 @@ Complete Configuration can be taken from their website. ### PostgreSQL PostgreSQL is loaded as a dependency from [Bitnami](https://github.com/bitnami/charts/tree/master/bitnami/postgresql) if enabled in the values. -Complete Configuration can be taken from their website. +Full configuration options are available on their website. | Name | Description | Value | | ------------------------------------------------------- | ---------------------------------------------------------------- | ------- | @@ -1081,8 +1083,8 @@ Complete Configuration can be taken from their website. | Name | Description | Value | | ------------------ | ------------------------------------------------------------------ | --------- | -| `checkDeprecation` | Set it to false to skip this basic validation check. | `true` | -| `test.enabled` | Set it to false to disable test-connection Pod. | `true` | +| `checkDeprecation` | Set to false to skip this basic validation check. | `true` | +| `test.enabled` | Set to false to disable test-connection Pod. | `true` | | `test.image.name` | Image name for the wget container used in the test-connection Pod. | `busybox` | | `test.image.tag` | Image tag for the wget container used in the test-connection Pod. | `latest` | | `extraDeploy` | Array of extra objects to deploy with the release | `[]` |