Back to Leantime

Introduction

helm/README.md

3.7.36.1 KB
Original Source
<div align="center">

Leantime is a lean open source project management system for startups and innovators. It's an alternative to ClickUp, Notion, and Asana. https://leantime.io

</div>

Introduction

This Helm Chart bootstraps a production-ready instance of Leantime in a Kubernetes cluster. To know more about Leantime and/or contribute to the development of the software, please refer to the root project Leantime on GitHub.

Prerequisites

  1. Helm > v2 installed: helm version
  2. Kubernetes > 1.16.x
  3. Leantime Helm chart repository: git clone https://github.com/Leantime/leantime

Deploying Leantime

To deploy Leantime clone this repository:

bash
git clone https://github.com/Leantime/leantime

Prepare chart dependencies:

bash
helm dependency build ./leantime/helm

Create a values.yaml file to override the default configurations. For convenience you can copy the default file in the leantime/helm directory into your current directory and modify it according to your needs (see configuring section). Then, deploy the application:

bash
helm install leantime -f values.yaml ./leantime/helm

Configuring

KeyTypeDefaultDescription
app.defaultTimezonestring"America/Los_Angeles"Sets the default Timezone
app.email.enabledboolfalseSet to true if you want to use SMTP. If set to false, the default php mail() function will be used
app.email.returnstring"[email protected]"Sets the email address to use for notifications and registrations
app.email.smtp.autoTLSbooltrueSet autoTLS?
app.email.smtp.hostsstring""SMTP host
app.email.smtp.passwordstring""SMTP password
app.email.smtp.portint587SMTP port
app.email.smtp.securestring"STARTLS"Sets the SMTP security protocol (usually one of: TLS, SSL, STARTTLS)
app.email.smtp.usernamestring""SMTP username
app.languagestring"en-US"Sets application language
app.ldap.DNstring""Location of users, example: CN=users,DC=example,DC=com
app.ldap.baseDNstring""Base DN, example: DC=example,DC=com
app.ldap.defaultRoleKeystring""Sets the default role for users when they are first created
app.ldap.enabledboolfalseSet to true if you want to use LDAP
app.ldap.groupAssignmentstring""Default role assignments upon first login
app.ldap.hoststring""FQDN
app.ldap.keysstring""Default ldap keys in your directory
app.ldap.portint389Sets LDAP port
app.ldap.typestring""Select the correct directory type. Currently Supported: OL - OpenLdap, AD - Active Directory
app.ldap.userDomainstring""Domain after ldap, example @example.com
app.s3.bucketstring""S3 bucket
app.s3.enabledboolfalseSet to true if you want to use S3 instead of local files
app.s3.enpointstring""S3 endpoint
app.s3.folderNamestring""Sets the foldername within S3 (can be empty)
app.s3.keystring""S3 key
app.s3.regionstring""S3 region
app.s3.secretstring""S3 secret
app.s3.usePathStyleEndpointstring"false"Sets wether or not use path-style endpoint
app.session.expirationint28800Session expiration
app.session.passwordstring"changeme"Salting sessions. Replace with a strong password
app.sitenamestring"Leantime"Sets the name for the instance
autoscaling.enabledboolfalse
autoscaling.maxReplicasint100
autoscaling.minReplicasint1
autoscaling.targetCPUUtilizationPercentageint80
fullnameOverridestring""Ovverrides the fullname of the kubernetes object names for this release
image.pullPolicystring"IfNotPresent"The pull policy of the Leantime OCI image applied to the deployment
image.repositorystring"leantime/leantime"OCI image repository of the Leantime application
image.tagstring"latest"Overrides the image tag whose default is the chart appVersion
imagePullSecretslist[]The pull secrets to be used if you want to use a Leantime application image hosted in a private registry
ingress.annotationsobject{}
ingress.classNamestring""
ingress.enabledboolfalse
ingress.hosts[0].hoststring"chart-example.local"
ingress.hosts[0].paths[0].pathstring"/"
ingress.hosts[0].paths[0].pathTypestring"ImplementationSpecific"
ingress.tlslist[]
mariadb.auth.databasestring"leantime"Database name
mariadb.auth.passwordstring"changeme"Database password
mariadb.auth.rootPasswordstring"changeme"Database root password
mariadb.auth.usernamestring"leantime"Database username
mariadb.enabledbooltrue
nameOverridestring""Overrides the name of the chart
nodeSelectorobject{}
persistence.enabledbooltrueEnables or disables the persistence
persistence.sizestring"5Gi"Sets the size of the PVs for Leantime's public and private userfiles
persistence.storageClassstring"standard"Sets the storage class for Leantime's volumes
podAnnotationsobject{}
podSecurityContextobject{}
replicaCountint1
resourcesobject{}
securityContextobject{}
service.portint80
service.typestring"ClusterIP"
serviceAccount.annotationsobject{}
serviceAccount.createboolfalse
serviceAccount.namestring""
tolerationslist[]