Skip to content

Commit 1f65d3b

Browse files
authored
Update README.md - add more base features
1 parent be93c39 commit 1f65d3b

File tree

1 file changed

+10
-8
lines changed

1 file changed

+10
-8
lines changed

README.md

Lines changed: 10 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -9,16 +9,18 @@ Uses @mattlqx's [docker image](https://ghcr.io/mattlqx/docker-pixelfed) which is
99

1010
## Features
1111

12+
- 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)
1213
- 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)
13-
- but you can also bring your own valkey, redis, or postgresql database
14+
- but you can also bring your own Valkey, Redis, or Postgresql database
1415
- we're also looking for anyone who wants to test the mariadb subchart
15-
- helm parameter (values.yaml) docs autogenerated via [`helm-docs`](https://github.com/norwoodj/helm-docs) in [`README.md`](./charts/pixelfed/README.md)
16-
- use existing Secrets for valkey, postgresql, and mail (smtp)
17-
- RenovateBot keeps the subcharts and docker image up to date
16+
- use existing Kubernetes Secrets for Valkey, PostgreSQL, and mail (SMTP)
1817
- configurable liveness and readiness probes (or none at all)
19-
- configure tolerations, affinity, nodeselectors
20-
- configure persistence with a PVC we create, or bring your own
21-
- use extra volumes, volumemounts, containers, initContainers
18+
- configurable tolerations, affinity, and nodeselectors
19+
- configurable persistence with a PVC we create, or bring your own
20+
- use extra volumes, volumemounts
21+
- Add sidecar containers or initContainers
22+
- RenovateBot keeps the subcharts and docker image up to date
23+
- The chart is linted and a test install is run on every pull request via a GitHub Workflow
2224

2325
## TLDR
2426

@@ -27,7 +29,7 @@ Uses @mattlqx's [docker image](https://ghcr.io/mattlqx/docker-pixelfed) which is
2729
helm repo add pixelfed https://small-hack.github.io/pixelfed-chart
2830

2931
# download the values.yaml and edit it with your own values such as YOUR hostname
30-
# especially important is pixelfed.app.domain
32+
# especially important are pixelfed.app.domain and pixelfed.mail settings
3133
helm show values pixelfed/pixelfed > values.yaml
3234

3335
# install the chart

0 commit comments

Comments
 (0)