nikdoof/helm-charts
1
0
Fork 0
mirror of https://github.com/nikdoof/helm-charts.git synced 2025-12-14 05:52:17 +00:00
Code Issues Packages Projects Releases Wiki Activity

Update documentation

Browse Source
This commit is contained in:
Andrew Williams
2020-05-07 19:55:03 +01:00
parent 9a55b3f92c
commit 365626339a
3 changed files with 40 additions and 6 deletions
Download Patch File Download Diff File Expand all files Collapse all files

32
README.md Normal file
View File

@@ -0,0 +1,32 @@
# Helm Charts
A small set of custom Helm charts to cover some smaller applications not covered by Stable and other repos.
[![License](https://img.shields.io/badge/License-MIT-blue.svg)](https://opensource.org/licenses/MIT)
[![](https://github.com/nikdoof/helm-charts/workflows/Release%20Charts/badge.svg?branch=master)](https://github.com/nikdoof/helm-charts/actions)
## Usage
[Helm](https://helm.sh) must be installed to use the charts.
Please refer to Helm's [documentation](https://helm.sh/docs/) to get started.
Once Helm is set up properly, add the repo as follows:
```console
helm repo add nikdoof https://nikdoof.github.io/helm-charts/
```
You can then run `helm search nikdoof` to see the charts.
## Charts
See [charts folder](./charts) for a complete list.
* [aaisp-to-mqtt](./charts/aaisp-to-mqtt) - A tool to pull information from [Andrews & Arnold](https://www.aa.net.uk/) CHAOSv2 API and output to MQTT
* [calibre-web](./charts/calibre-web) - Web app for browsing, reading and downloading eBooks stored in a Calibre database
* [deluge](./charts/deluge) - Deluge torrent client
## License
[MIT License](./LICENSE)

7
charts/calibre-web/README.md
View File

@@ -5,7 +5,8 @@ This is a helm chart for [calibre-web](https://calibre-web.com/) leveraging the
## TL;DR; ## TL;DR;
```shell ```shell
$ helm install ./calibre-web $ helm repo add nikdoof https://nikdoof.github.io/helm-charts/
$ helm install calibre-web
``` ```
## Installing the Chart ## Installing the Chart
@@ -13,7 +14,7 @@ $ helm install ./calibre-web
To install the chart with the release name `my-release`: To install the chart with the release name `my-release`:
```console ```console
helm install --name my-release ./calibre-web helm install --name my-release calibre-web
``` ```
## Uninstalling the Chart ## Uninstalling the Chart
@@ -101,4 +102,4 @@ If you get `Error: rendered manifests contain a resource that already exists. Un
--- ---
Read through the [values.yaml](https://github.com/nikdoof/home-k8s-flux/blob/master/charts/calibre-web/values.yaml) file. It has several commented out suggested values. Read through the [values.yaml](https://github.com/nikdoof/helm-charts/tree/master/charts/calibre-web/values.yaml) file. It has several commented out suggested values.

7
charts/deluge/README.md
View File

@@ -5,7 +5,8 @@ This is a helm chart for [deluge](https://deluge.com/) leveraging the [Linuxserv
## TL;DR; ## TL;DR;
```shell ```shell
$ helm install ./deluge $ helm repo add nikdoof https://nikdoof.github.io/helm-charts/
$ helm install deluge
``` ```
## Installing the Chart ## Installing the Chart
@@ -13,7 +14,7 @@ $ helm install ./deluge
To install the chart with the release name `my-release`: To install the chart with the release name `my-release`:
```console ```console
helm install --name my-release ./deluge helm install --name my-release deluge
``` ```
## Uninstalling the Chart ## Uninstalling the Chart
@@ -105,4 +106,4 @@ If you get `Error: rendered manifests contain a resource that already exists. Un
--- ---
Read through the [values.yaml](https://github.com/nikdoof/home-k8s-flux/blob/master/charts/deluge/values.yaml) file. It has several commented out suggested values. Read through the [values.yaml](https://github.com/nikdoof/helm-charts/tree/master/charts/deluge/values.yaml) file. It has several commented out suggested values.