Commit docs updates

Signed-off-by: TrueCharts-Bot <bot@truecharts.org>
2021-05-05 20:33:13 +00:00
parent d411726d59
commit 4947fbcf82
3 changed files with 67 additions and 7 deletions
@@ -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 Together" guide:
+https://truecharts.org/manual/linking/
+
+##### Available config options
+In the future this page is going to contain an automated list of options available in the installation/edit UI.
@@ -0,0 +1,54 @@
+# Introduction
+
+![Version: 1.0.0](https://img.shields.io/badge/Version-1.0.0-informational?style=flat-square) ![Type: application](https://img.shields.io/badge/Type-application-informational?style=flat-square) ![AppVersion: auto](https://img.shields.io/badge/AppVersion-auto-informational?style=flat-square)
+
+A free and open source personal finance manager
+
+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/firefly-iii/firefly-iii/>
+
+## Requirements
+
+Kubernetes: `>=1.16.0-0`
+
+## Dependencies
+
+| Repository | Name | Version |
+|------------|------|---------|
+| https://charts.bitnami.com/bitnami | postgresql | 10.4.0 |
+| https://truecharts.org/ | common | 3.5.2 |
+
+## Installing the Chart
+
+To install the chart with the release name `fireflyiii`
+
+- Open TrueNAS SCALE
+- Go to Apps
+- Click "Install" for this specific Apps
+- Fill out the configuration form
+
+## Uninstalling the Chart
+
+To uninstall the `fireflyiii` deployment
+
+- Open TrueNAS SCALE
+- Go to Apps
+- Go to "Installed Apps"
+- Expand the menu in the top-right corner of this App
+- Click "Remove" for this specific Apps
+
+The command removes all the Kubernetes components associated with the chart **including storage volumes** _(Except hostPath Storage)_ and deletes the release.
+
+## Support
+
+- See the [Wiki](https://truecharts.org)
+- Open a [issue](https://github.com/truecharts/apps/issues/new/choose)
+- Ask a [question](https://github.com/truecharts/apps/discussions)
+
+----------------------------------------------
+Autogenerated from chart metadata using [helm-docs v1.5.0](https://github.com/norwoodj/helm-docs/releases/v1.5.0)
+All Rights Reserved - The TrueCharts Project
@@ -1,17 +1,15 @@
 # Introduction

-![Version: 1.2.0](https://img.shields.io/badge/Version-1.2.0-informational?style=flat-square) ![Type: application](https://img.shields.io/badge/Type-application-informational?style=flat-square) ![AppVersion: auto](https://img.shields.io/badge/AppVersion-auto-informational?style=flat-square)
+![Version: 1.0.0](https://img.shields.io/badge/Version-1.0.0-informational?style=flat-square) ![Type: application](https://img.shields.io/badge/Type-application-informational?style=flat-square) ![AppVersion: auto](https://img.shields.io/badge/AppVersion-auto-informational?style=flat-square)

-Unofficial Bitwarden compatible server written in Rust
+A free and open source personal finance manager

 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/truecharts/apps/tree/master/incubator/bitwarden>
-* <https://github.com/k8s-at-home/charts/tree/master/charts/stable/bitwardenrs>
-* <https://github.com/dani-garcia/bitwarden_rs>
+* <https://github.com/firefly-iii/firefly-iii/>

 ## Requirements

@@ -26,7 +24,7 @@ Kubernetes: `>=1.16.0-0`

 ## Installing the Chart

-To install the chart with the release name `bitwarden`
+To install the chart with the release name `fireflyiii`

 - Open TrueNAS SCALE
 - Go to Apps
@@ -35,7 +33,7 @@ To install the chart with the release name `bitwarden`

 ## Uninstalling the Chart

-To uninstall the `bitwarden` deployment
+To uninstall the `fireflyiii` deployment

 - Open TrueNAS SCALE
 - Go to Apps