chore: Auto-update chart README [skip ci]
This commit is contained in:
truecharts-bot
@@ -1,6 +1,14 @@
|
||||
# Changelog
|
||||
|
||||
|
||||
## [st-reborn-server-0.0.3](https://github.com/truecharts/apps/compare/st-reborn-server-0.0.2...st-reborn-server-0.0.3) (2022-07-19)
|
||||
|
||||
### Chore
|
||||
|
||||
- Update Readme and Description on SCALE
|
||||
|
||||
|
||||
|
||||
## [st-reborn-server-0.0.2](https://github.com/truecharts/apps/compare/st-reborn-server-0.0.1...st-reborn-server-0.0.2) (2022-07-18)
|
||||
|
||||
### Chore
|
||||
|
||||
@@ -1,16 +1,15 @@
|
||||
# st-reborn-server
|
||||
|
||||
  
|
||||
  
|
||||
|
||||
Skyrim Together Reborn server files.
|
||||
|
||||
**Homepage:** <https://github.com/truecharts/apps/tree/master/charts/incubator/st-reborn-server>
|
||||
TrueCharts can be installed as both *normal* Helm Charts or as Apps on TrueNAS SCALE.
|
||||
|
||||
## Maintainers
|
||||
This readme is just an automatically generated general guide on installing our Helm Charts and Apps.
|
||||
For more information, please click here: [st-reborn-server](https://truecharts.org/charts/stable/st-reborn-server)
|
||||
|
||||
| Name | Email | Url |
|
||||
| ---- | ------ | --- |
|
||||
| TrueCharts | info@truecharts.org | https://truecharts.org |
|
||||
**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
|
||||
|
||||
@@ -21,29 +20,89 @@ Skyrim Together Reborn server files.
|
||||
|
||||
Kubernetes: `>=1.16.0-0`
|
||||
|
||||
## Dependencies
|
||||
|
||||
| Repository | Name | Version |
|
||||
|------------|------|---------|
|
||||
| https://library-charts.truecharts.org | common | 10.4.4 |
|
||||
|
||||
## Values
|
||||
## Installing the Chart
|
||||
|
||||
| Key | Type | Default | Description |
|
||||
|-----|------|---------|-------------|
|
||||
| image.pullPolicy | string | `"IfNotPresent"` | |
|
||||
| image.repository | string | `"tccr.io/truecharts/st-reborn-server"` | |
|
||||
| image.tag | string | `"v1.2.0@sha256:0e1fe6f85a8d637aaaa5a522e7418dc9e817da2b1e6589842a2b56c5cc9e0fbc"` | |
|
||||
| persistence.config.enabled | bool | `true` | |
|
||||
| persistence.config.mountPath | string | `"/home/server/config"` | |
|
||||
| persistence.data.enabled | bool | `true` | |
|
||||
| persistence.data.mountPath | string | `"/home/server/Data"` | |
|
||||
| persistence.logs.enabled | bool | `true` | |
|
||||
| persistence.logs.mountPath | string | `"/home/server/logs"` | |
|
||||
| probes.liveness.enabled | bool | `false` | |
|
||||
| probes.readiness.enabled | bool | `false` | |
|
||||
| probes.startup.enabled | bool | `false` | |
|
||||
| service.main.ports.main.port | int | `10578` | |
|
||||
| service.main.ports.main.protocol | string | `"UDP"` | |
|
||||
| service.main.ports.main.targetPort | int | `10578` | |
|
||||
### TrueNAS SCALE
|
||||
|
||||
----------------------------------------------
|
||||
Autogenerated from chart metadata using [helm-docs v0.1.1](https://github.com/k8s-at-home/helm-docs/releases/v0.1.1)
|
||||
To install this App on TrueNAS SCALE check our [Quick-Start Guide](https://truecharts.org/manual/Quick-Start%20Guides/02-Installing-an-App/).
|
||||
|
||||
### Helm
|
||||
|
||||
To install the chart with the release name `st-reborn-server`
|
||||
|
||||
```console
|
||||
helm repo add TrueCharts https://helm.truecharts.org
|
||||
helm repo update
|
||||
helm install st-reborn-server TrueCharts/st-reborn-server
|
||||
```
|
||||
|
||||
## Uninstall
|
||||
|
||||
### TrueNAS SCALE
|
||||
|
||||
**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/).
|
||||
|
||||
### Helm
|
||||
|
||||
To uninstall the `st-reborn-server` deployment
|
||||
|
||||
```console
|
||||
helm uninstall st-reborn-server
|
||||
```
|
||||
|
||||
## Configuration
|
||||
|
||||
### Helm
|
||||
|
||||
#### Available Settings
|
||||
|
||||
Read through the [values.yaml](./values.yaml) file. It has several commented out suggested values.
|
||||
Other values may be used from the [values.yaml](https://github.com/truecharts/library-charts/tree/main/charts/stable/common/values.yaml) from the [common library](https://github.com/k8s-at-home/library-charts/tree/main/charts/stable/common).
|
||||
|
||||
#### Configure using the Commandline
|
||||
|
||||
Specify each parameter using the `--set key=value[,key=value]` argument to `helm install`.
|
||||
|
||||
```console
|
||||
helm install st-reborn-server \
|
||||
--set env.TZ="America/New York" \
|
||||
TrueCharts/st-reborn-server
|
||||
```
|
||||
|
||||
#### Configure using a yaml file
|
||||
|
||||
Alternatively, a YAML file that specifies the values for the above parameters can be provided while installing the chart.
|
||||
|
||||
```console
|
||||
helm install st-reborn-server TrueCharts/st-reborn-server -f values.yaml
|
||||
```
|
||||
|
||||
#### 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.
|
||||
|
||||
## Support
|
||||
|
||||
- Please check our [quick-start guides for TrueNAS SCALE](https://truecharts.org/docs/manual/SCALE%20Apps/Quick-Start%20Guides/Important-MUST-READ).
|
||||
- See the [Website](https://truecharts.org)
|
||||
- Check our [Discord](https://discord.gg/tVsPTHWTtr)
|
||||
- Open a [issue](https://github.com/truecharts/apps/issues/new/choose)
|
||||
|
||||
---
|
||||
|
||||
## Sponsor TrueCharts
|
||||
|
||||
TrueCharts can only exist due to the incredible effort of our staff.
|
||||
Please consider making a [donation](https://truecharts.org/docs/about/sponsor) or contributing back to the project any way you can!
|
||||
|
||||
---
|
||||
|
||||
All Rights Reserved - The TrueCharts Project
|
||||
|
||||
Reference in New Issue
Block a user