Skip to content

Commit

Permalink
✨ (adguard-home): Initial AdGuard Home chart release
Browse files Browse the repository at this point in the history
  • Loading branch information
gabe565 committed Apr 4, 2023
1 parent df7eb76 commit cba8499
Show file tree
Hide file tree
Showing 10 changed files with 463 additions and 0 deletions.
1 change: 1 addition & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -41,6 +41,7 @@ helm delete my-<chart-name>

| Chart | Description |
| ----- | ----------- |
| [adguard-home <img src='https://raw.githubusercontent.com/gabe565/charts/main/charts/adguard-home/icon.svg' alt='adguard-home icon' width='18px' align='right' loading='lazy'>](charts/adguard-home/) | Free and open source, powerful network-wide ads & trackers blocking DNS server. |
| [ascii-telnet <img src='https://raw.githubusercontent.com/gabe565/ascii-telnet-go/a1fd5c9df2fb3a177949c9511b62407c83aedefe/assets/icon.svg' alt='ascii-telnet icon' width='18px' align='right' loading='lazy'>](charts/ascii-telnet/) | Star Wars telnet server |
| [bookstack <img src='https://raw.githubusercontent.com/gabe565/charts/main/charts/bookstack/icon.svg' alt='bookstack icon' width='18px' align='right' loading='lazy'>](charts/bookstack/) | A simple, self-hosted, easy-to-use platform for organising and storing information. |
| [borgmatic <img src='https://raw.githubusercontent.com/borgmatic-collective/borgmatic/1.6.6/docs/static/borgmatic.svg' alt='borgmatic icon' width='18px' align='right' loading='lazy'>](charts/borgmatic/) | borgmatic is simple, configuration-driven backup software for servers and workstations. Protect your files with client-side encryption. Backup your databases too. Monitor it all with integrated third-party services. |
Expand Down
26 changes: 26 additions & 0 deletions charts/adguard-home/.helmignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
# Patterns to ignore when building packages.
# This supports shell glob matching, relative path matching, and
# negation (prefixed with !). Only one pattern per line.
.DS_Store
# Common VCS dirs
.git/
.gitignore
.bzr/
.bzrignore
.hg/
.hgignore
.svn/
# Common backup files
*.swp
*.bak
*.tmp
*.orig
*~
# Various IDEs
.project
.idea/
*.tmproj
.vscode/
# helm-docs templates
*.gotmpl
icon.svg
6 changes: 6 additions & 0 deletions charts/adguard-home/Chart.lock
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
dependencies:
- name: common
repository: https://bjw-s.github.io/helm-charts
version: 1.3.2
digest: sha256:9bb4816882dfc02904f9f347a7995bf7acefd55bd60f925c3a8d80938a2b1ec0
generated: "2023-04-04T13:07:10.124151-05:00"
29 changes: 29 additions & 0 deletions charts/adguard-home/Chart.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
apiVersion: v2
name: adguard-home
description: Free and open source, powerful network-wide ads & trackers blocking DNS server.
home: https://charts.gabe565.com/charts/adguard-home/
icon: https://raw.githubusercontent.com/gabe565/charts/main/charts/adguard-home/icon.svg
type: application
version: 0.1.0
# renovate datasource=docker depName=adguard/adguardhome
appVersion: v0.107.26
kubeVersion: ">=1.22.0-0"
keywords:
- adblock
- dns
- privacy
dependencies:
- name: common
repository: https://bjw-s.github.io/helm-charts
version: 1.3.2
sources:
- https://github.com/AdguardTeam/AdGuardHome
annotations:
artifacthub.io/changes: |-
- kind: added
description: Initial release
artifacthub.io/links: |-
- name: App Source
url: https://github.com/AdguardTeam/AdGuardHome
- name: Chart Source
url: https://github.com/gabe565/charts/tree/main/charts/adguard-home
98 changes: 98 additions & 0 deletions charts/adguard-home/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,98 @@
# adguard-home

<img src="https://raw.githubusercontent.com/gabe565/charts/main/charts/adguard-home/icon.svg" align="right" width="92" alt="adguard-home logo">

![Version: 0.1.0](https://img.shields.io/badge/Version-0.1.0-informational?style=flat)
![Type: application](https://img.shields.io/badge/Type-application-informational?style=flat)
![AppVersion: v0.107.26](https://img.shields.io/badge/AppVersion-v0.107.26-informational?style=flat)

Free and open source, powerful network-wide ads & trackers blocking DNS server.

**Homepage:** <https://charts.gabe565.com/charts/adguard-home/>

**This chart is not maintained by the upstream project and any issues with the chart should be raised
[here](https://github.com/gabe565/charts/issues/new?assignees=gabe565&labels=bug&template=bug_report.yaml&name=adguard-home&version=0.1.0)**

## Source Code

* <https://github.com/AdguardTeam/AdGuardHome>

## Requirements

Kubernetes: `>=1.22.0-0`

## Dependencies

| Repository | Name | Version |
|------------|------|---------|
| <https://bjw-s.github.io/helm-charts> | common | 1.3.2 |

## TL;DR

```console
helm repo add gabe565 https://charts.gabe565.com
helm repo update
helm install adguard-home gabe565/adguard-home
```

## Installing the Chart

To install the chart with the release name `adguard-home`

```console
helm install adguard-home gabe565/adguard-home
```

## Uninstalling the Chart

To uninstall the `adguard-home` deployment

```console
helm uninstall adguard-home
```

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/bjw-s/helm-charts/tree/main/charts/library/common/values.yaml) from the [bjw-s common library](https://github.com/bjw-s/helm-charts/tree/main/charts/library/common).

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

```console
helm install adguard-home \
--set env.TZ="America/New York" \
gabe565/adguard-home
```

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

```console
helm install adguard-home gabe565/adguard-home -f values.yaml
```

## Custom configuration

N/A

## Values

**Important**: When deploying an application Helm chart you can add more values from the bjw-s common library chart [here](https://github.com/bjw-s/helm-charts/tree/main/charts/library/common)

| Key | Type | Default | Description |
|-----|------|---------|-------------|
| config | string | See [values.yaml](./values.yaml) | Default AdGuard Home config file. This will only be copied if an existing config does not exist. [[ref]](https://github.com/AdguardTeam/AdGuardHome/wiki/Configuration) |
| env.TZ | string | `"UTC"` | Set the container timezone |
| image.pullPolicy | string | `"IfNotPresent"` | Image pull policy |
| image.repository | string | `"adguard/adguardhome"` | Image repository |
| image.tag | string | `"v0.107.26"` | Image tag |
| ingress.main | object | See [values.yaml](./values.yaml) | Enable and configure ingress settings for the chart under this key. |
| persistence.config | object | See [values.yaml](./values.yaml) | Configure config persistence settings for the chart under this key. |
| persistence.data | object | See [values.yaml](./values.yaml) | Configure data persistence settings for the chart under this key. |
| service.dns-tcp | object | See [values.yaml](./values.yaml) | Configures settings for the TCP DNS service. |
| service.dns-udp | object | See [values.yaml](./values.yaml) | Configures settings for the UDP DNS service. |
| service.main | object | See [values.yaml](./values.yaml) | Configures settings for the main service. |

---
Autogenerated from chart metadata using [helm-docs](https://github.com/norwoodj/helm-docs)
9 changes: 9 additions & 0 deletions charts/adguard-home/README_CONFIG.md.gotmpl
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
{{- define "custom.custom.configuration.header" -}}
## Custom configuration
{{- end -}}

{{- define "custom.custom.configuration" -}}
{{ template "custom.custom.configuration.header" . }}

N/A
{{- end -}}
1 change: 1 addition & 0 deletions charts/adguard-home/icon.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
1 change: 1 addition & 0 deletions charts/adguard-home/templates/NOTES.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
{{- include "bjw-s.common.lib.chart.notes" . -}}
42 changes: 42 additions & 0 deletions charts/adguard-home/templates/common.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,42 @@
{{/* Append the hardcoded settings */}}
{{- define "adguardHome.harcodedValues" -}}
{{- if .Values.config }}
configMaps:
default-config:
enabled: true
data:
AdGuardHome.yaml: {{ .Values.config }}

persistence:
default-config:
enabled: true
type: configMap
name: {{ include "bjw-s.common.lib.chart.names.fullname" . }}-default-config
mountPath: "-"

initContainers:
copy-default-config:
image: alpine
imagePullPolicy: IfNotPresent
command:
- sh
- -c
- |
if [[ ! -f /opt/adguardhome/conf/AdGuardHome.yaml ]]; then
mkdir -p /opt/adguardhome/conf
cp /tmp/AdGuardHome.yaml /opt/adguardhome/conf/AdGuardHome.yaml
fi
volumeMounts:
- name: default-config
mountPath: /tmp/AdGuardHome.yaml
subPath: AdGuardHome.yaml
- name: config
mountPath: /opt/adguardhome/conf
securityContext:
runAsUser: 0
{{- end }}
{{- end -}}
{{- $_ := merge .Values (include "adguardHome.harcodedValues" . | fromYaml) -}}

{{/* Render the templates */}}
{{ include "bjw-s.common.loader.all" . }}
Loading

0 comments on commit cba8499

Please sign in to comment.