Skip to content

Commit 76b1e24

Browse files
jessebotjessebot
committed
add more documentation to the chart itself
1 parent 1f65d3b commit 76b1e24

File tree

2 files changed

+235
-5
lines changed

2 files changed

+235
-5
lines changed

‎charts/pixelfed/README.md‎

Lines changed: 112 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,90 @@
1-
# pixelfed
1+
# Pixelfed Helm Chart
22

3-
![Version: 0.19.0](https://img.shields.io/badge/Version-0.19.0-informational?style=flat-square) ![Type: application](https://img.shields.io/badge/Type-application-informational?style=flat-square) ![AppVersion: v0.12.4-nginx](https://img.shields.io/badge/AppVersion-v0.12.4--nginx-informational?style=flat-square)
3+
![Version: 0.19.0](https://img.shields.io/badge/Version-0.19.0-informational?style=flat-square) ![AppVersion: v0.12.4-nginx](https://img.shields.io/badge/AppVersion-v0.12.4--nginx-informational?style=flat-square)
44

55
A Helm chart for deploying Pixelfed on Kubernetes
66

7+
* [TLDR](#tldr)
8+
* [Preparation for installation](#preparation-for-installation)
9+
* [Actually installing the chart](#actually-installing-the-chart)
10+
* [Maintainers](#maintainers)
11+
* [Requirements](#requirements)
12+
* [Sources for included subcharts](#sources-for-included-subcharts)
13+
* [How to use persistence](#how-to-use-persistence)
14+
* [Values (helm parameters from values.yaml)](#values-helm-parameters-from-valuesyaml)
15+
16+
## TLDR
17+
18+
### Preparation for installation
19+
20+
```bash
21+
# add the chart repo to your helm repos
22+
helm repo add pixelfed https://small-hack.github.io/pixelfed-chart
23+
24+
# download the values.yaml and edit it with your own values such as YOUR hostname
25+
# especially important are pixelfed.app.domain and pixelfed.mail settings
26+
helm show values pixelfed/pixelfed > values.yaml
27+
```
28+
29+
Your `values.yaml` will need at least the following to start:
30+
31+
```yaml
32+
pixelfed:
33+
# app specific settings
34+
app:
35+
# -- This key is used by the Illuminate encrypter service and should
36+
# be set to a random, 32 character string, otherwise these encrypted strings
37+
# will not be safe. If you don't generate one, we'll generate one for you
38+
# however it will change everytime you upgrade the helm chart, so it should
39+
# only be used for testing. In production, please set this, or pixelfed.app.existingSecret
40+
key: ""
41+
# -- use an existing Kuberentes Secret to store the app key
42+
# If set, ignores pixelfed.app.key
43+
existingSecret: ""
44+
# -- key in pixelfed.app.existingSecret to use for the app key
45+
existingSecretKey: ""
46+
# -- The name of your server/instance
47+
name: "Pixelfed"
48+
# -- change this to the domain of your pixelfed instance
49+
url: "https://localhost"
50+
# -- The domain of your server, without https://
51+
domain: ""
52+
53+
# Mail Configuration (Post-Installer)
54+
mail:
55+
# -- mail server hostname
56+
host: smtp.mailtrap.io
57+
# -- mail server username
58+
username: ""
59+
# -- mail server password
60+
password: ""
61+
# -- address to use for sending emails
62+
from_address: "[email protected]"
63+
# -- name to use for sending emails
64+
from_name: "Pixelfed"
65+
# -- name of an existing Kubernetes Secret for mail credentials
66+
existingSecret: ""
67+
# keys in existing secret
68+
existingSecretKeys:
69+
# -- key in existing Kubernetes Secret for host. If set, ignores mail.host
70+
host: ""
71+
# -- key in existing Kubernetes Secret for port. If set, ignores mail.port
72+
port: ""
73+
# -- key in existing Kubernetes Secret for username. If set, ignores mail.username
74+
username: ""
75+
# -- key in existing Kubernetes Secret for password. If set, ignores mail.password
76+
password: ""
77+
```
78+
79+
### Actually installing the chart
80+
81+
```bash
82+
# install the chart
83+
helm install --namespace pixelfed --create-namespace pixelfed/pixelfed --values values.yaml
84+
```
85+
86+
## Maintainers
87+
788
## Maintainers
889

990
| Name | Email | Url |
@@ -12,12 +93,41 @@ A Helm chart for deploying Pixelfed on Kubernetes
1293

1394
## Requirements
1495

96+
These are all subcharts that you can choose to install, but you can also bring your own:
97+
1598
| Repository | Name | Version |
1699
|------------|------|---------|
17100
| oci://registry-1.docker.io/bitnamicharts | mariadb | 20.2.2 |
18101
| oci://registry-1.docker.io/bitnamicharts | postgresql | 16.4.5 |
19102
| oci://registry-1.docker.io/bitnamicharts | valkey | 2.2.3 |
20103

104+
### Sources for included subcharts
105+
106+
- https://github.com/bitnami/charts/tree/main/bitnami/valkey
107+
- https://github.com/bitnami/charts/tree/main/bitnami/mariadb
108+
- https://github.com/bitnami/charts/tree/main/bitnami/postgresql
109+
110+
## How to use persistence
111+
112+
This chart has the option to use PVCs (Persistent Volume Claims) for storing data on pod restarts.
113+
114+
```yaml
115+
persistence:
116+
# -- enable persistence for the pixelfed pod
117+
enabled: false
118+
# -- storage class name
119+
storageClassName: ""
120+
# -- size of the persistent volume claim to create. Tgnored if persistence.existingClaim is set
121+
storage: 2Gi
122+
# -- accessMode
123+
accessModes:
124+
- ReadWriteOnce
125+
# -- using an existing PVC instead of creating one with this chart
126+
existingClaim: ""
127+
```
128+
129+
## Values (helm parameters from values.yaml)
130+
21131
## Values
22132
23133
| Key | Type | Default | Description |
@@ -235,6 +345,3 @@ A Helm chart for deploying Pixelfed on Kubernetes
235345
| valkey.tls.authClients | bool | `true` | |
236346
| valkey.tls.autoGenerated | bool | `false` | |
237347
| valkey.tls.enabled | bool | `false` | |
238-
239-
----------------------------------------------
240-
Autogenerated from chart metadata using [helm-docs v1.14.2](https://github.com/norwoodj/helm-docs/releases/v1.14.2)

‎charts/pixelfed/README.md.gotmpl‎

Lines changed: 123 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,123 @@
1+
# Pixelfed Helm Chart
2+
3+
{{ template "chart.versionBadge" . }} {{ template "chart.appVersionBadge" . }}
4+
5+
{{ template "chart.description" . }}
6+
7+
* [TLDR](#tldr)
8+
* [Preparation for installation](#preparation-for-installation)
9+
* [Actually installing the chart](#actually-installing-the-chart)
10+
* [Maintainers](#maintainers)
11+
* [Requirements](#requirements)
12+
* [Sources for included subcharts](#sources-for-included-subcharts)
13+
* [How to use persistence](#how-to-use-persistence)
14+
* [Values (helm parameters from values.yaml)](#values-helm-parameters-from-valuesyaml)
15+
16+
## TLDR
17+
18+
### Preparation for installation
19+
20+
```bash
21+
# add the chart repo to your helm repos
22+
helm repo add pixelfed https://small-hack.github.io/pixelfed-chart
23+
24+
# download the values.yaml and edit it with your own values such as YOUR hostname
25+
# especially important are pixelfed.app.domain and pixelfed.mail settings
26+
helm show values pixelfed/pixelfed > values.yaml
27+
```
28+
29+
Your `values.yaml` will need at least the following to start:
30+
31+
```yaml
32+
pixelfed:
33+
# app specific settings
34+
app:
35+
# -- This key is used by the Illuminate encrypter service and should
36+
# be set to a random, 32 character string, otherwise these encrypted strings
37+
# will not be safe. If you don't generate one, we'll generate one for you
38+
# however it will change everytime you upgrade the helm chart, so it should
39+
# only be used for testing. In production, please set this, or pixelfed.app.existingSecret
40+
key: ""
41+
# -- use an existing Kuberentes Secret to store the app key
42+
# If set, ignores pixelfed.app.key
43+
existingSecret: ""
44+
# -- key in pixelfed.app.existingSecret to use for the app key
45+
existingSecretKey: ""
46+
# -- The name of your server/instance
47+
name: "Pixelfed"
48+
# -- change this to the domain of your pixelfed instance
49+
url: "https://localhost"
50+
# -- The domain of your server, without https://
51+
domain: ""
52+
53+
# Mail Configuration (Post-Installer)
54+
mail:
55+
# -- mail server hostname
56+
host: smtp.mailtrap.io
57+
# -- mail server username
58+
username: ""
59+
# -- mail server password
60+
password: ""
61+
# -- address to use for sending emails
62+
from_address: "[email protected]"
63+
# -- name to use for sending emails
64+
from_name: "Pixelfed"
65+
# -- name of an existing Kubernetes Secret for mail credentials
66+
existingSecret: ""
67+
# keys in existing secret
68+
existingSecretKeys:
69+
# -- key in existing Kubernetes Secret for host. If set, ignores mail.host
70+
host: ""
71+
# -- key in existing Kubernetes Secret for port. If set, ignores mail.port
72+
port: ""
73+
# -- key in existing Kubernetes Secret for username. If set, ignores mail.username
74+
username: ""
75+
# -- key in existing Kubernetes Secret for password. If set, ignores mail.password
76+
password: ""
77+
```
78+
79+
### Actually installing the chart
80+
81+
```bash
82+
# install the chart
83+
helm install --namespace pixelfed --create-namespace pixelfed/pixelfed --values values.yaml
84+
```
85+
86+
## Maintainers
87+
88+
{{ template "chart.maintainersSection" . }}
89+
90+
## Requirements
91+
92+
These are all subcharts that you can choose to install, but you can also bring your own:
93+
94+
{{ template "chart.requirementsTable" . }}
95+
96+
### Sources for included subcharts
97+
98+
- https://github.com/bitnami/charts/tree/main/bitnami/valkey
99+
- https://github.com/bitnami/charts/tree/main/bitnami/mariadb
100+
- https://github.com/bitnami/charts/tree/main/bitnami/postgresql
101+
102+
## How to use persistence
103+
104+
This chart has the option to use PVCs (Persistent Volume Claims) for storing data on pod restarts.
105+
106+
```yaml
107+
persistence:
108+
# -- enable persistence for the pixelfed pod
109+
enabled: false
110+
# -- storage class name
111+
storageClassName: ""
112+
# -- size of the persistent volume claim to create. Tgnored if persistence.existingClaim is set
113+
storage: 2Gi
114+
# -- accessMode
115+
accessModes:
116+
- ReadWriteOnce
117+
# -- using an existing PVC instead of creating one with this chart
118+
existingClaim: ""
119+
```
120+
121+
## Values (helm parameters from values.yaml)
122+
123+
{{ template "chart.valuesSection" . }}

0 commit comments

Comments
 (0)