DevFW-CICD/forgejo-helm
16
0
Fork 1
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

readme: replace gitea docs with forgejo

Browse source 
part of https://codeberg.org/forgejo-contrib/forgejo-helm/issues/357

Signed-off-by: alexandra catalina <git@garbage.world>
This commit is contained in:
alexandra catalina 2024-03-30 10:27:52 -07:00
parent bb9cce5846
commit db54d741a9
1 changed files with 22 additions and 15 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

37
README.md
View file

@ -63,9 +63,10 @@ It is published under the MIT license.
## Introduction
This helm chart is based on official [Gitea helm chart](https://gitea.com/gitea/helm-chart).
Yet it takes a completely different approach in providing a database and cache with dependencies.
Additionally, this chart allows to provide LDAP and admin user configuration with values.
This Helm chart is based on the [Gitea
chart](https://gitea.com/gitea/helm-chart). Yet it takes a completely different
approach in providing a database and cache with dependencies. Additionally,
this chart allows to provide LDAP and admin user configuration with values.
## Update and versioning policy
@ -142,8 +143,8 @@ 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 [Gitea Cheat Sheet](https://docs.gitea.com/administration/config-cheat-sheet).
Forgejo offers lots of configuration options. This is fully described in the
[Cheat Sheet](https://forgejo.org/docs/latest/admin/config-cheat-sheet/).
```yaml
gitea:
@ -310,7 +311,8 @@ If HA is not needed/desired, the following configurations can be used to deploy
### Additional _app.ini_ settings
> **The [generic](https://docs.gitea.com/administration/config-cheat-sheet#overall-default)
> **The
> [generic](https://forgejo.org/docs/latest/admin/config-cheat-sheet/#overall-default)
> section cannot be defined that way.**
Some settings inside _app.ini_ (like passwords or whole authentication configurations) must be considered sensitive and therefore should not be passed via plain text inside the _values.yaml_ file.
@ -397,8 +399,11 @@ Priority (highest to lowest) for defining app.ini variables:
### External Database
Any external database listed in [https://docs.gitea.com/installation/database-prep](https://docs.gitea.com/installation/database-prep) can be used instead of the built-in PostgreSQL.
In fact, it is **highly recommended** to use an external database to ensure a stable Forgejo installation longterm.
A [supported external
database](https://forgejo.org/docs/latest/admin/config-cheat-sheet/#database-database/)
can be used instead of the built-in PostgreSQL. In fact, it is **highly
recommended** to use an external database to ensure a stable Forgejo
installation longterm.
If an external database is used, no matter which type, make sure to set `postgresql.enabled` to `false` to disable the use of the built-in PostgreSQL.
@ -566,8 +571,8 @@ gitea:
### LDAP Settings
Like the admin user the LDAP settings can be updated.
All LDAP values from <https://docs.gitea.com/administration/command-line#admin> are available.
Like the admin user the LDAP settings can be updated. All LDAP values from
<https://forgejo.org/docs/latest/admin/command-line/#admin> are available.
Multiple LDAP sources can be configured with additional LDAP list items.
@ -619,9 +624,10 @@ 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
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://forgejo.org/docs/latest/admin/command-line/#admin), are
available.
Multiple OAuth2 sources can be configured with additional OAuth list items.
@ -697,8 +703,9 @@ signing:
existingSecret: custom-gitea-gpg-key
```
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).
To use the gpg key, Forgejo needs to be configured accordingly. A detailed
description can be found in the
[documentation](https://forgejo.org/docs/latest/admin/signing/#general-configuration).
## Metrics and profiling