Update README.md - add more base features

This commit is contained in:
Jesse Hitch
2025-01-24 07:40:31 +01:00
committed by GitHub
parent be93c39550
commit 1f65d3bfbc
+10 -8
View File
@@ -9,16 +9,18 @@ Uses @mattlqx's [docker image](https://ghcr.io/mattlqx/docker-pixelfed) which is
## Features
- helm parameter ([`values.yaml`](./charts/pixelfed/values.yaml)) docs autogenerated using [`helm-docs`](https://github.com/norwoodj/helm-docs) in [`README.md`](./charts/pixelfed/README.md)
- includes bitnami subcharts for [valkey](https://github.com/bitnami/charts/blob/main/bitnami/valkey/README.md#parameters) (redis) and [postgresql](https://github.com/bitnami/charts/blob/main/bitnami/postgresql/README.md#parameters) (database)
- but you can also bring your own valkey, redis, or postgresql database
- but you can also bring your own Valkey, Redis, or Postgresql database
- we're also looking for anyone who wants to test the mariadb subchart
- helm parameter (values.yaml) docs autogenerated via [`helm-docs`](https://github.com/norwoodj/helm-docs) in [`README.md`](./charts/pixelfed/README.md)
- use existing Secrets for valkey, postgresql, and mail (smtp)
- RenovateBot keeps the subcharts and docker image up to date
- use existing Kubernetes Secrets for Valkey, PostgreSQL, and mail (SMTP)
- configurable liveness and readiness probes (or none at all)
- configure tolerations, affinity, nodeselectors
- configure persistence with a PVC we create, or bring your own
- use extra volumes, volumemounts, containers, initContainers
- configurable tolerations, affinity, and nodeselectors
- configurable persistence with a PVC we create, or bring your own
- use extra volumes, volumemounts
- Add sidecar containers or initContainers
- RenovateBot keeps the subcharts and docker image up to date
- The chart is linted and a test install is run on every pull request via a GitHub Workflow
## TLDR
@@ -27,7 +29,7 @@ Uses @mattlqx's [docker image](https://ghcr.io/mattlqx/docker-pixelfed) which is
helm repo add pixelfed https://small-hack.github.io/pixelfed-chart
# download the values.yaml and edit it with your own values such as YOUR hostname
# especially important is pixelfed.app.domain
# especially important are pixelfed.app.domain and pixelfed.mail settings
helm show values pixelfed/pixelfed > values.yaml
# install the chart