fix(README): describe project
All checks were successful
continuous-integration/drone/push Build is passing
All checks were successful
continuous-integration/drone/push Build is passing
This commit is contained in:
parent
1804368bec
commit
430a3eb8f9
19
README.md
19
README.md
@ -1,25 +1,30 @@
|
||||
# postfixadmin-fetchmail-charts
|
||||
|
||||
[![Build Status](https://postfixadmin-fetchmail.cryptic.systems/api/badges/volker.raschek/postfixadmin-fetchmail-runner-charts/status.svg)](https://postfixadmin-fetchmail.cryptic.systems/volker.raschek/postfixadmin-fetchmail-runner-charts)
|
||||
[![Build Status](https://git.cryptic.systems/api/badges/volker.raschek/postfixadmin-fetchmail-charts/status.svg)](https://git.cryptic.systems/volker.raschek/postfixadmin-fetchmail-charts)
|
||||
[![Artifact Hub](https://img.shields.io/endpoint?url=https://artifacthub.io/badge/repository/volker-raschek)](https://artifacthub.io/packages/search?repo=volker-raschek)
|
||||
|
||||
This is helm chart is an addon for
|
||||
[postfixadmin-fetchmail-runner](https://github.com/postfixadmin-fetchmail/postfixadmin-fetchmail-runner-kube)
|
||||
and should replace the official unmainted helm chart
|
||||
[repository](https://github.com/postfixadmin-fetchmail/postfixadmin-fetchmail-runner-kube).
|
||||
This helm chart contains the cron job deployment of the fetchmail job
|
||||
from the [postfixadmin](https://github.com/postfixadmin/postfixadmin) project.
|
||||
The backend database provided by postfixadmin is required. Checkout the [helm
|
||||
chart](https://github.com/volker-raschek/postfixadmin-charts) for postfixadmin
|
||||
to deploy the application on kubernetes.
|
||||
|
||||
Alternatively can also the database backend of an external postfixadmin
|
||||
installtion be used. Exactly for this reason is the cron job of fetchmail
|
||||
independent of the postfixadmin chart.
|
||||
|
||||
This helm chart can be found on [artifacthub.io](https://artifacthub.io/) and
|
||||
can be installed via helm.
|
||||
|
||||
```bash
|
||||
helm repo add volker.raschek https://charts.cryptic.systems/volker.raschek
|
||||
helm install postfixadmin-fetchmail volker.raschek/postfixadmin-fetchmail-runner
|
||||
helm install postfixadmin-fetchmail volker.raschek/postfixadmin-fetchmail
|
||||
```
|
||||
|
||||
## Customization
|
||||
|
||||
All [configuration
|
||||
options](https://github.com/volker-raschek/postfixadmin-fetchmail-docker#supported-environment-variables)
|
||||
options](https://github.com/volker-raschek/postfixadmin-fetchmail-docker#environment-variables)
|
||||
can be defined in the `values.yml` file below the `config` section.
|
||||
Alternatively can be the options passed via the `--set` flag of the `helm
|
||||
install` command.
|
||||
|
@ -3,7 +3,7 @@
|
||||
# Declare variables to be passed into your templates.
|
||||
|
||||
image:
|
||||
repository: docker.io/volkerraschek/fetchmail
|
||||
repository: docker.io/volkerraschek/postfixadmin-fetchmail
|
||||
pullPolicy: IfNotPresent
|
||||
# Overrides the image tag whose default is the chart appVersion.
|
||||
tag: ""
|
||||
|
Loading…
Reference in New Issue
Block a user