|
| 1 | +# homer |
| 2 | + |
| 3 | +  |
| 4 | + |
| 5 | +A dead simple static HOMepage for your servER to keep your services on hand, from a simple yaml configuration file. |
| 6 | + |
| 7 | +**This chart is not maintained by the upstream project and any issues with the chart should be raised [here](https://github.com/geek-cookbook/charts/issues/new/choose)** |
| 8 | + |
| 9 | +## Source Code |
| 10 | + |
| 11 | +* <https://github.com/bastienwirtz/homer> |
| 12 | + |
| 13 | +## Requirements |
| 14 | + |
| 15 | +Kubernetes: `>=1.16.0-0` |
| 16 | + |
| 17 | +## Dependencies |
| 18 | + |
| 19 | +| Repository | Name | Version | |
| 20 | +|------------|------|---------| |
| 21 | +| https://library-charts.k8s-at-home.com | common | 4.5.2 | |
| 22 | + |
| 23 | +## TL;DR |
| 24 | + |
| 25 | +```console |
| 26 | +helm repo add geek-cookbook https://geek-cookbook.github.io/charts/ |
| 27 | +helm repo update |
| 28 | +helm install homer geek-cookbook/homer |
| 29 | +``` |
| 30 | + |
| 31 | +## Installing the Chart |
| 32 | + |
| 33 | +To install the chart with the release name `homer` |
| 34 | + |
| 35 | +```console |
| 36 | +helm install homer geek-cookbook/homer |
| 37 | +``` |
| 38 | + |
| 39 | +## Uninstalling the Chart |
| 40 | + |
| 41 | +To uninstall the `homer` deployment |
| 42 | + |
| 43 | +```console |
| 44 | +helm uninstall homer |
| 45 | +``` |
| 46 | + |
| 47 | +The command removes all the Kubernetes components associated with the chart **including persistent volumes** and deletes the release. |
| 48 | + |
| 49 | +## Configuration |
| 50 | + |
| 51 | +Read through the [values.yaml](./values.yaml) file. It has several commented out suggested values. |
| 52 | +Other values may be used from the [values.yaml](https://github.com/geek-cookbook/library-charts/tree/main/charts/stable/common/values.yaml) from the [common library](https://github.com/geek-cookbook/library-charts/tree/main/charts/stable/common). |
| 53 | + |
| 54 | +Specify each parameter using the `--set key=value[,key=value]` argument to `helm install`. |
| 55 | + |
| 56 | +```console |
| 57 | +helm install homer \ |
| 58 | + --set env.TZ="America/New York" \ |
| 59 | + geek-cookbook/homer |
| 60 | +``` |
| 61 | + |
| 62 | +Alternatively, a YAML file that specifies the values for the above parameters can be provided while installing the chart. |
| 63 | + |
| 64 | +```console |
| 65 | +helm install homer geek-cookbook/homer -f values.yaml |
| 66 | +``` |
| 67 | + |
| 68 | +## Custom configuration |
| 69 | + |
| 70 | +N/A |
| 71 | + |
| 72 | +## Values |
| 73 | + |
| 74 | +**Important**: When deploying an application Helm chart you can add more values from our common library chart [here](https://github.com/geek-cookbook/library-charts/tree/main/charts/stable/common) |
| 75 | + |
| 76 | +| Key | Type | Default | Description | |
| 77 | +|-----|------|---------|-------------| |
| 78 | +| configmap.config.data | object | See values.yaml | Homer configuration. See [image documentation](https://github.com/bastienwirtz/homer/blob/main/docs/configuration.md) for more information. | |
| 79 | +| configmap.config.enabled | bool | `false` | Store homer configuration as a ConfigMap | |
| 80 | +| env | object | See below | environment variables. | |
| 81 | +| env.TZ | string | `"UTC"` | Set the container timezone | |
| 82 | +| image.pullPolicy | string | `"IfNotPresent"` | image pull policy | |
| 83 | +| image.repository | string | `"b4bz/homer"` | image repository | |
| 84 | +| image.tag | string | `nil` | | |
| 85 | +| ingress.main | object | See values.yaml | Enable and configure ingress settings for the chart under this key. | |
| 86 | +| persistence | object | See values.yaml | Configure persistence settings for the chart under this key. | |
| 87 | +| securityContext.runAsGroup | int | `1000` | Specify the group ID the application will run as | |
| 88 | +| securityContext.runAsNonRoot | bool | `true` | Enable validation that the container must run as non-root user | |
| 89 | +| securityContext.runAsUser | int | `1000` | Specify the user ID the application will run as | |
| 90 | +| service | object | See values.yaml | Configures service settings for the chart. | |
| 91 | + |
| 92 | +## Changelog |
| 93 | + |
| 94 | +### Version 8.0.2 |
| 95 | + |
| 96 | +#### Added |
| 97 | + |
| 98 | +N/A |
| 99 | + |
| 100 | +#### Changed |
| 101 | + |
| 102 | +* Upgraded `common` chart dependency to version 4.5.2 |
| 103 | + |
| 104 | +#### Fixed |
| 105 | + |
| 106 | +N/A |
| 107 | + |
| 108 | +### Older versions |
| 109 | + |
| 110 | +A historical overview of changes can be found on [ArtifactHUB](https://artifacthub.io/packages/helm/geek-cookbook/homer?modal=changelog) |
| 111 | + |
| 112 | +## Support |
| 113 | + |
| 114 | +- See the [Docs](https://geek-cookbook.funkypenguin.co.nz/) |
| 115 | +- Open an [issue](https://github.com/geek-cookbook/charts/issues/new/choose) |
| 116 | +- Ask a [question](https://github.com/geek-cookbook/organization/discussions) |
| 117 | +- Join our [Discord](http://chat.funkypenguin.co.nz) community |
| 118 | + |
| 119 | +---------------------------------------------- |
| 120 | +Autogenerated from chart metadata using [helm-docs v0.1.1](https://github.com/geek-cookbook/helm-docs/releases/v0.1.1) |
0 commit comments