# antennas

![Version: 1.0.0](https://img.shields.io/badge/Version-1.0.0-informational?style=flat-square) ![AppVersion: 4.1.0](https://img.shields.io/badge/AppVersion-4.1.0-informational?style=flat-square)

Antennas

**This chart is not maintained by the upstream project and any issues with the chart should be raised [here](https://github.com/nikdoof/helm-charts/issues/new/choose)**

## Source Code

* <https://github.com/jfarseneau/antennas>
* <https://hub.docker.com/r/thejf/antennas>

## Requirements

Kubernetes: `>=1.16.0-0`

## Dependencies

| Repository | Name | Version |
|------------|------|---------|
| https://library-charts.k8s-at-home.com | common | 4.2.0 |

## TL;DR

```console
helm repo add nikdoof-helm-charts https://nikdoof.github.io/helm-charts/
helm repo update
helm install antennas nikdoof-helm-charts/antennas
```

## Installing the Chart

To install the chart with the release name `antennas`

```console
helm install antennas nikdoof-helm-charts/antennas
```

## Uninstalling the Chart

To uninstall the `antennas` deployment

```console
helm uninstall antennas
```

The command removes all the Kubernetes components associated with the chart **including persistent volumes** and deletes the release.

## Configuration

Read through the [values.yaml](./values.yaml) file. It has several commented out suggested values.
Other values may be used from the [values.yaml](https://github.com/k8s-at-home/library-charts/tree/main/charts/stable/common/values.yaml) from the [common library](https://github.com/k8s-at-home/library-charts/tree/main/charts/stable/common).

Specify each parameter using the `--set key=value[,key=value]` argument to `helm install`.

```console
helm install antennas \
  --set antennas.tvheadend_url="http://tvheadend:9981"\
    nikdoof-helm-charts/antennas
```

Alternatively, a YAML file that specifies the values for the above parameters can be provided while installing the chart.

```console
helm install antennas nikdoof-helm-charts/antennas -f values.yaml
```

## Custom configuration

N/A

## Values

**Important**: When deploying an application Helm chart you can add more values from our common library chart [here](https://github.com/k8s-at-home/library-charts/tree/main/charts/stable/common)

| Key | Type | Default | Description |
|-----|------|---------|-------------|
| antennas | object | See below | Antennas configuration options. See more environment variables in the [antennas documentation](https://github.com/jfarseneau/antennas). |
| antennas.antennas_url | string | `nil` | Externally accessible URL for this antennas instance, defaults to the main service http port. |
| antennas.stream_url | string | `nil` | Optional stream URL, used for situations where the internal and external URL for TVHeadend is different. |
| antennas.tuner_count | int | `4` | Number of tuners to present to Plex |
| antennas.tvheadend_url | string | `nil` | URL of the TVHeadend instance. |
| dnsPolicy | string | `nil` | When hostNetwork is true set dnsPolicy to ClusterFirstWithHostNet |
| env | object | See below | environment variables. See more environment variables in the [antennas documentation](https://github.com/jfarseneau/antennas). |
| hostNetwork | bool | `false` | Enable Antennas to be discoverable via SSDP |
| image.pullPolicy | string | `"IfNotPresent"` | image pull policy |
| image.repository | string | `"thejf/antennas"` | image repository |
| image.tag | string | `"4.1.0"` | image tag |
| ingress.main | object | See values.yaml | Enable and configure ingress settings for the chart under this key. |
| service | object | See values.yaml | Configures service settings for the chart. |

## Changelog

All notable changes to this application Helm chart will be documented in this file but does not include changes from our common library. To read those click [here](https://github.com/k8s-at-home/library-charts/tree/main/charts/stable/common#changelog).

The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).

### [1.0.0]

#### Added

- Initial version

#### Changed

- N/A

#### Removed

- N/A

[1.0.0]: #100

## Support

- Open an [issue](https://github.com/nikdoof/helm-charts/issues/new/choose)

----------------------------------------------
Autogenerated from chart metadata using [helm-docs v1.5.0](https://github.com/norwoodj/helm-docs/releases/v1.5.0)