Cloned2Preserve
/
TrueChartsClone
mirror of https://github.com/truecharts/charts.git
1
0
Fork 0
Code

Commit released Helm Chart and docs for TrueCharts 

Signed-off-by: TrueCharts-Bot <bot@truecharts.org>
This commit is contained in:
TrueCharts-Bot 2021-12-27 12:44:49 +00:00
parent d7606c4841
commit b63d32d89d
11 changed files with 1828 additions and 866 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
charts/incubator/shlink/CHANGELOG.md Normal file
View File

@ -0,0 +1,10 @@
# Changelog<br>
<a name="shlink-0.0.1"></a>
### shlink-0.0.1 (2021-12-27)
#### Feat
* Add shlink ([#1616](https://github.com/truecharts/apps/issues/1616))

8
charts/incubator/shlink/CONFIG.md Normal file
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.

39
charts/incubator/shlink/README.md Normal file
View File

@ -0,0 +1,39 @@
# Introduction
A PHP-based self-hosted URL shortener that can be used to serve shortened URLs under your own custom domain.
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/shlinkio/shlink>
## Requirements
Kubernetes: `>=1.16.0-0`
## Dependencies
| Repository | Name | Version |
|------------|------|---------|
| https://truecharts.org/ | postgresql | 6.0.37 |
| https://truecharts.org/ | redis | 1.0.42 |
| https://truecharts.org | common | 8.9.25 |
## 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

45
charts/incubator/shlink/helm-values.md Normal file
View File

@ -0,0 +1,45 @@
# 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_DRIVER | string | `"postgres"` | |
| env.DB_NAME | string | `"{{ .Values.postgresql.postgresqlDatabase }}"` | |
| env.DB_USER | string | `"{{ .Values.postgresql.postgresqlUsername }}"` | |
| env.DEFAULT_DOMAIN | string | `""` | |
| env.GEOLITE_LICENSE_KEY | string | `""` | |
| env.IS_HTTPS_ENABLED | bool | `true` | |
| env.PORT | int | `10153` | |
| 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"` | |
| envValueFrom.REDIS_SERVERS.secretKeyRef.key | string | `"url"` | |
| envValueFrom.REDIS_SERVERS.secretKeyRef.name | string | `"rediscreds"` | |
| image.pullPolicy | string | `"IfNotPresent"` | |
| image.repository | string | `"tccr.io/truecharts/shlink"` | |
| image.tag | string | `"v2.10.1@sha256:2abccbd1a150da840849f01789e4f824e35ee1136da7f5e56abaa86a290794ae"` | |
| podSecurityContext.runAsGroup | int | `0` | |
| podSecurityContext.runAsUser | int | `0` | |
| postgresql.enabled | bool | `true` | |
| postgresql.existingSecret | string | `"dbcreds"` | |
| postgresql.postgresqlDatabase | string | `"shlink"` | |
| postgresql.postgresqlUsername | string | `"shlink"` | |
| redis.enabled | bool | `true` | |
| redis.existingSecret | string | `"rediscreds"` | |
| redis.redisUsername | string | `"default"` | |
| securityContext.readOnlyRootFilesystem | bool | `false` | |
| securityContext.runAsNonRoot | bool | `false` | |
| service.main.ports.main.port | int | `10153` | |
| service.main.ports.main.targetPort | int | `10153` | |
| service.main.protocol | string | `"HTTPS"` | |
All Rights Reserved - The TrueCharts Project

791
charts/incubator/shlink/security.md Normal file
View File

File diff suppressed because one or more lines are too long

10
docs/apps/incubator/shlink/CHANGELOG.md Normal file
View File

@ -0,0 +1,10 @@
# Changelog<br>
<a name="shlink-0.0.1"></a>
### shlink-0.0.1 (2021-12-27)
#### Feat
* Add shlink ([#1616](https://github.com/truecharts/apps/issues/1616))

8
docs/apps/incubator/shlink/CONFIG.md Normal file
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.

45
docs/apps/incubator/shlink/helm-values.md Normal file
View File

@ -0,0 +1,45 @@
# 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_DRIVER | string | `"postgres"` | |
| env.DB_NAME | string | `"{{ .Values.postgresql.postgresqlDatabase }}"` | |
| env.DB_USER | string | `"{{ .Values.postgresql.postgresqlUsername }}"` | |
| env.DEFAULT_DOMAIN | string | `""` | |
| env.GEOLITE_LICENSE_KEY | string | `""` | |
| env.IS_HTTPS_ENABLED | bool | `true` | |
| env.PORT | int | `10153` | |
| 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"` | |
| envValueFrom.REDIS_SERVERS.secretKeyRef.key | string | `"url"` | |
| envValueFrom.REDIS_SERVERS.secretKeyRef.name | string | `"rediscreds"` | |
| image.pullPolicy | string | `"IfNotPresent"` | |
| image.repository | string | `"tccr.io/truecharts/shlink"` | |
| image.tag | string | `"v2.10.1@sha256:2abccbd1a150da840849f01789e4f824e35ee1136da7f5e56abaa86a290794ae"` | |
| podSecurityContext.runAsGroup | int | `0` | |
| podSecurityContext.runAsUser | int | `0` | |
| postgresql.enabled | bool | `true` | |
| postgresql.existingSecret | string | `"dbcreds"` | |
| postgresql.postgresqlDatabase | string | `"shlink"` | |
| postgresql.postgresqlUsername | string | `"shlink"` | |
| redis.enabled | bool | `true` | |
| redis.existingSecret | string | `"rediscreds"` | |
| redis.redisUsername | string | `"default"` | |
| securityContext.readOnlyRootFilesystem | bool | `false` | |
| securityContext.runAsNonRoot | bool | `false` | |
| service.main.ports.main.port | int | `10153` | |
| service.main.ports.main.targetPort | int | `10153` | |
| service.main.protocol | string | `"HTTPS"` | |
All Rights Reserved - The TrueCharts Project

39
docs/apps/incubator/shlink/index.md Normal file
View File

@ -0,0 +1,39 @@
# Introduction
A PHP-based self-hosted URL shortener that can be used to serve shortened URLs under your own custom domain.
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/shlinkio/shlink>
## Requirements
Kubernetes: `>=1.16.0-0`
## Dependencies
| Repository | Name | Version |
|------------|------|---------|
| https://truecharts.org/ | postgresql | 6.0.37 |
| https://truecharts.org/ | redis | 1.0.42 |
| https://truecharts.org | common | 8.9.25 |
## 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

791
docs/apps/incubator/shlink/security.md Normal file
View File

File diff suppressed because one or more lines are too long

908
docs/index.yaml
View File

File diff suppressed because it is too large Load Diff