docs: add helm docs (#12)

charts/cinny/README.md

@@ -0,0 +1,49 @@
+# cinny
+
+![Version: 1.0.3](https://img.shields.io/badge/Version-1.0.3-informational?style=flat-square) ![Type: application](https://img.shields.io/badge/Type-application-informational?style=flat-square) ![AppVersion: v2.2.6](https://img.shields.io/badge/AppVersion-v2.2.6-informational?style=flat-square)
+
+A Helm chart for the Cinny Matrix Client
+
+**Homepage:** <https://cinny.in/>
+
+## Source Code
+
+* <https://github.com/cinnyapp/cinny>
+
+## Values
+
+| Key | Type | Default | Description |
+|-----|------|---------|-------------|
+| affinity | object | `{}` |  |
+| customConfig.data.allowCustomHomeservers | bool | `true` | Allow the user to enter a homeserver not in the list |
+| customConfig.data.defaultHomeserver | int | `3` | Index (starting with 0) in homeserverList of the server to display by default |
+| customConfig.data.homeserverList | list | `["converser.eu","envs.net","halogen.city","matrix.org","mozilla.org"]` | List of Matrix homeservers to display |
+| customConfig.enabled | bool | `false` | Enable the use of a custom config.json - see https://github.com/cinnyapp/cinny/blob/dev/config.json |
+| fullnameOverride | string | `""` |  |
+| image.pullPolicy | string | `"IfNotPresent"` |  |
+| image.repository | string | `"ajbura/cinny"` |  |
+| image.tag | string | `""` | Overrides the image tag whose default is the chart appVersion. |
+| imagePullSecrets | list | `[]` |  |
+| ingress.annotations | object | `{}` |  |
+| ingress.className | string | `""` |  |
+| ingress.enabled | bool | `false` |  |
+| ingress.hosts[0].host | string | `"cinny.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 | `{}` |  |
+| podSecurityContext | object | `{}` |  |
+| replicaCount | int | `1` |  |
+| resources | object | `{}` |  |
+| securityContext | object | `{}` |  |
+| service.port | int | `80` |  |
+| service.type | string | `"ClusterIP"` |  |
+| serviceAccount.annotations | object | `{}` | Annotations to add to the service account |
+| serviceAccount.create | bool | `true` | Specifies whether a service account should be created |
+| serviceAccount.name | string | `""` | The name of the service account to use. If not set and create is true, a name is generated using the fullname template |
+| tolerations | list | `[]` |  |
+
+----------------------------------------------
+Autogenerated from chart metadata using [helm-docs v1.11.0](https://github.com/norwoodj/helm-docs/releases/v1.11.0)

charts/cinny/values.yaml

@@ -7,7 +7,7 @@ replicaCount: 1
 image:
   repository: ajbura/cinny
   pullPolicy: IfNotPresent
-  # Overrides the image tag whose default is the chart appVersion.
+  # -- Overrides the image tag whose default is the chart appVersion.
   tag: ""
 
 imagePullSecrets: []
@@ -15,24 +15,27 @@ nameOverride: ""
 fullnameOverride: ""
 
 serviceAccount:
-  # Specifies whether a service account should be created
+  # -- Specifies whether a service account should be created
   create: true
-  # Annotations to add to the service account
+  # -- Annotations to add to the service account
   annotations: {}
-  # The name of the service account to use.
+  # -- The name of the service account to use. If not set and create is true, a name is generated using the fullname template
-  # If not set and create is true, a name is generated using the fullname template
   name: ""
 
 customConfig:
+  # -- Enable the use of a custom config.json - see https://github.com/cinnyapp/cinny/blob/dev/config.json
   enabled: false
   data:
+    # -- Index (starting with 0) in homeserverList of the server to display by default
     defaultHomeserver: 3
+    # -- List of Matrix homeservers to display
     homeserverList:
       - converser.eu
       - envs.net
       - halogen.city
       - matrix.org
       - mozilla.org
+    # -- Allow the user to enter a homeserver not in the list
     allowCustomHomeservers: true
 
 podAnnotations: {}

charts/freshrss/README.md

@@ -0,0 +1,68 @@
+# freshrss
+
+![Version: 0.4.0](https://img.shields.io/badge/Version-0.4.0-informational?style=flat-square) ![Type: application](https://img.shields.io/badge/Type-application-informational?style=flat-square) ![AppVersion: 1.21.0](https://img.shields.io/badge/AppVersion-1.21.0-informational?style=flat-square)
+
+A Helm chart for FreshRSS
+
+**Homepage:** <https://freshrss.org/>
+
+## Source Code
+
+* <https://github.com/FreshRSS/FreshRSS>
+
+## Values
+
+| Key | Type | Default | Description |
+|-----|------|---------|-------------|
+| affinity | object | `{}` |  |
+| freshrss.autoInstall.apiEnabled | bool | `false` | Enable FreshRSS API |
+| freshrss.autoInstall.baseUrl | string | `"freshrss.local"` | URL for FreshRSS instance |
+| freshrss.autoInstall.dbBase | string | `"freshrss"` | Database name |
+| freshrss.autoInstall.dbHost | string | `""` | Database hostname |
+| freshrss.autoInstall.dbPassword | string | `"freshrss"` | Database password |
+| freshrss.autoInstall.dbType | string | `"sqlite"` | Database type - `pgsql`, `mysql` or `sqlite` |
+| freshrss.autoInstall.dbUser | string | `"freshrss"` | Database user |
+| freshrss.autoInstall.defaultUser.email | string | `"admin@example.com"` | Email for the default user |
+| freshrss.autoInstall.defaultUser.password | string | `"admin"` | Password for the default user |
+| freshrss.autoInstall.defaultUser.user | string | `"admin"` | Username for the default user |
+| freshrss.autoInstall.enabled | bool | `false` | Enable automatic install - configurable through the web application if disabled |
+| freshrss.autoInstall.language | string | `"en"` | Language short code |
+| freshrss.cron.cronMin | string | `"13,43"` | Minute(s) past the hour to run cron |
+| freshrss.cron.enabled | bool | `false` | Enable Cron to periodically refresh feeds |
+| freshrss.freshEnv | string | `"production"` | Enables additional development information if set to `development` (increases the level of logging and ensures that errors are displayed) |
+| freshrss.timezone | string | `"UTC"` | PHP Timezone - see https://www.php.net/timezones |
+| fullnameOverride | string | `""` |  |
+| image.pullPolicy | string | `"IfNotPresent"` |  |
+| image.repository | string | `"freshrss/freshrss"` |  |
+| image.tag | string | `""` | Overrides the image tag whose default is the chart appVersion. |
+| imagePullSecrets | list | `[]` |  |
+| ingress.annotations | object | `{}` |  |
+| ingress.className | string | `""` |  |
+| ingress.enabled | bool | `false` |  |
+| ingress.hosts[0].host | string | `"freshrss.local"` |  |
+| ingress.hosts[0].paths[0].path | string | `"/"` |  |
+| ingress.hosts[0].paths[0].pathType | string | `"ImplementationSpecific"` |  |
+| ingress.tls | list | `[]` |  |
+| nameOverride | string | `""` |  |
+| nodeSelector | object | `{}` |  |
+| persistence.accessMode | string | `"ReadWriteOnce"` |  |
+| persistence.annotations | object | `{}` |  |
+| persistence.enabled | bool | `false` |  |
+| persistence.existingClaim | string | `""` |  |
+| persistence.size | string | `"10Gi"` |  |
+| persistence.storageClass | string | `""` |  |
+| podAnnotations | object | `{}` |  |
+| podSecurityContext | object | `{}` |  |
+| replicaCount | int | `1` |  |
+| resources | object | `{}` |  |
+| securityContext | object | `{}` |  |
+| service.port | int | `80` |  |
+| service.type | string | `"ClusterIP"` |  |
+| serviceAccount.annotations | object | `{}` | Annotations to add to the service account |
+| serviceAccount.create | bool | `true` | Specifies whether a service account should be created |
+| serviceAccount.name | string | `""` | The name of the service account to use. If not set and create is true, a name is generated using the fullname template |
+| strategy.type | string | `"Recreate"` |  |
+| tolerations | list | `[]` |  |
+
+----------------------------------------------
+Autogenerated from chart metadata using [helm-docs v1.11.0](https://github.com/norwoodj/helm-docs/releases/v1.11.0)

charts/freshrss/values.yaml

@@ -3,13 +3,13 @@
 # Declare variables to be passed into your templates.
 
 replicaCount: 1
-strategy: 
+strategy:
   type: Recreate
 
 image:
   repository: freshrss/freshrss
   pullPolicy: IfNotPresent
-  # Overrides the image tag whose default is the chart appVersion.
+  # -- Overrides the image tag whose default is the chart appVersion.
   tag: ""
 
 imagePullSecrets: []
@@ -17,12 +17,11 @@ nameOverride: ""
 fullnameOverride: ""
 
 serviceAccount:
-  # Specifies whether a service account should be created
+  # -- Specifies whether a service account should be created
   create: true
-  # Annotations to add to the service account
+  # -- Annotations to add to the service account
   annotations: {}
-  # The name of the service account to use.
+  # -- The name of the service account to use. If not set and create is true, a name is generated using the fullname template
-  # If not set and create is true, a name is generated using the fullname template
   name: ""
 
 podAnnotations: {}
@@ -43,25 +42,41 @@ service:
   port: 80
 
 freshrss:
+  # -- PHP Timezone - see https://www.php.net/timezones
   timezone: UTC
+  # -- Enables additional development information if set to `development` (increases the level of logging and ensures that errors are displayed)
   freshEnv: production
   autoInstall:
+    # -- Enable automatic install - configurable through the web application if disabled
     enabled: false
+    # -- URL for FreshRSS instance
     baseUrl: freshrss.local
+    # -- Language short code
     language: en
+    # -- Enable FreshRSS API
     apiEnabled: false
+    # -- Database type - `pgsql`, `mysql` or `sqlite`
     dbType: sqlite
+    # -- Database name
     dbBase: freshrss
+    # -- Database hostname
     dbHost: ""
+    # -- Database password
     dbPassword: freshrss
+    # -- Database user
     dbUser: freshrss
     defaultUser:
+      # -- Username for the default user
       user: admin
+      # -- Password for the default user
       password: admin
+      # -- Email for the default user
       email: admin@example.com
   cron:
+    # -- Enable Cron to periodically refresh feeds
     enabled: false
-    cronMin: "13,43" # Minute(s) past the hour to run cron
+    # -- Minute(s) past the hour to run cron
+    cronMin: "13,43"
 
 persistence:
   enabled: false

charts/unifi-controller/README.md

@@ -0,0 +1,48 @@
+# unifi-controller
+
+![Version: 0.1.0](https://img.shields.io/badge/Version-0.1.0-informational?style=flat-square) ![Type: application](https://img.shields.io/badge/Type-application-informational?style=flat-square) ![AppVersion: 7.3.83](https://img.shields.io/badge/AppVersion-7.3.83-informational?style=flat-square)
+
+A Helm chart for the Unifi Controller
+
+## Values
+
+| Key | Type | Default | Description |
+|-----|------|---------|-------------|
+| affinity | object | `{}` |  |
+| config.jvmMemory.limit | string | `"default"` | Integer value in MB or `default` for memory limit for JVM |
+| config.jvmMemory.startup | string | `"default"` | Integer value in MB or `default` for startup memory for JVM |
+| config.timezone | string | `"Etc/UTC"` | Timezone - see https://en.wikipedia.org/wiki/List_of_tz_database_time_zones#List |
+| fullnameOverride | string | `""` |  |
+| image.pullPolicy | string | `"IfNotPresent"` |  |
+| image.repository | string | `"quay.io/linuxserver.io/unifi-controller"` |  |
+| image.tag | string | `""` | Overrides the image tag whose default is the chart appVersion. |
+| imagePullSecrets | list | `[]` |  |
+| ingress.annotations | object | `{}` |  |
+| ingress.className | string | `""` |  |
+| ingress.enabled | bool | `false` |  |
+| ingress.hosts[0].host | string | `"unifi-controller.local"` |  |
+| ingress.hosts[0].paths[0].path | string | `"/"` |  |
+| ingress.hosts[0].paths[0].pathType | string | `"ImplementationSpecific"` |  |
+| ingress.tls | list | `[]` |  |
+| nameOverride | string | `""` |  |
+| nodeSelector | object | `{}` |  |
+| persistence.accessMode | string | `"ReadWriteOnce"` |  |
+| persistence.annotations | object | `{}` |  |
+| persistence.enabled | bool | `false` |  |
+| persistence.existingClaim | string | `""` |  |
+| persistence.size | string | `"1Gi"` |  |
+| persistence.storageClass | string | `""` |  |
+| podAnnotations | object | `{}` |  |
+| podSecurityContext | object | `{}` |  |
+| resources | object | `{}` |  |
+| securityContext | object | `{}` |  |
+| service.annotations | object | `{}` |  |
+| service.combinedProtocols | bool | `true` | Use the same service for TCP and UDP ports - set to disabled if using a LoadBalancer with MetalLB |
+| service.type | string | `"ClusterIP"` |  |
+| serviceAccount.annotations | object | `{}` | Annotations to add to the service account |
+| serviceAccount.create | bool | `true` | Specifies whether a service account should be created |
+| serviceAccount.name | string | `""` | The name of the service account to use. If not set and create is true, a name is generated using the fullname template |
+| tolerations | list | `[]` |  |
+
+----------------------------------------------
+Autogenerated from chart metadata using [helm-docs v1.11.0](https://github.com/norwoodj/helm-docs/releases/v1.11.0)

charts/unifi-controller/values.yaml

@@ -5,7 +5,7 @@
 image:
   repository: quay.io/linuxserver.io/unifi-controller
   pullPolicy: IfNotPresent
-  # Overrides the image tag whose default is the chart appVersion.
+  # -- Overrides the image tag whose default is the chart appVersion.
   tag: ""
 
 imagePullSecrets: []
@@ -13,9 +13,12 @@ nameOverride: ""
 fullnameOverride: ""
 
 config:
+  # -- Timezone - see https://en.wikipedia.org/wiki/List_of_tz_database_time_zones#List
   timezone: Etc/UTC
   jvmMemory:
+    # -- Integer value in MB or `default` for startup memory for JVM
     startup: default
+    # -- Integer value in MB or `default` for memory limit for JVM
     limit: default
 
 persistence:
@@ -27,12 +30,11 @@ persistence:
   size: 1Gi
 
 serviceAccount:
-  # Specifies whether a service account should be created
+  # -- Specifies whether a service account should be created
   create: true
-  # Annotations to add to the service account
+  # -- Annotations to add to the service account
   annotations: {}
-  # The name of the service account to use.
+  # -- The name of the service account to use. If not set and create is true, a name is generated using the fullname template
-  # If not set and create is true, a name is generated using the fullname template
   name: ""
 
 podAnnotations: {}
@@ -50,7 +52,7 @@ securityContext: {}
 
 service:
   type: ClusterIP
-  # Use the same service for TCP and UDP ports
+  # -- Use the same service for TCP and UDP ports - set to disabled if using a LoadBalancer with MetalLB
   combinedProtocols: true
   annotations: {}