charts/charts/stable/overleaf

overleaf

A web-based collaborative LaTeX editor

This chart is not maintained by the upstream project and any issues with the chart should be raised here

Source Code

• https://github.com/overleaf/overleaf

Requirements

Kubernetes: >=1.16.0-0

Dependencies

Repository	Name	Version
https://charts.bitnami.com/bitnami	mongodb	10.31.5
https://charts.bitnami.com/bitnami	redis	15.7.6
https://library-charts.k8s-at-home.com	common	4.4.0

TL;DR

helm repo add k8s-at-home https://k8s-at-home.com/charts/
helm repo update
helm install overleaf k8s-at-home/overleaf

Installing the Chart

To install the chart with the release name overleaf

helm install overleaf k8s-at-home/overleaf

Uninstalling the Chart

To uninstall the overleaf deployment

helm uninstall overleaf

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

Configuration

Read through the values.yaml file. It has several commented out suggested values. Other values may be used from the values.yaml from the common library.

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

helm install overleaf \
  --set env.TZ="America/New York" \
    k8s-at-home/overleaf

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

helm install overleaf k8s-at-home/overleaf -f values.yaml

Custom configuration

N/A

Values

Important: When deploying an application Helm chart you can add more values from our common library chart here

Key	Type	Default	Description
env	object	See below	environment variables. See more environment variables in the overleaf documentation.
env.REDIS_HOST	string	nil	The host name of the Redis instance to use. (Both SHARELATEX_REDIS_HOST and REDIS_HOST are required)
env.SHARELATEX_MONGO_URL	string	nil	The URL of the Mongo database to use.
env.SHARELATEX_REDIS_HOST	string	nil	The host name of the Redis instance to use. (Both SHARELATEX_REDIS_HOST and REDIS_HOST are required)
env.TZ	string	"UTC"	Set the container timezone
image.pullPolicy	string	"IfNotPresent"	image pull policy
image.repository	string	"sharelatex/sharelatex"	image repository
image.tag	string	"2.7.1"	image tag
ingress.main	object	See values.yaml	Enable and configure ingress settings for the chart under this key.
mongodb	object	See values.yaml	Enable and configure mongodb database subchart under this key. For more options see mongodb chart documentation
persistence	object	See values.yaml	Configure persistence settings for the chart under this key.
redis	object	See values.yaml	Enable and configure redis subchart under this key. For more options see redis chart documentation
service	object	See values.yaml	Configures service settings for the chart.

Changelog

Version 2.5.0

Added

N/A

Changed

• Upgraded common chart dependency to version 4.4.0

Fixed

N/A

Older versions

A historical overview of changes can be found on ArtifactHUB

Support

• See the Docs
• Open an issue
• Ask a question
• Join our Discord community

---

Autogenerated from chart metadata using helm-docs v0.1.1