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

docs: fix readme

Browse source
This commit is contained in:
Michael Kriese 2023-12-06 12:05:14 +01:00
parent 206aba2ba2
commit 96678540cb
No known key found for this signature in database
GPG key ID: B83F553A0724D44E
2 changed files with 44 additions and 41 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

4
.prettierrc.json Normal file
View file

@ -0,0 +1,4 @@
{
"singleQuote": true,
"trailingComma": "all"
}

23
README.md
View file

@ -1,4 +1,3 @@
# Forgejo Helm Chart <!-- omit from toc --> # Forgejo Helm Chart <!-- omit from toc -->
[![status-badge](https://ci.dachary.org/api/badges/forgejo-contrib/forgejo-helm/status.svg)](https://ci.dachary.org/forgejo-contrib/forgejo-helm) [![status-badge](https://ci.dachary.org/api/badges/forgejo-contrib/forgejo-helm/status.svg)](https://ci.dachary.org/forgejo-contrib/forgejo-helm)
@ -588,11 +587,11 @@ Multiple OAuth2 sources can be configured with additional OAuth list items.
```yaml ```yaml
gitea: gitea:
oauth: oauth:
- name: "MyAwesomeGiteaOAuth" - name: 'MyAwesomeGiteaOAuth'
provider: "openidConnect" provider: 'openidConnect'
key: "hello" key: 'hello'
secret: "world" secret: 'world'
autoDiscoverUrl: "https://gitea.example.com/.well-known/openid-configuration" autoDiscoverUrl: 'https://gitea.example.com/.well-known/openid-configuration'
#useCustomUrls: #useCustomUrls:
#customAuthUrl: #customAuthUrl:
#customTokenUrl: #customTokenUrl:
@ -616,7 +615,7 @@ stringData:
```yaml ```yaml
gitea: gitea:
oauth: oauth:
- name: "MyAwesomeGiteaOAuth" - name: 'MyAwesomeGiteaOAuth'
existingSecret: gitea-oauth-secret existingSecret: gitea-oauth-secret
``` ```
@ -702,7 +701,7 @@ extraVolumes:
extraVolumeMounts: extraVolumeMounts:
- name: gitea-themes - name: gitea-themes
readOnly: true readOnly: true
mountPath: "/data/gitea/public/assets/css" mountPath: '/data/gitea/public/assets/css'
``` ```
The secret can be created via `terraform`: The secret can be created via `terraform`:
@ -809,7 +808,7 @@ To comply with the Forgejo helm chart definition of the digest parameter, a "cus
### Image ### Image
| Name | Description | Value | | Name | Description | Value |
| -------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------- | | -------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------- |
| `image.registry` | image registry, e.g. gcr.io,docker.io | `codeberg.org` | | `image.registry` | image registry, e.g. gcr.io,docker.io | `codeberg.org` |
| `image.repository` | Image to start for this pod | `forgejo/forgejo` | | `image.repository` | Image to start for this pod | `forgejo/forgejo` |
| `image.tag` | Visit: [Image tag](https://codeberg.org/forgejo/-/packages/container/forgejo/versions). Defaults to `appVersion` within Chart.yaml. | `""` | | `image.tag` | Visit: [Image tag](https://codeberg.org/forgejo/-/packages/container/forgejo/versions). Defaults to `appVersion` within Chart.yaml. | `""` |
@ -884,7 +883,7 @@ To comply with the Forgejo helm chart definition of the digest parameter, a "cus
| `deployment.env` | Additional environment variables to pass to containers | `[]` | | `deployment.env` | Additional environment variables to pass to containers | `[]` |
| `deployment.terminationGracePeriodSeconds` | How long to wait until forcefully kill the pod | `60` | | `deployment.terminationGracePeriodSeconds` | How long to wait until forcefully kill the pod | `60` |
| `deployment.labels` | Labels for the deployment | `{}` | | `deployment.labels` | Labels for the deployment | `{}` |
| `deployment.annotations` | Annotations for the Gitea deployment to be created | `{}` | | `deployment.annotations` | Annotations for the Forgejo deployment to be created | `{}` |
### ServiceAccount ### ServiceAccount
@ -900,7 +899,7 @@ To comply with the Forgejo helm chart definition of the digest parameter, a "cus
### Persistence ### Persistence
| Name | Description | Value | | Name | Description | Value |
| ------------------------------------------------- | ----------------------------------------------------------------------------------------------------- | ---------------------- | | ------------------------------------------------- | ------------------------------------------------------------------------------------------------------- | ---------------------- |
| `persistence.enabled` | Enable persistent storage | `true` | | `persistence.enabled` | Enable persistent storage | `true` |
| `persistence.create` | Whether to create the persistentVolumeClaim for shared storage | `true` | | `persistence.create` | Whether to create the persistentVolumeClaim for shared storage | `true` |
| `persistence.mount` | Whether the persistentVolumeClaim should be mounted (even if not created) | `true` | | `persistence.mount` | Whether the persistentVolumeClaim should be mounted (even if not created) | `true` |
@ -938,7 +937,7 @@ To comply with the Forgejo helm chart definition of the digest parameter, a "cus
### Gitea ### Gitea
| Name | Description | Value | | Name | Description | Value |
| -------------------------------------- | ------------------------------------------------------------------------- | -------------------- | | -------------------------------------- | --------------------------------------------------------------------------- | -------------------- |
| `gitea.admin.username` | Username for the Forgejo admin user | `gitea_admin` | | `gitea.admin.username` | Username for the Forgejo admin user | `gitea_admin` |
| `gitea.admin.existingSecret` | Use an existing secret to store admin user credentials | `nil` | | `gitea.admin.existingSecret` | Use an existing secret to store admin user credentials | `nil` |
| `gitea.admin.password` | Password for the Forgejo admin user | `r8sA8CPHD9!bt6d` | | `gitea.admin.password` | Password for the Forgejo admin user | `r8sA8CPHD9!bt6d` |