DevOps/truecharts
2
0
Fork 0
Code Issues Pull Requests Actions 19 Packages Projects Releases 1 Wiki Activity

Commit released Helm Chart and docs for TrueCharts

Browse Source 
Signed-off-by: TrueCharts-Bot <bot@truecharts.org>
This commit is contained in:
TrueCharts-Bot
2022-03-15 21:21:26 +00:00
parent 2ac8f8f6d3
commit b464144610
12 changed files with 3975 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files
charts/incubator/koel/CHANGELOG.md
+10
View File
@@ -0,0 +1,10 @@
# Changelog<br>
<a name="koel-0.0.1"></a>
### koel-0.0.1 (2022-03-15)
#### Feat
* Add koel ([#2182](https://github.com/truecharts/apps/issues/2182))
charts/incubator/koel/CONFIG.md
+8
View File
@@ -0,0 +1,8 @@
# Configuration Options
##### Connecting to other apps
If you need to connect this App to other Apps on TrueNAS SCALE, please refer to our "Linking Apps Internally" quick-start guide:
https://truecharts.org/manual/Quick-Start%20Guides/14-linking-apps/
##### Available config options
In the future this page is going to contain an automated list of options available in the installation/edit UI.
charts/incubator/koel/Chart.yaml
+1 -1
View File
@@ -1,5 +1,5 @@
apiVersion: v2
appVersion: "10.6.2"
appVersion: "latest"
dependencies:
- name: common
repository: https://truecharts.org
charts/incubator/koel/README.md
+40
View File
@@ -0,0 +1,40 @@
# Introduction
Koel is a simple web-based personal audio streaming service written in Vue on the client side and Laravel on the server side.
TrueCharts are designed to be installed as TrueNAS SCALE app only. We can not guarantee this charts works as a stand-alone helm installation.
**This chart is not maintained by the upstream project and any issues with the chart should be raised [here](https://github.com/truecharts/apps/issues/new/choose)**
## Source Code
* <https://github.com/koel/docker>
* <https://hub.docker.com/r/hyzual/koel>
* <https://github.com/koel/koel>
## Requirements
Kubernetes: `>=1.16.0-0`
## Dependencies
| Repository | Name | Version |
|------------|------|---------|
| https://truecharts.org/ | postgresql | 7.0.2 |
| https://truecharts.org | common | 9.1.2 |
## Installing the Chart
To install this App on TrueNAS SCALE check our [Quick-Start Guide](https://truecharts.org/manual/Quick-Start%20Guides/03-Installing-an-App/).
## Uninstalling the Chart
To remove this App from TrueNAS SCALE check our [Quick-Start Guide](https://truecharts.org/manual/Quick-Start%20Guides/07-Deleting-an-App/).
## Support
- Please check our [quick-start guides](https://truecharts.org/manual/Quick-Start%20Guides/01-Open-Apps/) first.
- See the [Wiki](https://truecharts.org)
- Check our [Discord](https://discord.gg/tVsPTHWTtr)
- Open a [issue](https://github.com/truecharts/apps/issues/new/choose)
---
All Rights Reserved - The TrueCharts Project
charts/incubator/koel/helm-values.md
+47
View File
@@ -0,0 +1,47 @@
# Default Helm-Values
TrueCharts is primarily build to supply TrueNAS SCALE Apps.
However, we also supply all Apps as standard Helm-Charts. In this document we aim to document the default values in our values.yaml file.
Most of our Apps also consume our "common" Helm Chart.
If this is the case, this means that all values.yaml values are set to the common chart values.yaml by default. This values.yaml file will only contain values that deviate from the common chart.
You will, however, be able to use all values referenced in the common chart here, besides the values listed in this document.
## Values
| Key | Type | Default | Description |
|-----|------|---------|-------------|
| env.DB_CONNECTION | string | `"pgsql"` | |
| env.DB_DATABASE | string | `"{{ .Values.postgresql.postgresqlDatabase }}"` | |
| env.DB_USERNAME | string | `"{{ .Values.postgresql.postgresqlUsername }}"` | |
| env.FORCE_HTTPS | bool | `false` | |
| env.LASTFM_API_KEY | string | `""` | |
| env.LASTFM_API_SECRET | string | `""` | |
| env.MEMORY_LIMIT | int | `2048` | |
| envValueFrom.APP_KEY.secretKeyRef.key | string | `"APP_KEY"` | |
| envValueFrom.APP_KEY.secretKeyRef.name | string | `"koel-secrets"` | |
| envValueFrom.DB_HOST.secretKeyRef.key | string | `"plainhost"` | |
| envValueFrom.DB_HOST.secretKeyRef.name | string | `"dbcreds"` | |
| envValueFrom.DB_PASSWORD.secretKeyRef.key | string | `"postgresql-password"` | |
| envValueFrom.DB_PASSWORD.secretKeyRef.name | string | `"dbcreds"` | |
| image.pullPolicy | string | `"IfNotPresent"` | |
| image.repository | string | `"hyzual/koel"` | |
| image.tag | string | `"latest@sha256:fa4bafbe3ae869f153bdc3bc87db739f300bef6cc94e398d7efa587a443f86fa"` | |
| persistence.covers.enabled | bool | `true` | |
| persistence.covers.mountPath | string | `"/var/www/html/public/img/covers"` | |
| persistence.music.enabled | bool | `true` | |
| persistence.music.mountPath | string | `"/music"` | |
| persistence.searchindex.enabled | bool | `true` | |
| persistence.searchindex.mountPath | string | `"/var/www/html/storage/search-indexes"` | |
| podSecurityContext.runAsGroup | int | `0` | |
| podSecurityContext.runAsUser | int | `0` | |
| postgresql.enabled | bool | `true` | |
| postgresql.existingSecret | string | `"dbcreds"` | |
| postgresql.postgresqlDatabase | string | `"koel"` | |
| postgresql.postgresqlUsername | string | `"koel"` | |
| securityContext.readOnlyRootFilesystem | bool | `false` | |
| securityContext.runAsNonRoot | bool | `false` | |
| service.main.ports.main.port | int | `10185` | |
| service.main.ports.main.targetPort | int | `80` | |
All Rights Reserved - The TrueCharts Project
charts/incubator/koel/security.md
+1862
View File
File diff suppressed because one or more lines are too long
docs/apps/incubator/koel/CHANGELOG.md
+10
View File
@@ -0,0 +1,10 @@
# Changelog<br>
<a name="koel-0.0.1"></a>
### koel-0.0.1 (2022-03-15)
#### Feat
* Add koel ([#2182](https://github.com/truecharts/apps/issues/2182))
docs/apps/incubator/koel/CONFIG.md
+8
View File
@@ -0,0 +1,8 @@
# Configuration Options
##### Connecting to other apps
If you need to connect this App to other Apps on TrueNAS SCALE, please refer to our "Linking Apps Internally" quick-start guide:
https://truecharts.org/manual/Quick-Start%20Guides/14-linking-apps/
##### Available config options
In the future this page is going to contain an automated list of options available in the installation/edit UI.
docs/apps/incubator/koel/helm-values.md
+47
View File
@@ -0,0 +1,47 @@
# Default Helm-Values
TrueCharts is primarily build to supply TrueNAS SCALE Apps.
However, we also supply all Apps as standard Helm-Charts. In this document we aim to document the default values in our values.yaml file.
Most of our Apps also consume our "common" Helm Chart.
If this is the case, this means that all values.yaml values are set to the common chart values.yaml by default. This values.yaml file will only contain values that deviate from the common chart.
You will, however, be able to use all values referenced in the common chart here, besides the values listed in this document.
## Values
| Key | Type | Default | Description |
|-----|------|---------|-------------|
| env.DB_CONNECTION | string | `"pgsql"` | |
| env.DB_DATABASE | string | `"{{ .Values.postgresql.postgresqlDatabase }}"` | |
| env.DB_USERNAME | string | `"{{ .Values.postgresql.postgresqlUsername }}"` | |
| env.FORCE_HTTPS | bool | `false` | |
| env.LASTFM_API_KEY | string | `""` | |
| env.LASTFM_API_SECRET | string | `""` | |
| env.MEMORY_LIMIT | int | `2048` | |
| envValueFrom.APP_KEY.secretKeyRef.key | string | `"APP_KEY"` | |
| envValueFrom.APP_KEY.secretKeyRef.name | string | `"koel-secrets"` | |
| envValueFrom.DB_HOST.secretKeyRef.key | string | `"plainhost"` | |
| envValueFrom.DB_HOST.secretKeyRef.name | string | `"dbcreds"` | |
| envValueFrom.DB_PASSWORD.secretKeyRef.key | string | `"postgresql-password"` | |
| envValueFrom.DB_PASSWORD.secretKeyRef.name | string | `"dbcreds"` | |
| image.pullPolicy | string | `"IfNotPresent"` | |
| image.repository | string | `"hyzual/koel"` | |
| image.tag | string | `"latest@sha256:fa4bafbe3ae869f153bdc3bc87db739f300bef6cc94e398d7efa587a443f86fa"` | |
| persistence.covers.enabled | bool | `true` | |
| persistence.covers.mountPath | string | `"/var/www/html/public/img/covers"` | |
| persistence.music.enabled | bool | `true` | |
| persistence.music.mountPath | string | `"/music"` | |
| persistence.searchindex.enabled | bool | `true` | |
| persistence.searchindex.mountPath | string | `"/var/www/html/storage/search-indexes"` | |
| podSecurityContext.runAsGroup | int | `0` | |
| podSecurityContext.runAsUser | int | `0` | |
| postgresql.enabled | bool | `true` | |
| postgresql.existingSecret | string | `"dbcreds"` | |
| postgresql.postgresqlDatabase | string | `"koel"` | |
| postgresql.postgresqlUsername | string | `"koel"` | |
| securityContext.readOnlyRootFilesystem | bool | `false` | |
| securityContext.runAsNonRoot | bool | `false` | |
| service.main.ports.main.port | int | `10185` | |
| service.main.ports.main.targetPort | int | `80` | |
All Rights Reserved - The TrueCharts Project
docs/apps/incubator/koel/index.md
+40
View File
@@ -0,0 +1,40 @@
# Introduction
Koel is a simple web-based personal audio streaming service written in Vue on the client side and Laravel on the server side.
TrueCharts are designed to be installed as TrueNAS SCALE app only. We can not guarantee this charts works as a stand-alone helm installation.
**This chart is not maintained by the upstream project and any issues with the chart should be raised [here](https://github.com/truecharts/apps/issues/new/choose)**
## Source Code
* <https://github.com/koel/docker>
* <https://hub.docker.com/r/hyzual/koel>
* <https://github.com/koel/koel>
## Requirements
Kubernetes: `>=1.16.0-0`
## Dependencies
| Repository | Name | Version |
|------------|------|---------|
| https://truecharts.org/ | postgresql | 7.0.2 |
| https://truecharts.org | common | 9.1.2 |
## Installing the Chart
To install this App on TrueNAS SCALE check our [Quick-Start Guide](https://truecharts.org/manual/Quick-Start%20Guides/03-Installing-an-App/).
## Uninstalling the Chart
To remove this App from TrueNAS SCALE check our [Quick-Start Guide](https://truecharts.org/manual/Quick-Start%20Guides/07-Deleting-an-App/).
## Support
- Please check our [quick-start guides](https://truecharts.org/manual/Quick-Start%20Guides/01-Open-Apps/) first.
- See the [Wiki](https://truecharts.org)
- Check our [Discord](https://discord.gg/tVsPTHWTtr)
- Open a [issue](https://github.com/truecharts/apps/issues/new/choose)
---
All Rights Reserved - The TrueCharts Project
docs/apps/incubator/koel/security.md
+1862
View File
File diff suppressed because one or more lines are too long
docs/index.yaml
+40 -1
View File
@@ -27682,6 +27682,45 @@ entries:
urls:
- https://github.com/truecharts/apps/releases/download/kodi-headless-0.0.1/kodi-headless-0.0.1.tgz
version: 0.0.1
koel:
- annotations:
truecharts.org/SCALE-support: "true"
truecharts.org/catagories: |
- media
truecharts.org/grade: U
apiVersion: v2
appVersion: latest
created: "2022-03-15T21:21:25.353953716Z"
dependencies:
- name: common
repository: https://truecharts.org
version: 9.1.2
- condition: postgresql.enabled
name: postgresql
repository: https://truecharts.org/
version: 7.0.2
description: Koel is a simple web-based personal audio streaming service written
in Vue on the client side and Laravel on the server side.
digest: b49263ccfefc7a55d0480f68efce22b7892c8a5d9a34a83c7904517cb1a0f6da
home: https://github.com/truecharts/apps/tree/master/charts/stable/koel
icon: https://truecharts.org/_static/img/appicons/koel.png
keywords:
- koel
- music
- stream
kubeVersion: '>=1.16.0-0'
maintainers:
- email: info@truecharts.org
name: TrueCharts
url: https://truecharts.org
name: koel
sources:
- https://github.com/koel/docker
- https://hub.docker.com/r/hyzual/koel
- https://github.com/koel/koel
urls:
- https://github.com/truecharts/apps/releases/download/koel-0.0.1/koel-0.0.1.tgz
version: 0.0.1
komga:
- annotations:
truecharts.org/SCALE-support: "true"
@@ -76893,4 +76932,4 @@ entries:
urls:
- https://github.com/truecharts/apps/releases/download/zwavejs2mqtt-9.0.24/zwavejs2mqtt-9.0.24.tgz
version: 9.0.24
generated: "2022-03-15T20:43:54.363456526Z"
generated: "2022-03-15T21:21:25.365092574Z"