mirror of
https://github.com/Thumbscrew/k8s-charts.git
synced 2025-04-24 08:29:52 +00:00
generate helm-docs for freshrss chart
This commit is contained in:
parent
f06e0299e9
commit
a95320859b
68
charts/freshrss/README.md
Normal file
68
charts/freshrss/README.md
Normal file
@ -0,0 +1,68 @@
|
||||
# freshrss
|
||||
|
||||
  
|
||||
|
||||
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)
|
||||
@ -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.
|
||||
# If not set and create is true, a name is generated using the fullname template
|
||||
# -- The name of the service account to use. 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
|
||||
|
||||
Loading…
Reference in New Issue
Block a user