This documentation site is about the unstable (upcoming) Comentario version.
Switch to the stable version »
Parameters
Comentario Helm chart parameter description
Comentario Helm chart provides the following configuration parameters.
The values are validated against the schema in values.schema.json, which ships with the chart: Helm rejects an unknown parameter name, a wrong value type, or a value the server would refuse to start with, before anything is installed. The comentario.* parameters end up in the server’s static configuration file verbatim, with the exception of baseUrl, host, port, secrets, and staticPath, which the chart manages itself and which therefore cannot be overridden.
| Name | Description | Default value |
|---|---|---|
replicaCount | Number of desired pods. NB: Comentario doesn’t support upscaling to more than 1 pod at the moment | 1 |
image.repository | Docker image registry to download Comentario image from | registry.gitlab.com/comentario/comentario |
image.pullPolicy | Image pull policy | Always |
image.tag | Image tag to use: a specific release tag, latest for latest released version, or edge for latest development build | latest |
imagePullSecrets | Docker image registry secrets as an array of {name: <secret name>} objects | [] |
nameOverride | Override for the instance name | |
fullnameOverride | Override for full name, which is used to create Kubernetes objects | |
serviceAccount.create | Whether a service account should be created | true |
serviceAccount.annotations | Annotations to add to the service account as an object | {} |
serviceAccount.name | Name of the service account to use. If not set and create is true, a name will be generated | |
configMap.annotations | Annotations to add to the config map as an object | {} |
configMap.name | Name of the config map to use. If not set, a name will be generated | |
secret.name | Name of the Secret object containing Comentario secrets | comentario-secrets |
podAnnotations | Additional pod annotation as an object | {} |
podSecurityContext | Pod security context configuration | {} |
securityContext | Security context configuration | {} |
service.type | Type of the service object | ClusterIP |
service.port | Service port | 80 |
ingress.enabled | Whether to create ingress objects | true |
ingress.host | Host to install an ingress rule for | comentario.example.com |
clusterIssuer | Name of ClusterIssuer to use | letsencrypt-staging |
comentario.args | Command-line arguments to the comentario command, e.g. ["-vv"] | |
comentario.cleanupTimeout | Grace period before killing an idle connection | 10s |
comentario.gracefulTimeout | Grace period before shutting down server | 15s |
comentario.maxHeaderSize | Max. request header size, in bytes | 1000000 |
comentario.keepAlive | TCP keepalive timeout on accepted connections | 3m |
comentario.readTimeout | Max. duration before request read times out | 30s |
comentario.writeTimeout | Max. duration before response write times out | 60s |
comentario.baseDocsUrl | Base documentation URL | https://docs.comentario.app/ |
comentario.tosUrl | URL of the Terms of Service page | <baseDocsUrl>/en/legal/tos/ |
comentario.privacyPolicyUrl | URL of the Privacy Policy page | <baseDocsUrl>/en/legal/privacy/ |
comentario.homeContentUrl | URL of a HTML page to display on homepage | https://docs.comentario.app/en/embed/front-page/ |
comentario.maxImportFileSize | Max. import file size, in bytes | 10000000 |
comentario.superuser | UUID or email of a user to become a superuser | |
comentario.log.level | Log verbosity level | debug |
comentario.log.noColor | Disable log colouring | false |
comentario.log.fullIPs | Log IP addresses in full | false |
comentario.db.maxIdleConns | Max. number of idle connections | 10 |
comentario.stats.disablePageViews | Disable page view statistics gathering and reporting | false |
comentario.stats.maxDays | Statistics retention and reporting period, in days | 30 |
comentario.liveUpdate.disable | Disable Live update | false |
comentario.liveUpdate.maxClients | Maximum number of Live update clients | 10000 |
comentario.webhooks.disable | Disable outbound Webhooks entirely | false |
comentario.webhooks.workers | Number of concurrently attempted webhook deliveries | 4 |
comentario.webhooks.timeout | Timeout of a single webhook delivery attempt | 10s |
comentario.webhooks.maxAttempts | Max. number of delivery attempts, the first one included | 5 |
comentario.webhooks.pollInterval | Interval of polling the database for due webhook deliveries | 15s |
comentario.webhooks.maxPerDomain | Max. number of webhooks that can be registered on a domain | 10 |
comentario.webhooks.maxPerMinute | Max. number of deliveries per domain per minute, per instance; 0 switches the limit off | 120 |
comentario.webhooks.maxFailStreak | Number of consecutive failures that disables a webhook; 0 switches the rule off | 20 |
comentario.webhooks.maxFailDays | Number of days of unbroken failure that disables a webhook; 0 switches the rule off | 7 |
comentario.webhooks.logRetentionDays | Number of days a finished webhook delivery is kept for | 30 |
comentario.webhooks.allowInsecure | Allow insecure (plain http) webhook target URLs | false |
comentario.webhooks.allowPrivateTargets | Allow webhook target URLs resolving to private/loopback addresses | false |
resources.limits | Pod resources limit configuration | {cpu: 500m, memory: 200Mi} |
resources.requests | Pod resources request configuration | |
autoscaling.enabled | Whether horizontal autoscaling is enabled. NB: Comentario doesn’t support upscaling to more than 1 pod at the moment | false |
nodeSelector | Node selector configuration | {} |
tolerations | Pod tolerations configuration as an array | [] |
affinity | Pod scheduling constraints configuration | {} |
