DevOps/truecharts
2
0
Fork 0
Code Issues Pull Requests Actions 34 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-20 20:28:34 +00:00
parent f29a6746ba
commit 31a6a52862
17 changed files with 2275 additions and 89 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/apps/stable/koel/CHANGELOG.md
+45
View File
@@ -0,0 +1,45 @@
# Changelog<br>
<a name="koel-1.0.0"></a>
### [koel-1.0.0](https://github.com/truecharts/apps/compare/koel-0.0.6...koel-1.0.0) (2022-03-20)
#### Feat
* move koel and zerotier to stable ([#2232](https://github.com/truecharts/apps/issues/2232))
<a name="koel-0.0.5"></a>
### [koel-0.0.5](https://github.com/truecharts/apps/compare/koel-0.0.4...koel-0.0.5) (2022-03-17)
#### Chore
* update helm general non-major helm releases ([#2186](https://github.com/truecharts/apps/issues/2186))
<a name="koel-0.0.4"></a>
### [koel-0.0.4](https://github.com/truecharts/apps/compare/koel-0.0.3...koel-0.0.4) (2022-03-16)
#### Fix
* Run as root ([#2191](https://github.com/truecharts/apps/issues/2191))
<a name="koel-0.0.3"></a>
### [koel-0.0.3](https://github.com/truecharts/apps/compare/koel-0.0.1...koel-0.0.3) (2022-03-16)
#### Fix
* use installContainer to init app and run as www-data ([#2189](https://github.com/truecharts/apps/issues/2189))
<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/stable/koel/CONFIG.md
+7
View File
@@ -0,0 +1,7 @@
# 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](https://truecharts.org/manual/Quick-Start%20Guides/06-linking-apps/) quick-start guide.
##### 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/stable/koel/helm-values.md
+77
View File
@@ -0,0 +1,77 @@
# 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 | `"mysql"` | |
| env.DB_DATABASE | string | `"{{ .Values.mariadb.mariadbDatabase }}"` | |
| env.DB_PORT | string | `"3306"` | |
| env.DB_USERNAME | string | `"{{ .Values.mariadb.mariadbUsername }}"` | |
| env.FORCE_HTTPS | bool | `false` | |
| env.LASTFM_API_KEY | string | `""` | |
| env.LASTFM_API_SECRET | string | `""` | |
| env.MEMORY_LIMIT | int | `2048` | |
| env.YOUTUBE_API_KEY | string | `""` | |
| 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 | `"mariadbcreds"` | |
| envValueFrom.DB_PASSWORD.secretKeyRef.key | string | `"mariadb-password"` | |
| envValueFrom.DB_PASSWORD.secretKeyRef.name | string | `"mariadbcreds"` | |
| image.pullPolicy | string | `"IfNotPresent"` | |
| image.repository | string | `"tccr.io/truecharts/koel"` | |
| image.tag | string | `"latest@sha256:1b84c90e846d0dab98bc14d413a9de1fd357679022795456d27ff4c75869fd9d"` | |
| installContainers.initdb.command[0] | string | `"php"` | |
| installContainers.initdb.command[1] | string | `"artisan"` | |
| installContainers.initdb.command[2] | string | `"koel:init"` | |
| installContainers.initdb.command[3] | string | `"--no-assets"` | |
| installContainers.initdb.env[0].name | string | `"DB_CONNECTION"` | |
| installContainers.initdb.env[0].value | string | `"mysql"` | |
| installContainers.initdb.env[1].name | string | `"DB_PORT"` | |
| installContainers.initdb.env[1].value | string | `"3306"` | |
| installContainers.initdb.env[2].name | string | `"DB_USERNAME"` | |
| installContainers.initdb.env[2].value | string | `"{{ .Values.mariadb.mariadbUsername }}"` | |
| installContainers.initdb.env[3].name | string | `"DB_DATABASE"` | |
| installContainers.initdb.env[3].value | string | `"{{ .Values.mariadb.mariadbDatabase }}"` | |
| installContainers.initdb.env[4].name | string | `"DB_HOST"` | |
| installContainers.initdb.env[4].valueFrom.secretKeyRef.key | string | `"plainhost"` | |
| installContainers.initdb.env[4].valueFrom.secretKeyRef.name | string | `"mariadbcreds"` | |
| installContainers.initdb.env[5].name | string | `"DB_PASSWORD"` | |
| installContainers.initdb.env[5].valueFrom.secretKeyRef.key | string | `"mariadb-password"` | |
| installContainers.initdb.env[5].valueFrom.secretKeyRef.name | string | `"mariadbcreds"` | |
| installContainers.initdb.env[6].name | string | `"APP_KEY"` | |
| installContainers.initdb.env[6].valueFrom.secretKeyRef.key | string | `"APP_KEY"` | |
| installContainers.initdb.env[6].valueFrom.secretKeyRef.name | string | `"koel-secrets"` | |
| installContainers.initdb.image | string | `"{{ .Values.image.repository }}:{{ .Values.image.tag }}"` | |
| installContainers.initdb.volumeMounts[0].mountPath | string | `"/music"` | |
| installContainers.initdb.volumeMounts[0].name | string | `"music"` | |
| installContainers.initdb.volumeMounts[1].mountPath | string | `"/var/www/html/public/img/covers"` | |
| installContainers.initdb.volumeMounts[1].name | string | `"covers"` | |
| installContainers.initdb.volumeMounts[2].mountPath | string | `"/var/www/html/storage/search-indexes"` | |
| installContainers.initdb.volumeMounts[2].name | string | `"searchindex"` | |
| mariadb.enabled | bool | `true` | |
| mariadb.existingSecret | string | `"mariadbcreds"` | |
| mariadb.mariadbDatabase | string | `"koel"` | |
| mariadb.mariadbUsername | string | `"koel"` | |
| 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` | |
| 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/stable/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/ | mariadb | 2.0.6 |
| https://truecharts.org | common | 9.1.6 |
## Installing the Chart
To install this App on TrueNAS SCALE check our [Quick-Start Guide](https://truecharts.org/manual/Quick-Start%20Guides/02-Installing-an-App/).
## Upgrading, Rolling Back and Uninstalling the Chart
To upgrade, rollback or delete this App from TrueNAS SCALE check our [Quick-Start Guide](https://truecharts.org/manual/Quick-Start%20Guides/04-Upgrade-rollback-delete-an-App/).
## Support
- Please check our [quick-start guides](https://truecharts.org/manual/Quick-Start%20Guides/01-Adding-TrueCharts/) 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/stable/koel/security.md
+1574
View File
File diff suppressed because one or more lines are too long
docs/apps/stable/zerotier/CHANGELOG.md
+18
View File
@@ -0,0 +1,18 @@
# Changelog<br>
<a name="zerotier-1.0.0"></a>
### [zerotier-1.0.0](https://github.com/truecharts/apps/compare/zerotier-0.0.1...zerotier-1.0.0) (2022-03-20)
#### Feat
* move koel and zerotier to stable ([#2232](https://github.com/truecharts/apps/issues/2232))
<a name="zerotier-0.0.1"></a>
### zerotier-0.0.1 (2022-03-19)
#### Feat
* Add zerotier ([#2204](https://github.com/truecharts/apps/issues/2204))
docs/apps/stable/zerotier/CONFIG.md
+7
View File
@@ -0,0 +1,7 @@
# 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](https://truecharts.org/manual/Quick-Start%20Guides/06-linking-apps/) quick-start guide.
##### 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/stable/zerotier/helm-values.md
+34
View File
@@ -0,0 +1,34 @@
# 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 |
|-----|------|---------|-------------|
| image.pullPolicy | string | `"IfNotPresent"` | |
| image.repository | string | `"zerotier/zerotier"` | |
| image.tag | string | `"1.8.4@sha256:b57e76e4291fbc26e1c75df07bc3534e9180457343c7ceff5d7ac8c4e25f6f44"` | |
| persistence.config.enabled | bool | `true` | |
| persistence.config.mountPath | string | `"/var/lib/zerotier-one"` | |
| persistence.tun.enabled | bool | `true` | |
| persistence.tun.hostPath | string | `"/dev/net/tun"` | |
| persistence.tun.hostPathType | string | `""` | |
| persistence.tun.mountPath | string | `"/dev/net/tun"` | |
| persistence.tun.readOnly | bool | `false` | |
| persistence.tun.type | string | `"hostPath"` | |
| podSecurityContext.runAsGroup | int | `0` | |
| podSecurityContext.runAsUser | int | `0` | |
| securityContext.capabilities.add[0] | string | `"NET_ADMIN"` | |
| securityContext.readOnlyRootFilesystem | bool | `false` | |
| securityContext.runAsNonRoot | bool | `false` | |
| service.main.ports.main.port | int | `10190` | |
| service.main.ports.main.protocol | string | `"UDP"` | |
| service.main.ports.main.targetPort | int | `9993` | |
All Rights Reserved - The TrueCharts Project
docs/apps/stable/zerotier/index.md
+37
View File
@@ -0,0 +1,37 @@
# Introduction
ZeroTier is a smart programmable Ethernet switch for planet Earth
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://hub.docker.com/r/zerotier/zerotier>
## Requirements
Kubernetes: `>=1.16.0-0`
## Dependencies
| Repository | Name | Version |
|------------|------|---------|
| https://truecharts.org | common | 9.1.6 |
## Installing the Chart
To install this App on TrueNAS SCALE check our [Quick-Start Guide](https://truecharts.org/manual/Quick-Start%20Guides/02-Installing-an-App/).
## Upgrading, Rolling Back and Uninstalling the Chart
To upgrade, rollback or delete this App from TrueNAS SCALE check our [Quick-Start Guide](https://truecharts.org/manual/Quick-Start%20Guides/04-Upgrade-rollback-delete-an-App/).
## Support
- Please check our [quick-start guides](https://truecharts.org/manual/Quick-Start%20Guides/01-Adding-TrueCharts/) 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/stable/zerotier/security.md
+261
View File
File diff suppressed because one or more lines are too long
docs/index.yaml
+70 -1
View File
@@ -28247,6 +28247,44 @@ entries:
- 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-20T20:28:28.24895705Z"
dependencies:
- name: common
repository: https://truecharts.org
version: 9.1.6
- condition: mariadb.enabled
name: mariadb
repository: https://truecharts.org/
version: 2.0.6
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: 038d0126d76ba3378b360d9ac06a51845a202ed51b38f0017f91738b1c9f88ce
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-1.0.0/koel-1.0.0.tgz
version: 1.0.0
- annotations:
truecharts.org/SCALE-support: "true"
truecharts.org/catagories: |
@@ -77831,6 +77869,37 @@ entries:
- https://github.com/truecharts/apps/releases/download/xteve-4.0.21/xteve-4.0.21.tgz
version: 4.0.21
zerotier:
- annotations:
truecharts.org/SCALE-support: "true"
truecharts.org/catagories: |
- network
truecharts.org/grade: U
apiVersion: v2
appVersion: 1.8.4
created: "2022-03-20T20:28:28.471056896Z"
dependencies:
- name: common
repository: https://truecharts.org
version: 9.1.6
description: ZeroTier is a smart programmable Ethernet switch for planet Earth
digest: b0e4bfd488071a746f9067bc04a6f68518b0b81572b5190fff0b06a3728d1943
home: https://github.com/truecharts/apps/tree/master/charts/stable/zerotier
icon: https://truecharts.org/_static/img/appicons/zerotier.png
keywords:
- zerotier
- network
kubeVersion: '>=1.16.0-0'
maintainers:
- email: info@truecharts.org
name: TrueCharts
url: https://truecharts.org
name: zerotier
sources:
- https://hub.docker.com/r/zerotier/zerotier
type: application
urls:
- https://github.com/truecharts/apps/releases/download/zerotier-1.0.0/zerotier-1.0.0.tgz
version: 1.0.0
- annotations:
truecharts.org/SCALE-support: "true"
truecharts.org/catagories: |
@@ -78725,4 +78794,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-20T19:24:58.902492213Z"
generated: "2022-03-20T20:28:28.479756182Z"