diff --git a/chart/README.org b/chart/README.org index 7dda07c..cb389a1 100644 --- a/chart/README.org +++ b/chart/README.org @@ -1,5 +1,70 @@ #+TITLE: Helm chart +* Configuration + +| Parameter | Description | Default | +|-----------------------------------------------+-----------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------| +| disableAuth | Disables authentication completely, no registration, login will be shown | ~false~ | +| disableRegistration | Disables registration of new users, keep your admin credentials handy | ~false~ | +| baseURL | The hosting url of the server, used for URL generation. In production systems, this should be your ingress host | ~""~ | +| adminUser.email | The default ("admin") user email | ~""~ | +| adminUser.name | Admin user's name | ~""~ | +| adminUser.password | The default ("admin") user password | ~""~ | +| database.enabled | Set database URL in env | ~true~ | +| database.url | The database URL as dictated [[https://hexdocs.pm/ecto/Ecto.Repo.html#module-urls][here]] | ~postgres://postgres:postgres@postgres/plausible?ssl=off~ | +| clickhouse.enabled | Set clickhouse URL in env | ~true~ | +| clickhouse.url | Connection string for Clickhouse in the same format | ~http://plausible-events-db:8123/plausible~ | +| smtp.enabled | Set SMTP configuration in env | ~true~ | +| smtp.mailer.emailAddress | The email id to use for as from address of all communications from Plausible | ~""~ | +| smtp.mailer.adapter | Instead of the default, replace this with Bamboo.PostmarkAdapter | ~""~ | +| smtp.host | The host address of your smtp server | ~""~ | +| smtp.port | The port of your smtp server | ~""~ | +| smtp.username | The username/email in case SMTP auth is enabled | ~""~ | +| smtp.password | The password in case SMTP auth is enabled | ~""~ | +| smtp.ssl.enabled | If SSL is enabled for SMTP connection | ~false~ | +| smtp.retries | Number of retries to make until mailer gives up | ~2~ | +| postmark.apiKey | Enter your API key | ~""~ | +| geoliteCountryDB | Path to your IP geolocation database in MaxMind's format | ~""~ | +| google.clientID | The Client ID from the Google API Console for your Plausible Analytics project | ~""~ | +| google.clientSecret | The Client Secret from the Google API Console for your Plausible Analytics project | ~""~ | +| twitter.consumer.key | The API key from the Twitter Developer Portal | ~""~ | +| twitter.consumer.secret | The API key secret from the Twitter Developer Portal | ~""~ | +| twitter.access.token | The access token you generated in the steps above | ~""~ | +| twitter.access.secret | The access token secret you generated in the steps above | ~""~ | +| labels | Extra labels to add to all managed resources | ~{}~ | +| extraEnv | Declare extra environment variables | ~[]~ | +| image.repository | The repo where the image lives | ~plausible/analytics~ | +| image.tag | Specifies a tag of from the image to use | ~""~ | +| image.pullPolicy | Pod container pull policy | ~IfNotPresent~ | +| imagePullSecrets | References for the registry secrets to pull the container images in the Pod with | ~[]~ | +| nameOverride | Expand the name of the chart | ~""~ | +| fullNameOverride | Create a FQDN for the app name | ~""~ | +| serviceAccount.create | Whether a serviceAccount should be created for the Pod to use | ~false~ | +| serviceAccount.name | A name to give the servce account | ~nil~ | +| podAnnotations | Annotations to assign Pods | ~{}~ | +| podSecurityContext | Set a security context for the Pod | ~{}~ | +| securityContext.readOnlyRootFilesystem | Mount container filesytem as read only | ~true~ | +| securityContext.runAsNonRoot | Don't allow the container in the Pod to run as root | ~true~ | +| securityContext.runAsUser | The user ID to run the container in the Pod as | ~1000~ | +| securityContext.runAsGroup | The group ID to run the container in the Pod as | ~1000~ | +| service.type | The service type to create | ~ClusterIP~ | +| service.port | The port to bind the app on and for the service to be set to | ~8000~ | +| ingress.enabled | Create an ingress manifests | ~false~ | +| ingress.realIPHeader | A header to forward, which contains the real client IP address | ~""~ | +| ingress.annotations | Set annotations for the ingress manifest | ~{}~ | +| ingress.hosts | The hosts which the ingress endpoint should be accessed from | | +| ingress.tls | References to TLS secrets | ~[]~ | +| resources | Limits and requests for the Pods | ~{}~ | +| autoscaling.enabled | Enable autoscaling for the deployment | ~false~ | +| autoscaling.minReplicas | The minimum amount of Pods to run | ~1~ | +| autoscaling.maxReplicas | The maximum amount of Pods to run | ~1~ | +| autoscaling.targetCPUUtilizationPercentage | The individual Pod CPU amount until autoscaling occurs | ~80~ | +| autoscaling.targetMemoryUtilizationPercentage | The individual Pod Memory amount until autoscaling occurs | | +| nodeSelector | Declare the node labels for Pod scheduling | ~{}~ | +| tolerations | Declare the toleration labels for Pod scheduling | ~[]~ | +| affinity | Declare the affinity settings for the Pod scheduling | ~{}~ | + + * Installation #+begin_src shell :pwd ./ :results silent diff --git a/chart/plausible-analytics/values.yaml b/chart/plausible-analytics/values.yaml index 328017f..d258699 100644 --- a/chart/plausible-analytics/values.yaml +++ b/chart/plausible-analytics/values.yaml @@ -4,52 +4,52 @@ disableAuth: false disableRegistration: false -baseURL: +baseURL: "" adminUser: - email: - name: - password: + email: "" + name: "" + password: "" # SECRET_KEY_BASE is Helm randAlphaNum 90 database: enabled: true - url: + url: "postgres://postgres:postgres@postgres/plausible?ssl=off" clickhouse: enabled: true - url: + url: "http://plausible-events-db:8123/plausible" smtp: enabled: true mailer: - emailAddress: - adapter: - host: - port: - username: - password: + emailAddress: "" + adapter: "" + host: "" + port: "" + username: "" + password: "" ssl: enabled: false retries: 2 postmark: - apiKey: + apiKey: "" -geoliteCountryDB: +geoliteCountryDB: "" google: - clientID: - clientSecret: + clientID: "" + clientSecret: "" twitter: consumer: - key: - secret: + key: "" + secret: "" access: - token: - secret: + token: "" + secret: "" labels: {} extraEnv: []