charts

Kutt

Kutt is a modern URL shortener with support for custom domains. Shorten URLs, manage your links and view the click rate statistics.

Prerequisites

[!NOTE]
You may refer to Orked for help with setting up a Kubernetes cluster that meets all the following prerequisites.

Preflight checklist

[!IMPORTANT]
The following items are required to be set up prior to installing this chart.

Generate secret key

A unique, secure secret key is required for each Kutt installation.

  1. Generate a secret key using the following command:

     python -c 'import random; print("".join([random.choice("abcdefghijklmnopqrstuvwxyz0123456789!@#$%^&*(-_=+)") for i in range(50)]))'

  2. Set the generated secret key as the value of the kutt.secret setting in your installation’s values file:

     secret: "<generated-secret>"

[!NOTE]
The following configuration recommendations might not be the default settings for this chart but are highly recommended. Please carefully consider them before configuring your installation.

This section does not apply to this chart.

Application configurations

[!NOTE]
The following configurations are expected or recommended to be set up from within the application after completing the installation.

This section does not apply to this chart.

How to add the chart repo

  1. Add the repo to your local helm client:

     helm repo add mika https://irfanhakim-as.github.io/charts

  2. Update the repo to retrieve the latest versions of the packages:

     helm repo update

How to install or upgrade a chart release

  1. Get the values file of the Kutt chart or an existing installation (release).

    Get the latest Kutt chart values file for a new installation:

     helm show values mika/kutt > values.yaml

    Alternatively, get the values file of an existing Kutt release:

     helm get values ${releaseName} --namespace ${namespace} > values.yaml

    Replace ${releaseName} and ${namespace} accordingly.

  2. Edit your Kutt values file with the intended configurations:

     nano values.yaml

    Pay extra attention to the descriptions and sample values provided in the chart values file.

  3. Install a new release for Kutt or upgrade an existing Kutt release:

     helm upgrade --install ${releaseName} mika/kutt --namespace ${namespace} --create-namespace --values values.yaml --wait

    Replace ${releaseName} and ${namespace} accordingly.

  4. Verify that your Kutt release has been installed:

     helm ls --namespace ${namespace} | grep "${releaseName}"

    Replace ${namespace} and ${releaseName} accordingly. This should return the release information if the release has been installed.

How to uninstall a chart release

[!CAUTION]
Uninstalling a release will irreversibly delete all the resources associated with the release, including any persistent data.

  1. Uninstall the desired release:

     helm uninstall ${releaseName} --namespace ${namespace} --wait

    Replace ${releaseName} and ${namespace} accordingly.

  2. Verify that the release has been uninstalled:

     helm ls --namespace ${namespace} | grep "${releaseName}"

    Replace ${namespace} and ${releaseName} accordingly. This should return nothing if the release has been uninstalled.

Chart configurations

Key Type Default Description
google.recaptchaSecretKey string "" The Google reCAPTCHA secret key used for preventing spam. Refer to https://developers.google.com/recaptcha/intro.
google.recaptchaSiteKey string "" The Google reCAPTCHA site key used for preventing spam. Refer to https://developers.google.com/recaptcha/intro.
google.safeBrowsingKey string "" The Google API key used for Google Safe Browsing to prevent malicious links. Refer to https://developers.google.com/safe-browsing/v4/get-started.
image.kutt.pullPolicy string "" The policy that determines when Kubernetes should pull the Kutt container image. Default: "IfNotPresent".
image.kutt.registry string "" The registry where the Kutt container image is hosted. Default: "docker.io".
image.kutt.repository string "" The name of the repository that contains the Kutt container image used. Default: "kutt/kutt".
image.kutt.tag string "" The tag that specifies the version of the Kutt container image used. Default: Chart appVersion.
image.redis.pullPolicy string "" The policy that determines when Kubernetes should pull the Redis container image. Default: "IfNotPresent".
image.redis.registry string "" The registry where the Redis container image is hosted. Default: "docker.io".
image.redis.repository string "" The name of the repository that contains the Redis container image used. Default: "redis".
image.redis.tag string "" The tag that specifies the version of the Redis container image used. Default: "6.0-alpine".
imagePullSecrets list [] Credentials used to securely authenticate and authorise the pulling of container images from private registries.
ingress.clusterIssuer string "" The name of the cluster issuer for Ingress. Default: "letsencrypt-dns-prod".
ingress.customAnnotations list [] Additional configuration annotations to be added to the Ingress resource. Items: .prefix, .name, .value.
ingress.enabled bool false Specifies whether Ingress should be enabled for hosting Kutt services.
ingress.www bool false Specifies whether the WWW subdomain should be enabled.
kutt.administration.admins list [] Email addresses of the administrators of the Kutt application so they can access admin actions.
kutt.administration.dailyUserLimit string "" The maximum number of links that can be created by a user in a day. Default: "50".
kutt.administration.disableAnonLinks string "" Specifies whether Kutt should disallow creating links without an account. Default: "false".
kutt.administration.disableRegistration string "" Specifies whether Kutt should disallow user registrations. Default: "false".
kutt.administration.maxStatsPerLink string "" The maximum number of visits for a link to have detailed statistics. Default: "5000".
kutt.administration.nonUserCooldown string "" The number of minutes an anonymous user must wait before creating another link. Default: "0".
kutt.domain string "" The ingress domain name that hosts the Kutt server. Default: "%s-kutt-svc:kutt .Release.Name".
kutt.link_length string "" The length of the generated short links. Default: "6".
kutt.name string "" The name of the site where Kutt is hosted. Default: "Kutt".
kutt.secret string "" A 50-character secret key used for encrypting JSON Web Tokens (JWTs).
kutt.useHttps string "" Specifies whether Kutt should use HTTPS for custom domains. Default: "true".
mail.contact_email string "" The email address to be displayed as the contact email in the application.
mail.from_email string "" The email address used as the “from” address for sent emails. Default: "$name <$mail.smtp.user>".
mail.report_email string "" The email address that will receive submitted reports.
mail.secure string "" Specifies whether Kutt should use a secure TLS connection when sending emails. Default: "true".
mail.smtp.host string "" The hostname or IP address of the SMTP server for sending emails. Default: "smtp.gmail.com".
mail.smtp.password string "" The password for authenticating with the SMTP server.
mail.smtp.port string "" The port number on the SMTP server used for sending emails. Default: "465".
mail.smtp.user string "" The username for authenticating with the SMTP server.
postgres.host string "" The hostname or IP address of the Kutt database server.
postgres.name string "" The name of the database being used by Kutt.
postgres.password string "" The password associated with the Kutt database user.
postgres.port string "" The port number the Kutt database server is listening for connections. Default: "5432".
postgres.ssl string "" Specifies whether the Kutt database server should use SSL. Default: "false".
postgres.user string "" The username or user account for accessing the Kutt database.
redis.external bool false Specifies whether Kutt should use an external Redis server.
redis.host string "" The hostname or IP address of the external Redis server.
redis.password string "" The password for authenticating with the external Redis server.
redis.port string "" The port number on which the external Redis server is listening for connections. Default: "6379".
replicaCount string "" The desired number of running replicas for Kutt. Default: "1".
resources.kutt object {} Kutt container resources.
resources.redis object {} Redis container resources.
service.kutt.nodePort string "" The optional node port to expose for Kutt when the service type is NodePort.
service.kutt.port string "" The Kutt port on which the Kutt server should listen for connections. Default: "3000".
service.redis.nodePort string "" The optional node port to expose for Redis when the service type is NodePort.
service.redis.port string "" The Redis port on which the Kutt server should listen for connections. Default: "6379".
service.type string "" The type of service used to expose Kutt services. Default: "ClusterIP".
storage.redis.accessMode string "" The access mode defining how the Redis storage can be mounted. Default: "ReadWriteOnce".
storage.redis.enabled bool true Specifies whether persistent storage should be provisioned for Redis storage.
storage.redis.mountPath string "" The path where the Redis storage should be mounted on the container. Default: "/data".
storage.redis.storage string "" The default amount of persistent storage allocated for the Redis storage. Default: "100Mi".
storage.redis.storageClassName string "" The storage class name used for dynamically provisioning a persistent volume for the Redis storage. Default: "longhorn".
storage.redis.subPath string "" The subpath within the Redis storage to mount to the container. Leave empty if not required.