Skip to content

Commit

Permalink
Commit docs updates
Browse files Browse the repository at this point in the history
Signed-off-by: TrueCharts-Bot <bot@truecharts.org>
  • Loading branch information
truecharts-admin committed Apr 9, 2021
1 parent ff7cf83 commit 5f11d73
Show file tree
Hide file tree
Showing 4 changed files with 118 additions and 0 deletions.
8 changes: 8 additions & 0 deletions docs/apps/incubator/deluge/CONFIG.md
Original file line number Diff line number Diff line change
@@ -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.
54 changes: 54 additions & 0 deletions docs/apps/incubator/deluge/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,54 @@
# Introduction

![Version: 2.0.0](https://img.shields.io/badge/Version-2.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)

Deluge App for TrueNAS SCALE

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/deluge>
* <https://github.com/deluge-torrent/deluge>

## Requirements

Kubernetes: `>=1.16.0-0`

## Dependencies

| Repository | Name | Version |
|------------|------|---------|
| https://truecharts.org/ | common | 2.0.0 |

## Installing the Chart

To install the chart with the release name `deluge`

- Open TrueNAS SCALE
- Go to Apps
- Click "Install" for this specific Apps
- Fill out the configuration form

## Uninstalling the Chart

To uninstall the `deluge` 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
54 changes: 54 additions & 0 deletions incubator/deluge/2.0.0/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,54 @@
# Introduction

![Version: 2.0.0](https://img.shields.io/badge/Version-2.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)

Deluge App for TrueNAS SCALE

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/deluge>
* <https://github.com/deluge-torrent/deluge>

## Requirements

Kubernetes: `>=1.16.0-0`

## Dependencies

| Repository | Name | Version |
|------------|------|---------|
| https://truecharts.org/ | common | 2.0.0 |

## Installing the Chart

To install the chart with the release name `deluge`

- Open TrueNAS SCALE
- Go to Apps
- Click "Install" for this specific Apps
- Fill out the configuration form

## Uninstalling the Chart

To uninstall the `deluge` 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
2 changes: 2 additions & 0 deletions incubator/deluge/2.0.0/app-readme.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
Deluge App for TrueNAS SCALE
This App is supplied by TrueCharts, for more information please visit https://truecharts.org

0 comments on commit 5f11d73

Please sign in to comment.