shlink-web

shlink-web

A ReactJS-based progressive web application for Shlink.

TL;DR;

helm repo add christianhuth https://charts.christianhuth.de
helm repo update
helm install my-release christianhuth/shlink-web

Introduction

This chart bootstraps the Web Client of the self-hosted URL shortener called Shlink using the Helm package manager.

Prerequisites

• Kubernetes 1.19+

Installing the Chart

To install the chart with the release name my-release:

helm repo add christianhuth https://charts.christianhuth.de
helm repo update
helm install my-release christianhuth/shlink-web

These commands deploy the Shlink Web Client on the Kubernetes cluster in the default configuration. The Values section lists the values that can be configured during installation.

Tip: List all releases using helm list

Uninstalling the Chart

To uninstall the my-release deployment:

helm uninstall my-release

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

Values

Key	Type	Default	Description
affinity	object	{}	Affinity settings for pod assignment
autoscaling.enabled	bool	false
autoscaling.maxReplicas	int	100
autoscaling.minReplicas	int	1
autoscaling.targetCPUUtilizationPercentage	int	80
configuration	list	[]
fullnameOverride	string	""	String to fully override "shlink-web.fullname"
image.pullPolicy	string	"Always"	image pull policy
image.repository	string	"shlinkio/shlink-web-client"	image repository
image.tag	string	"4.1.2"	Overrides the image tag
imagePullSecrets	list	[]	If defined, uses a Secret to pull an image from a private Docker registry or repository.
ingress.annotations	object	{}
ingress.className	string	""
ingress.enabled	bool	false
ingress.hosts[0].host	string	"chart-example.local"
ingress.hosts[0].paths[0].path	string	"/"
ingress.hosts[0].paths[0].pathType	string	"ImplementationSpecific"
ingress.tls	list	[]
nameOverride	string	""	Provide a name in place of shlink-web
nodeSelector	object	{}	Node labels for pod assignment
podAnnotations	object	{}	Annotations to be added to pods
podLabels	object	{}	Labels to be added to pods
podSecurityContext	object	{}	pod-level security context
replicaCount	int	1	Number of replicas
resources	object	{}	Resource limits and requests for the headwind pods.
revisionHistoryLimit	int	10	The number of old ReplicaSets to retain
securityContext	object	{}	container-level security context
service.port	int	80	Kubernetes port where service is exposed
service.type	string	"ClusterIP"	Kubernetes service type
serviceAccount.annotations	object	{}	Annotations to add to the service account
serviceAccount.create	bool	true	Specifies whether a service account should be created
serviceAccount.name	string	""	The name of the service account to use. If not set and create is true, a name is generated using the fullname template
tolerations	list	[]	Toleration labels for pod assignment

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

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

helm install my-release -f values.yaml christianhuth/shlink-web

Upgrading the Chart

To 1.0.0

This major updates the Docker Image of the Shlink Web Client to its newest major, 4.0.0. Here you can find more information about the changes introduced in that version.