Penpot

Penpot is the first Open Source design and prototyping platform meant for cross-domain teams. Non dependent on operating systems, Penpot is web based and works with open standards (SVG). Penpot invites designers all over the world to fall in love with open source while getting developers excited about the design process in return.

TL;DR

helm repo add codechem https://charts.codechem.com
helm install penpot codechem/penpot

Introduction

Penpot makes design and prototyping accessible to every team in the world. It has a clear focus on design and code teams and its capabilities reflect exactly that. The less hand-off mindset, the more fun for everyone. Being web based, Penpot is not dependent on operating systems or local installations, you will only need to run a modern browser. Using SVG as no other design and prototyping tool does, Penpot files sport compatibility with most of the vectorial tools, are tech friendly and extremely easy to use on the web. It makes sure you will always own your work.

Prerequisites

• Kubernetes 1.18+
• Helm 3.2.0+

Installing the Chart

To install the chart with the release name penpot:

helm install penpot codechem/penpot

The command deploys penpot on the Kubernetes cluster in the default configuration. The Parameters section lists the parameters that can be configured during installation.

Tip: List all releases using helm list

Uninstalling the Chart

To uninstall/delete the penpot deployment:

helm delete penpot

The command removes all the Kubernetes components associated with the chart and deletes the release.

Parameters

Global parameters

Common parameters

Backend parameters

Frontend parameters

Exporter parameters

Persistence parameters

Configuration parameters

PostgreSQL configuration (Check for more parameters here)

Redis configuration (Check for more parameters here)

Specify each parameter using the --set key=value[,key=value] argument to helm install. For example,

helm install example \
  --set user=example \
  --set password=example \
    codechem/example

Alternatively, a YAML file that specifies the values for the above parameters can be provided while installing the chart. For example,

helm install example -f values.yaml codechem/example

Tip: You can use the default values.yaml

Configuration and installation details

Common configuration

There are two types of configuration: options (properties that requieres some value) and flags (that just enables or disables something). The PENPOT_FLAGS environment variable will have an ordered list of strings using this format: <enable|disable>-<flag-name>.

Regarding the flags, they are all listed in the official docs, and here are the additional flags which are not mentioned in the chart configuration above, but you can still use them!

Authentication providers

For configuration of the authentication with third-party auth providers you will need to configure penpot and set the correct callback of your penpot instance in the auth-provider configuration. The callback has the following format:

<https://<your_domain>/api/auth/oauth/<oauth_provider>/callback>

You will need to change <your_domain> and <oauth_provider> according to your setup. This is how it looks with the gitlab.com provider:

<https://<your_domain>/api/auth/oauth/gitlab/callback>

Redis configuration

The redis configuration is very simple, just provide a valid Redis URI. Redis is used mainly for websocket notifications coordination. Currently just a non authentication connection is supported!

License

Copyright © 2022 CodeChem

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.