mirror of
https://github.com/penpot/penpot-helm.git
synced 2024-12-22 05:32:59 -05:00
191 lines
6.4 KiB
Go Template
191 lines
6.4 KiB
Go Template
{{ template "chart.header" . }}
|
||
{{ template "chart.versionBadge" . }}{{ template "chart.appVersionBadge" . }}{{ template "chart.typeBadge" . }}
|
||
|
||
{{ template "chart.description" . }}
|
||
|
||
|
||
## What is Penpot
|
||
|
||
Penpot is the first **open-source** design tool for design and code collaboration. Designers can create stunning designs, interactive prototypes, design systems at scale, while developers enjoy ready-to-use code and make their workflow easy and fast. And all of this with no handoff drama.
|
||
|
||
Penpot is available on browser and [self host](https://penpot.app/self-host). It’s web-based and works with open standards (SVG, CSS and HTML). And last but not least, it’s free!
|
||
|
||
|
||
## Installing the Chart
|
||
|
||
To install the chart with the release name `my-release`:
|
||
|
||
```console
|
||
$ helm repo add penpot http://helm.penpot.app
|
||
$ helm install my-release penpot/{{ template "chart.name" . }}
|
||
```
|
||
|
||
You can customize the installation specify each parameter using the `--set key=value[,key=value]` argument to `helm install`. For example,
|
||
|
||
```console
|
||
helm install my-release \
|
||
--set global.postgresqlEnabled=true \
|
||
--set global.redisEnabled=true \
|
||
--set persistence.assets.enabled=true \
|
||
penpot/{{ template "chart.name" . }}
|
||
```
|
||
|
||
Alternatively, a YAML file that specifies the values for the above parameters can be provided while installing the chart. For example,
|
||
|
||
```console
|
||
helm install my-release -f values.yaml penpot/{{ template "chart.name" . }}
|
||
```
|
||
> **Tip**: You can use the default values.yaml
|
||
|
||
|
||
## Parameters
|
||
|
||
### Global
|
||
|
||
| Key | Type | Default | Description |
|
||
|-----|------|---------|-------------|
|
||
{{- range .Values }}
|
||
{{- if hasPrefix "global" .Key }}
|
||
| {{ .Key }} | {{ .Type }} | {{ if .Default }}{{ .Default }}{{ else }}{{ .AutoDefault }}{{ end }} | {{ if .Description }}{{ .Description }}{{ else }}{{ .AutoDescription }}{{ end }} |
|
||
{{- end }}
|
||
{{- end }}
|
||
|
||
|
||
### General
|
||
|
||
| Key | Type | Default | Description |
|
||
|-----|------|---------|-------------|
|
||
{{- range .Values }}
|
||
{{- if not (or
|
||
(hasPrefix "global" .Key)
|
||
(hasPrefix "config" .Key)
|
||
(hasPrefix "backend" .Key)
|
||
(hasPrefix "frontend" .Key)
|
||
(hasPrefix "exporter" .Key)
|
||
(hasPrefix "persistence" .Key)
|
||
(hasPrefix "ingress" .Key)
|
||
(hasPrefix "postgresql" .Key)
|
||
(hasPrefix "redis" .Key)
|
||
) }}
|
||
| {{ .Key }} | {{ .Type }} | {{ if .Default }}{{ .Default }}{{ else }}{{ .AutoDefault }}{{ end }} | {{ if .Description }}{{ .Description }}{{ else }}{{ .AutoDescription }}{{ end }} |
|
||
{{- end }}
|
||
{{- end }}
|
||
|
||
|
||
|
||
### Penpot Configuration
|
||
|
||
| Key | Type | Default | Description |
|
||
|-----|------|---------|-------------|
|
||
{{- range .Values }}
|
||
{{- if hasPrefix "config" .Key }}
|
||
| {{ .Key }} | {{ .Type }} | {{ if .Default }}{{ .Default }}{{ else }}{{ .AutoDefault }}{{ end }} | {{ if .Description }}{{ .Description }}{{ else }}{{ .AutoDescription }}{{ end }} |
|
||
{{- end }}
|
||
{{- end }}
|
||
|
||
|
||
### Penpot backend
|
||
|
||
| Key | Type | Default | Description |
|
||
|-----|------|---------|-------------|
|
||
{{- range .Values }}
|
||
{{- if hasPrefix "backend" .Key }}
|
||
| {{ .Key }} | {{ .Type }} | {{ if .Default }}{{ .Default }}{{ else }}{{ .AutoDefault }}{{ end }} | {{ if .Description }}{{ .Description }}{{ else }}{{ .AutoDescription }}{{ end }} |
|
||
{{- end }}
|
||
{{- end }}
|
||
|
||
|
||
### Penpot Frontend
|
||
|
||
| Key | Type | Default | Description |
|
||
|-----|------|---------|-------------|
|
||
{{- range .Values }}
|
||
{{- if hasPrefix "frontend" .Key }}
|
||
| {{ .Key }} | {{ .Type }} | {{ if .Default }}{{ .Default }}{{ else }}{{ .AutoDefault }}{{ end }} | {{ if .Description }}{{ .Description }}{{ else }}{{ .AutoDescription }}{{ end }} |
|
||
{{- end }}
|
||
{{- end }}
|
||
|
||
|
||
### Penpot exporter
|
||
|
||
| Key | Type | Default | Description |
|
||
|-----|------|---------|-------------|
|
||
{{- range .Values }}
|
||
{{- if hasPrefix "exporter" .Key }}
|
||
| {{ .Key }} | {{ .Type }} | {{ if .Default }}{{ .Default }}{{ else }}{{ .AutoDefault }}{{ end }} | {{ if .Description }}{{ .Description }}{{ else }}{{ .AutoDescription }}{{ end }} |
|
||
{{- end }}
|
||
{{- end }}
|
||
|
||
### Persistence
|
||
|
||
| Key | Type | Default | Description |
|
||
|-----|------|---------|-------------|
|
||
{{- range .Values }}
|
||
{{- if hasPrefix "persistence" .Key }}
|
||
| {{ .Key }} | {{ .Type }} | {{ if .Default }}{{ .Default }}{{ else }}{{ .AutoDefault }}{{ end }} | {{ if .Description }}{{ .Description }}{{ else }}{{ .AutoDescription }}{{ end }} |
|
||
{{- end }}
|
||
{{- end }}
|
||
|
||
|
||
### Ingress
|
||
|
||
| Key | Type | Default | Description |
|
||
|-----|------|---------|-------------|
|
||
{{- range .Values }}
|
||
{{- if hasPrefix "ingress" .Key }}
|
||
| {{ .Key }} | {{ .Type }} | {{ if .Default }}{{ .Default }}{{ else }}{{ .AutoDefault }}{{ end }} | {{ if .Description }}{{ .Description }}{{ else }}{{ .AutoDescription }}{{ end }} |
|
||
{{- end }}
|
||
{{- end }}
|
||
|
||
|
||
### PostgreSQL
|
||
|
||
| Key | Type | Default | Description |
|
||
|-----|------|---------|-------------|
|
||
{{- range .Values }}
|
||
{{- if hasPrefix "postgresql" .Key }}
|
||
| {{ .Key }} | {{ .Type }} | {{ if .Default }}{{ .Default }}{{ else }}{{ .AutoDefault }}{{ end }} | {{ if .Description }}{{ .Description }}{{ else }}{{ .AutoDescription }}{{ end }} |
|
||
{{- end }}
|
||
{{- end }}
|
||
|
||
> **NOTE**: You can use more parameters according to the [PostgreSQL oficial documentation](https://artifacthub.io/packages/helm/bitnami/postgresql#parameters).
|
||
|
||
|
||
### Redis
|
||
|
||
| Key | Type | Default | Description |
|
||
|-----|------|---------|-------------|
|
||
{{- range .Values }}
|
||
{{- if hasPrefix "redis" .Key }}
|
||
| {{ .Key }} | {{ .Type }} | {{ if .Default }}{{ .Default }}{{ else }}{{ .AutoDefault }}{{ end }} | {{ if .Description }}{{ .Description }}{{ else }}{{ .AutoDescription }}{{ end }} |
|
||
{{- end }}
|
||
{{- end }}
|
||
|
||
> **NOTE**: You can use more parameters according to the [Redis oficial documentation](https://artifacthub.io/packages/helm/bitnami/redis#parameters).
|
||
|
||
|
||
## Resources
|
||
|
||
You can ask and answer questions, have open-ended conversations, and follow along on decisions affecting the project.
|
||
|
||
💾 [Documentation](https://help.penpot.app/technical-guide/)
|
||
|
||
🚀 [Getting Started](https://help.penpot.app/technical-guide/getting-started/)
|
||
|
||
✏️ [Tutorials](https://www.youtube.com/playlist?list=PLgcCPfOv5v54WpXhHmNO7T-YC7AE-SRsr)
|
||
|
||
🏘️ [Architecture](https://help.penpot.app/technical-guide/developer/architecture/)
|
||
|
||
📚 [Dev Diaries](https://penpot.app/dev-diaries.html)
|
||
|
||
|
||
## License ##
|
||
|
||
```
|
||
This Source Code Form is subject to the terms of the Mozilla Public
|
||
License, v. 2.0. If a copy of the MPL was not distributed with this
|
||
file, You can obtain one at http://mozilla.org/MPL/2.0/.
|
||
|
||
Copyright (c) KALEIDOS INC
|
||
```
|
||
Penpot is a Kaleidos’ [open source project](https://kaleidos.net/)
|