fix(hydrogen-web): add README in markdown
This commit is contained in:
parent
7c926ac432
commit
27564187fd
3 changed files with 88 additions and 2 deletions
|
@ -3,7 +3,7 @@ name: hydrogen-web
|
|||
description: A Helm Chart to install hydrogen-web (a nextgen Matrix Webclient)
|
||||
icon: https://raw.githubusercontent.com/element-hq/hydrogen-web/master/src/platform/web/assets/icon.svg
|
||||
type: application
|
||||
version: 0.1.8
|
||||
version: "0.1.9"
|
||||
# renovate: image=ghcr.io/element-hq/hydrogen-web
|
||||
appVersion: "0.5.1"
|
||||
maintainers:
|
||||
|
|
|
@ -2,7 +2,7 @@
|
|||
|
||||
= hydrogen-web
|
||||
|
||||
image::https://img.shields.io/badge/Version-0.1.8-informational?style=flat-square[Version: 0.1.8]
|
||||
image::https://img.shields.io/badge/Version-0.1.9-informational?style=flat-square[Version: 0.1.9]
|
||||
image::https://img.shields.io/badge/Version-application-informational?style=flat-square[Type: application]
|
||||
image::https://img.shields.io/badge/AppVersion-0.5.1-informational?style=flat-square[AppVersion: 0.5.1]
|
||||
== Maintainers
|
||||
|
|
86
hydrogen-web/README.md
Normal file
86
hydrogen-web/README.md
Normal file
|
@ -0,0 +1,86 @@
|
|||
---
|
||||
title: "hydrogen-web"
|
||||
|
||||
description: "A Helm Chart to install hydrogen-web (a nextgen Matrix Webclient)"
|
||||
|
||||
---
|
||||
|
||||
# hydrogen-web
|
||||
|
||||
  
|
||||
|
||||
A Helm Chart to install hydrogen-web (a nextgen Matrix Webclient)
|
||||
|
||||
## Maintainers
|
||||
|
||||
| Name | Email | Url |
|
||||
| ---- | ------ | --- |
|
||||
| WrenIX | | <https://wrenix.eu> |
|
||||
|
||||
## Usage
|
||||
|
||||
Helm must be installed and setup to your kubernetes cluster to use the charts.
|
||||
Refer to Helm's [documentation](https://helm.sh/docs) to get started.
|
||||
Once Helm has been set up correctly, fetch the charts as follows:
|
||||
|
||||
```bash
|
||||
helm pull oci://codeberg.org/wrenix/helm-charts/hydrogen-web
|
||||
```
|
||||
|
||||
You can install a chart release using the following command:
|
||||
|
||||
```bash
|
||||
helm install hydrogen-web-release oci://codeberg.org/wrenix/helm-charts/hydrogen-web --values values.yaml
|
||||
```
|
||||
|
||||
To uninstall a chart release use `helm`'s delete command:
|
||||
|
||||
```bash
|
||||
helm uninstall hydrogen-web-release
|
||||
```
|
||||
|
||||
## Values
|
||||
|
||||
| Key | Type | Default | Description |
|
||||
|-----|------|---------|-------------|
|
||||
| affinity | object | `{}` | |
|
||||
| autoscaling.enabled | bool | `false` | |
|
||||
| autoscaling.maxReplicas | int | `100` | |
|
||||
| autoscaling.minReplicas | int | `1` | |
|
||||
| autoscaling.targetCPUUtilizationPercentage | int | `80` | |
|
||||
| fullnameOverride | string | `""` | |
|
||||
| hydrogen.bugReportEndpointUrl" | string | `"https://element.io/bugreports/submit"` | |
|
||||
| hydrogen.defaultHomeServer | string | `"matrix.org"` | |
|
||||
| hydrogen.defaultTheme.dark | string | `"element-dark"` | |
|
||||
| hydrogen.defaultTheme.light | string | `"element-light"` | |
|
||||
| hydrogen.push.appId | string | `"io.element.hydrogen.web"` | |
|
||||
| hydrogen.push.applicationServerKey | string | `"BC-gpSdVHEXhvHSHS0AzzWrQoukv2BE7KzpoPO_FfPacqOo3l1pdqz7rSgmB04pZCWaHPz7XRe6fjLaC-WPDopM"` | |
|
||||
| hydrogen.push.gatewayUrl | string | `"https://matrix.org"` | |
|
||||
| hydrogen.themeManifests[0] | string | `"assets/theme-element.json"` | |
|
||||
| image.pullPolicy | string | `"IfNotPresent"` | |
|
||||
| image.repository | string | `"ghcr.io/element-hq/hydrogen-web"` | |
|
||||
| image.tag | string | `""` | |
|
||||
| imagePullSecrets | list | `[]` | |
|
||||
| ingress.annotations | object | `{}` | |
|
||||
| ingress.className | string | `""` | |
|
||||
| ingress.enabled | bool | `false` | |
|
||||
| ingress.hosts[0].host | string | `"chart-example.local"` | |
|
||||
| ingress.hosts[0].paths[0].path | string | `"/"` | |
|
||||
| ingress.hosts[0].paths[0].pathType | string | `"ImplementationSpecific"` | |
|
||||
| ingress.tls | list | `[]` | |
|
||||
| nameOverride | string | `""` | |
|
||||
| nodeSelector | object | `{}` | |
|
||||
| podAnnotations | object | `{}` | |
|
||||
| podLabels | object | `{}` | |
|
||||
| podSecurityContext | object | `{}` | |
|
||||
| replicaCount | int | `1` | |
|
||||
| resources | object | `{}` | |
|
||||
| securityContext | object | `{}` | |
|
||||
| service.port | int | `8080` | |
|
||||
| service.type | string | `"ClusterIP"` | |
|
||||
| serviceAccount.annotations | object | `{}` | |
|
||||
| serviceAccount.create | bool | `true` | |
|
||||
| serviceAccount.name | string | `""` | |
|
||||
| tolerations | list | `[]` | |
|
||||
|
||||
Autogenerated from chart metadata using [helm-docs](https://github.com/norwoodj/helm-docs)
|
Loading…
Add table
Reference in a new issue