charts/charts/stable/emby/README.md
nιcнolaѕ wιlde 0572c4a6b7
[emby] Migrate to common v3 (#961)
* [emby] Migrate to common v3

Signed-off-by: Nicholas Wilde <ncwilde43@gmail.com>
2021-06-10 17:28:46 +02:00

127 lines
4.2 KiB
Markdown

# emby
![Version: 2.0.0](https://img.shields.io/badge/Version-2.0.0-informational?style=flat-square) ![AppVersion: 4.6.1.0](https://img.shields.io/badge/AppVersion-4.6.1.0-informational?style=flat-square)
Emby Server is a home media server
**This chart is not maintained by the upstream project and any issues with the chart should be raised [here](https://github.com/k8s-at-home/charts/issues/new/choose)**
## Source Code
* <https://github.com/MediaBrowser>
* <https://github.com/k8s-at-home/container-images/tree/main/apps/emby>
## Requirements
Kubernetes: `>=1.16.0-0`
## Dependencies
| Repository | Name | Version |
|------------|------|---------|
| https://library-charts.k8s-at-home.com | common | 3.0.1 |
## TL;DR
```console
helm repo add k8s-at-home https://k8s-at-home.com/charts/
helm repo update
helm install emby k8s-at-home/emby
```
## Installing the Chart
To install the chart with the release name `emby`
```console
helm install emby k8s-at-home/emby
```
## Uninstalling the Chart
To uninstall the `emby` deployment
```console
helm uninstall emby
```
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 emby \
--set env.TZ="America/New York" \
k8s-at-home/emby
```
Alternatively, a YAML file that specifies the values for the above parameters can be provided while installing the chart.
```console
helm install emby k8s-at-home/emby -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 |
|-----|------|---------|-------------|
| env | object | `{"TZ":"UTC"}` | environment variables. See more environment variables in the [emby documentation](https://emby.org/docs) |
| image.pullPolicy | string | `"IfNotPresent"` | image pull policy |
| image.repository | string | `"ghcr.io/k8s-at-home/emby"` | image repository |
| image.tag | string | `"v4.6.1.0"` | image tag |
| ingress.main | object | See values.yaml | Enable and configure ingress settings for the chart under this key. |
| persistence | object | See values.yaml | Configure persistence 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).
### [2.0.0]
#### Changed
- **BREAKING**: Upgraded the common library dependency to version 3.0.1. This introduces several breaking changes (`service`, `ingress` and `persistence` keys have been refactored).
Be sure to check out the [library chart](https://github.com/k8s-at-home/library-charts/blob/common-3.0.1/charts/stable/common/) for the up-to-date values.
- Changed image tag to `v4.6.1.0`.
### [1.0.0]
#### Added
- Initial version
#### Changed
- N/A
#### Removed
- N/A
[2.0.0]: #200
[1.0.0]: #100
## Support
- See the [Docs](https://docs.k8s-at-home.com/our-helm-charts/getting-started/)
- Open an [issue](https://github.com/k8s-at-home/charts/issues/new/choose)
- Ask a [question](https://github.com/k8s-at-home/organization/discussions)
- Join our [Discord](https://discord.gg/sTMX7Vh) community
----------------------------------------------
Autogenerated from chart metadata using [helm-docs v1.5.0](https://github.com/norwoodj/helm-docs/releases/v1.5.0)