plausible-analytics¶

A Helm Chart for Plausible Analytics - a simple and privacy-friendly alternative to Google Analytics

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

Chart was originally created and maintained by Varac here.

This chart uses v2.1.0 version of Plausible Analytics. See release notes to learn more about upgrade steps: https://github.com/plausible/analytics/releases/tag/v2.1.0

Source Code¶

Requirements¶

Dependencies¶

Repository	Name	Version
https://charts.bitnami.com/bitnami	postgresql	12.12.10
https://sentry-kubernetes.github.io/charts	clickhouse	3.10.0

TL;DR¶

helm repo add zekker6 https://zekker6.github.io/helm-charts/
helm repo update
helm install plausible-analytics zekker6/plausible-analytics

Installing the Chart¶

To install the chart with the release name plausible-analytics

helm install plausible-analytics zekker6/plausible-analytics

Uninstalling the Chart¶

To uninstall the plausible-analytics deployment

helm uninstall plausible-analytics

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 plausible-analytics \
  --set env.TZ="America/New York" \
    zekker6/plausible-analytics

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

helm install plausible-analytics zekker6/plausible-analytics -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
affinity	object	`{}`
autoscaling.enabled	bool	`false`
autoscaling.maxReplicas	int	`100`
autoscaling.minReplicas	int	`1`
autoscaling.targetCPUUtilizationPercentage	int	`80`
baseURL	string	`"http://example.com"`	The hosting url of the server, used for URL generation. In production systems, this should be your ingress host.
clickhouse	object	`{"clickhouse":{"image":"clickhouse/clickhouse-server","imageVersion":"24.3.3.102-alpine","replicas":1},"enabled":true}`	Clickhouse Database
clickhouse.clickhouse	object	`{"image":"clickhouse/clickhouse-server","imageVersion":"24.3.3.102-alpine","replicas":1}`	Sub-chart values, see https://artifacthub.io/packages/helm/sentry/clickhouse
clickhouse.clickhouse.image	string	`"clickhouse/clickhouse-server"`	Latest sentry/clickhouse chart ships 19.14, which doesn't work together with latest plausible https://artifacthub.io/packages/helm/sentry/clickhouse https://hub.docker.com/r/clickhouse/clickhouse-server/tags
disableAuth	bool	`false`	Disables authentication completely, no registration, login will be shown.
disableRegistration	bool	`false`	Disables registration of new users, keep your admin credentials handy ;)
externalSecret	object	`{"name":""}`	Configure an external secret to use for plausible
externalSecret.name	string	`""`	Name of the external secret to use
extraEnv	list	`[]`	Extra Env Variables that are passed down to plausible 1:1
fullnameOverride	string	`""`
geolocation.account_id	string	`nil`	Account/User ID from maxmind.com
geolocation.enabled	bool	`false`	Enable/Disable the automated fetch of
geolocation.license_key	string	`nil`	My License Key from maxmind.com
google	object	`{"clientID":null,"clientSecret":null}`	Google Search Integration See: https://docs.plausible.io/self-hosting-configuration#google-search-integration
google.clientID	string	`nil`	The Client ID from the Google API Console for your Plausible Analytics project
google.clientSecret	string	`nil`	The Client Secret from the Google API Console for your Plausible Analytics project
image.pullPolicy	string	`"IfNotPresent"`
image.repository	string	`"ghcr.io/plausible/community-edition"`
image.tag	string	`"v2.1.1"`	Overrides the image tag whose default is the chart appVersion. See https://hub.docker.com/r/plausible/analytics for tags
imagePullSecrets	list	`[]`
ingress.annotations	object	`{}`
ingress.enabled	bool	`false`
ingress.hosts[0].host	string	`"chart-example.local"`
ingress.hosts[0].paths	list	`[]`
ingress.tls	list	`[]`
labels	object	`{}`	Extra Labels to apply on your k8s deployment
nameOverride	string	`""`
nodeSelector	object	`{}`
podAnnotations	object	`{}`
podSecurityContext	object	`{}`
postgresql	object	`{"auth":{"database":"plausible","postgresPassword":"b8f1ad468e00b344b2c6bf495c4ffc28"},"enabled":true}`	Postgres Database
postgresql.auth	object	`{"database":"plausible","postgresPassword":"b8f1ad468e00b344b2c6bf495c4ffc28"}`	Sub-chart values, see https://artifacthub.io/packages/helm/bitnami/postgresql The URL to the Postgres Database Connection String see -> https://www.postgresql.org/docs/current/libpq-connect.html#LIBPQ-CONNSTRING
postmark	object	`{"apiKey":null}`	Alternatively, you can use Postmark to send transactional emails
replicaCount	int	`1`
resources	object	`{}`
secretKey	string	`""`	Secret key to be used for encryption. IF no value is provided random string will be generated during release.
securityContext	object	`{}`
service.port	int	`80`
service.type	string	`"ClusterIP"`
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
smtp	object	`{"enabled":false,"host":null,"mailer":{"adapter":null,"emailAddress":null},"password":null,"port":null,"retries":2,"ssl":{"enabled":false},"username":null}`	Plausible uses and SMTP server to send transactional emails e.g. account activation, password reset, weekly reports, etc.
smtp.enabled	bool	`false`	Enable/Disable SMTP functionality
smtp.host	string	`nil`	The host address of your smtp server.
smtp.mailer.emailAddress	string	`nil`	The email address of the email sender
smtp.password	string	`nil`	The password in case SMTP auth is enabled.
smtp.port	string	`nil`	The port of your smtp server.
smtp.ssl.enabled	bool	`false`	If SSL is enabled for SMTP connection
smtp.username	string	`nil`	The username/email in case SMTP auth is enabled.
tolerations	list	`[]`
totpVaultKey	string	`""`	Secret TOTP Vault key to be used for encryption. IF no value is provided random string will be generated during release. Generate with: openssl rand -base64 32
twitter	object	`{"access":{"secret":null,"token":null},"consumer":{"key":null,"secret":null}}`	Twitter Integration https://docs.plausible.io/self-hosting-configuration#twitter-integration
twitter.access.secret	string	`nil`	The access token secret you generated in the steps above
twitter.access.token	string	`nil`	The access token you generated in the steps above
twitter.consumer.key	string	`nil`	The API key from the Twitter Developer Portal
twitter.consumer.secret	string	`nil`	The API key secret from the Twitter Developer Portal

Older versions¶

A historical overview of changes can be found on ArtifactHUB

Support¶

See the Docs
Open an issue

Autogenerated from chart metadata using helm-docs v1.11.0