Post Code-Freeze Review, Bugsfixes and Documentation

- Fix traefik Portal Button - Touchup Security Policies - Update Support Policies - Re-Add Deluge as incubator App - Add Canary to Security Policies - Add all-contributors basic config
2021-04-09 13:34:29 +02:00
parent 56211222bf
commit cde18639c7
568 changed files with 2295 additions and 1614 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,56 @@
+# 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)
+
+HandBrake is a tool for converting video from nearly any format to a selection of modern, widely supported codecs.
+
+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/stable/handbrake>
+* <https://github.com/jlesage/docker-handbrake>
+* <https://hub.docker.com/r/jlesage/handbrake/>
+* <https://handbrake.fr/>
+
+## 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 `handbrake`
+
+- Open TrueNAS SCALE
+- Go to Apps
+- Click "Install" for this specific Apps
+- Fill out the configuration form
+
+## Uninstalling the Chart
+
+To uninstall the `handbrake` 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
@@ -0,0 +1,6 @@
+# Installation Notes
+
+* If you enable `Reverse Proxy` for `Handbrake`, you need to have `SECURE_CONNECTION` set to `0` and `Port Type` set to `HTTP`, otherwise you may run into errors for `Too many redirects`.
+* `VNC` can't be `Reversed Proxied`. if you want to use `VNC`, you must set this service to `NodePort` instead of `clusterIP`.
+* `VNC` with `SECURE_CONNECTION` set 1, only works with very few clients. One of them is `SSVNC`.
+* `SECURE_CONNECTION` affects both `WebUI` and `VNC`.