From f510e374d24e67d20d6667b5aa4c974efaa77a2f Mon Sep 17 00:00:00 2001 From: truecharts-bot Date: Wed, 9 Nov 2022 08:32:53 +0000 Subject: [PATCH] chore: Auto-update chart README [skip ci] --- charts/incubator/misskey/CHANGELOG.md | 9 +++ charts/incubator/misskey/Chart.yaml | 2 +- charts/incubator/misskey/README.md | 109 ++++++++++++++++++++++++++ 3 files changed, 119 insertions(+), 1 deletion(-) diff --git a/charts/incubator/misskey/CHANGELOG.md b/charts/incubator/misskey/CHANGELOG.md index e69de29bb2d..07a117860b2 100644 --- a/charts/incubator/misskey/CHANGELOG.md +++ b/charts/incubator/misskey/CHANGELOG.md @@ -0,0 +1,9 @@ +# Changelog + + + +## [misskey-0.0.1]misskey-0.0.1 (2022-11-09) + +### Feat + +- Add Misskey ([#4315](https://github.com/truecharts/charts/issues/4315)) diff --git a/charts/incubator/misskey/Chart.yaml b/charts/incubator/misskey/Chart.yaml index 1acdad1a7ef..32c0b5d4919 100644 --- a/charts/incubator/misskey/Chart.yaml +++ b/charts/incubator/misskey/Chart.yaml @@ -1,6 +1,6 @@ apiVersion: v2 appVersion: "12.119.0" -home: https://misskey-hub.net +home: https://truecharts.org/docs/charts/incubator/misskey dependencies: - name: common repository: https://library-charts.truecharts.org diff --git a/charts/incubator/misskey/README.md b/charts/incubator/misskey/README.md index e69de29bb2d..7874c087afa 100644 --- a/charts/incubator/misskey/README.md +++ b/charts/incubator/misskey/README.md @@ -0,0 +1,109 @@ +# misskey + +Misskey is an open source, decentralized social media platform that's free forever! + +TrueCharts can be installed as both *normal* Helm Charts or as Apps on TrueNAS SCALE. + +This readme is just an automatically generated general guide on installing our Helm Charts and Apps. +For more information, please click here: [misskey](https://truecharts.org/docs/charts/incubator/misskey) + +**This chart is not maintained by the upstream project and any issues with the chart should be raised [here](https://github.com/truecharts/charts/issues/new/choose)** + +## Source Code + +* +* +* + +## Requirements + +Kubernetes: `>=1.16.0-0` + +## Dependencies + +| Repository | Name | Version | +|------------|------|---------| +| https://charts.truecharts.org/ | postgresql | 8.0.114 | +| https://charts.truecharts.org | redis | 3.0.111 | +| https://library-charts.truecharts.org | common | 10.7.13 | + +## Installing the Chart + +### TrueNAS SCALE + +To install this Chart on TrueNAS SCALE check our [Quick-Start Guide](https://truecharts.org/docs/manual/SCALE%20Apps/Installing-an-App). + +### Helm + +To install the chart with the release name `misskey` + +```console +helm repo add TrueCharts https://charts.truecharts.org +helm repo update +helm install misskey TrueCharts/misskey +``` + +## Uninstall + +### TrueNAS SCALE + +**Upgrading, Rolling Back and Uninstalling the Chart** + +To upgrade, rollback or delete this Chart from TrueNAS SCALE check our [Quick-Start Guide](https://truecharts.org/docs/manual/SCALE%20Apps/Upgrade-rollback-delete-an-App). + +### Helm + +To uninstall the `misskey` deployment + +```console +helm uninstall misskey +``` + +## Configuration + +### Helm + +#### Available Settings + +Read through the 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/truecharts/library-charts/tree/main/charts/common). + +#### Configure using the command line + +Specify each parameter using the `--set key=value[,key=value]` argument to `helm install`. + +```console +helm install misskey \ + --set env.TZ="America/New York" \ + TrueCharts/misskey +``` + +#### 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 misskey TrueCharts/misskey -f values.yaml +``` + +#### Connecting to other charts + +If you need to connect this Chart to other Charts on TrueNAS SCALE, please refer to our [Linking Charts Internally](https://truecharts.org/docs/manual/SCALE%20Apps/linking-apps) quick-start guide. + +## Support + +- Please check our [quick-start guides for TrueNAS SCALE](https://truecharts.org/docs/manual/SCALE%20Apps/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/sponsor) or contributing back to the project any way you can! + +--- + +All Rights Reserved - The TrueCharts Project