Skip to content
Poznote icon
v2.1.0App: v6.121.0Pinned DigestS3 Backup Ready

Production Helm chart • Apache-2.0 • Zero-Root • Verified on Kubernetes v1.33-v1.36+

Poznote

Self-hosted note-taking and documentation platform with SQLite persistence.

Installation

Using HTTPS Repository

helm repo add helmforge https://repo.helmforge.dev
helm install my-release helmforge/poznote

Using OCI Repository

helm install my-release oci://ghcr.io/helmforgedev/helm/poznote --version 1.0.0

Quick Start

Minimal Configuration

# Deploy with defaults -- PVC enabled, Nginx listener and Service on port 80
persistence:
  data:
    enabled: true

With Ingress

ingress:
  enabled: true
  ingressClassName: nginx
  hosts:
    - host: notes.example.com
  tls:
    - secretName: notes-tls
      hosts:
        - notes.example.com

Features

  • Official upstream image pinned to stable release
  • Configurable Nginx listener independent from the client-facing Service port
  • SQLite persistence via single PVC
  • Ingress and Gateway API exposure
  • OIDC/SSO authentication support
  • External Secrets Operator integration
  • NetworkPolicy for traffic isolation
  • PodDisruptionBudget for voluntary disruption safety
  • Dual-stack Service support
  • Pod Security Standards baseline compliance

Configuration

Parameters

Global Parameters

Official Schema

Values & Configuration Reference

All schema parameters, types, defaults, and allowed values are extracted directly from the chart repository. Filter and search them in the interactive reference below or customize in Values Studio.

View Values Schema

Image Parameters

Official Schema

Values & Configuration Reference

All schema parameters, types, defaults, and allowed values are extracted directly from the chart repository. Filter and search them in the interactive reference below or customize in Values Studio.

View Values Schema

Application Parameters

Official Schema

Values & Configuration Reference

All schema parameters, types, defaults, and allowed values are extracted directly from the chart repository. Filter and search them in the interactive reference below or customize in Values Studio.

View Values Schema

Persistence Parameters

Official Schema

Values & Configuration Reference

All schema parameters, types, defaults, and allowed values are extracted directly from the chart repository. Filter and search them in the interactive reference below or customize in Values Studio.

View Values Schema

Exposure Parameters

Official Schema

Values & Configuration Reference

All schema parameters, types, defaults, and allowed values are extracted directly from the chart repository. Filter and search them in the interactive reference below or customize in Values Studio.

View Values Schema

Security Parameters

Official Schema

Values & Configuration Reference

All schema parameters, types, defaults, and allowed values are extracted directly from the chart repository. Filter and search them in the interactive reference below or customize in Values Studio.

View Values Schema

Examples

Architecture Guides

Connecting to Poznote

kubectl port-forward svc/my-release-poznote 8080:80
# Open http://127.0.0.1:8080
# Default login: admin_change_me / admin

The Service targets the named http port. To run Nginx on a non-default container port while keeping a different Service port:

containerPorts:
  http: 8080
service:
  port: 80

The chart passes containerPorts.http to the official image as POZNOTE_LISTEN_PORT; changing service.port alone does not move Nginx.

Non-Goals

This chart intentionally does NOT:

  • Support multi-replica scaling (SQLite limitation)
  • Provide a database subchart (SQLite is embedded)
  • Bundle the MCP server container (separate deployment concern)

Upgrade Notes

Upgrading to 6.121.0

Poznote 6.121.0 includes bug fixes, stability, and performance improvements. No breaking configuration or values changes are introduced in this release.

Review the official 6.121.0 release.

Upgrading to 6.115.0

The upgrade range from Poznote 6.100.0 through 6.115.0 adds scheduled local backup archives, revisions, richer Markdown editing and repeating tasks. The 6.115.0 release adds dash lists and an optional login-screen bypass. Only enable "Open without login" when network access is restricted to the account owner or a trusted reverse proxy provides authentication; the API continues to require credentials. This upgrade range also includes upstream security hardening and Alpine package updates. Since 6.80.0, upstream fixes stored XSS and backup streaming with custom themes, adds app passwords, and changes REST errors from HTTP 200 to actual error status codes. Integrations must handle HTTP 404 for inaccessible or missing IDs and 409/423 for conflicting writes. The PHP worker default increases from 5 to 10; set POZNOTE_PHP_FPM_MAX_CHILDREN through app.env when sizing a smaller pod. POZNOTE_PHP_MEMORY_LIMIT is also configurable through app.env (upstream default: 512 MB). Dictation requires an operator-configured speech service; this chart does not deploy one. Complete backups and restores now continue in detached workers, with progress polled by the browser. Keep the pod running until the job completes and verify its final status before downloading or relying on the backup.

Review the official 6.115.0 release.

Back up the complete data PVC before upgrading and verify a restore in a separate instance. It contains SQLite, notes, attachments and application configuration. Existing S3 integrations remain application configuration; confirm attachment access when exporting or restoring an account.

Shared links default to read-only. API integrations should retain the returned note version and use if_version or If-Match to detect concurrent edits. MCP user selection and optional POZNOTE_MCP_AUTH_TOKEN apply to the separate MCP server; the chart does not deploy or expose it. Review the upstream releases before upgrading integrations.

Troubleshooting

  • Pod not ready: inspect kubectl logs deploy/<release>-poznote and verify the data PVC is writable by GID 82.
  • Service has no response: verify containerPorts.http matches POZNOTE_LISTEN_PORT in the rendered Deployment and that the Service targets the named http port.
  • OIDC login fails: verify the Secret keys, redirect URI, issuer, and provider reachability before enabling SSO-only mode.
  • Integrations time out with NetworkPolicy enabled: add only the required OIDC, S3, SMTP, AI, transcription, Git, or webhook destinations to the egress rules.
  • Data is missing after restart: confirm persistence.data.enabled=true and that the expected PVC is mounted at /var/www/html/data.

See the production guide for backup and restore boundaries.

Security Scan

Security Scan: poznote

Framework Score
MITRE + NSA + SOC2 87.88%

Security posture acceptable.

Contributing

See CONTRIBUTING.md

System Architecture

DESIGN.md Synced

Verified architecture contract rendered dynamically from GitHub DESIGN.md

flowchart LR
  Client[HTTP client] --> Edge[Ingress or Gateway API]
  Edge --> Service[Kubernetes Service]
  Service --> Pod[Poznote pod]
  Pod --> Nginx[Nginx and PHP-FPM]
  Nginx --> Data[(Data PVC)]
  Secret[Kubernetes Secret] --> Pod
  ESO[External Secrets Operator] -. optional .-> Secret
  Pod -. optional integrations .-> External[OIDC, S3, SMTP, AI, and webhooks]
Official Contractvalues.schema.json

Poznote Values Schema Reference

Official schema parameters, default values, and types extracted directly from the chart repository.

97 parametersValues Studio

Global(1)

ParameterTypeDefaultDescription
globalobject-Global settings shared by the chart.

Name Override(1)

ParameterTypeDefaultDescription
nameOverridestring-Chart configuration parameter

Fullname Override(1)

ParameterTypeDefaultDescription
fullnameOverridestring-Chart configuration parameter

Common Labels(1)

ParameterTypeDefaultDescription
commonLabelsobject-Chart configuration parameter

Image(3)

ParameterTypeDefaultDescription
image.repositorystring-Chart configuration parameter
image.tagstring-Chart configuration parameter
image.pullPolicystring-Chart configuration parameter
Allowed:AlwaysIfNotPresentNever

Image Pull Secrets(1)

ParameterTypeDefaultDescription
imagePullSecretsarray-Chart configuration parameter

Replica Count(1)

ParameterTypeDefaultDescription
replicaCountinteger-Chart configuration parameter

Container Ports(1)

ParameterTypeDefaultDescription
containerPorts.httpinteger-Chart configuration parameter

App(6)

ParameterTypeDefaultDescription
app.timezonestring-Chart configuration parameter
app.debugboolean-Chart configuration parameter
app.commandarray-Chart configuration parameter
app.argsarray-Chart configuration parameter
app.envarray-Chart configuration parameter
app.envFromarray-Chart configuration parameter

Secrets(5)

ParameterTypeDefaultDescription
secrets.existingSecretstring-Chart configuration parameter
secrets.oidcClientIdKeystring-Chart configuration parameter
secrets.oidcClientIdstring-Chart configuration parameter
secrets.oidcClientSecretKeystring-Chart configuration parameter
secrets.oidcClientSecretstring-Chart configuration parameter

Poznote(2)

ParameterTypeDefaultDescription
poznote.oidc.disableNormalLoginboolean-Chart configuration parameter
poznote.sharing.hideRestrictUsersboolean-Chart configuration parameter

Persistence(5)

ParameterTypeDefaultDescription
persistence.data.enabledboolean-Chart configuration parameter
persistence.data.sizestring-Chart configuration parameter
persistence.data.storageClassstring-Chart configuration parameter
persistence.data.accessModesarray-Chart configuration parameter
persistence.data.existingClaimstring-Chart configuration parameter

Service Account(4)

ParameterTypeDefaultDescription
serviceAccount.createboolean-Chart configuration parameter
serviceAccount.namestring-Chart configuration parameter
serviceAccount.annotationsobject-Chart configuration parameter
serviceAccount.automountServiceAccountTokenboolean-Chart configuration parameter

Service & Networking(5)

ParameterTypeDefaultDescription
service.typestring-Chart configuration parameter
Allowed:ClusterIPNodePortLoadBalancer
service.portinteger-Chart configuration parameter
service.annotationsobject-Chart configuration parameter
service.ipFamilyPolicystring-Chart configuration parameter
Allowed:SingleStackPreferDualStackRequireDualStack
service.ipFamiliesarray-Chart configuration parameter

Ingress(5)

ParameterTypeDefaultDescription
ingress.enabledboolean-Chart configuration parameter
ingress.ingressClassNamestring-Chart configuration parameter
ingress.annotationsobject-Chart configuration parameter
ingress.hostsarray-Chart configuration parameter
ingress.tlsarray-Chart configuration parameter

Gateway API(2)

ParameterTypeDefaultDescription
gatewayAPI.enabledboolean-Chart configuration parameter
gatewayAPI.httpRoutesarray-Chart configuration parameter

External Secrets(4)

ParameterTypeDefaultDescription
externalSecrets.enabledboolean-Chart configuration parameter
externalSecrets.apiVersionstring-Chart configuration parameter
externalSecrets.refreshIntervalstring-Chart configuration parameter
externalSecrets.itemsarray-Chart configuration parameter

Health Probes(15)

ParameterTypeDefaultDescription
probes.startup.enabledboolean-Chart configuration parameter
probes.startup.initialDelaySecondsinteger-Chart configuration parameter
probes.startup.periodSecondsinteger-Chart configuration parameter
probes.startup.timeoutSecondsinteger-Chart configuration parameter
probes.startup.failureThresholdinteger-Chart configuration parameter
probes.liveness.enabledboolean-Chart configuration parameter
probes.liveness.initialDelaySecondsinteger-Chart configuration parameter
probes.liveness.periodSecondsinteger-Chart configuration parameter
probes.liveness.timeoutSecondsinteger-Chart configuration parameter
probes.liveness.failureThresholdinteger-Chart configuration parameter
probes.readiness.enabledboolean-Chart configuration parameter
probes.readiness.initialDelaySecondsinteger-Chart configuration parameter
probes.readiness.periodSecondsinteger-Chart configuration parameter
probes.readiness.timeoutSecondsinteger-Chart configuration parameter
probes.readiness.failureThresholdinteger-Chart configuration parameter

Resources(4)

ParameterTypeDefaultDescription
resources.requests.cpustringnumber-Chart configuration parameter
resources.requests.memorystringnumber-Chart configuration parameter
resources.limits.cpustringnumber-Chart configuration parameter
resources.limits.memorystringnumber-Chart configuration parameter

Pod Security(4)

ParameterTypeDefaultDescription
podSecurityContext.fsGroupinteger-Chart configuration parameter
podSecurityContext.fsGroupChangePolicystring-Chart configuration parameter
Allowed:AlwaysOnRootMismatch
podSecurityContext.seccompProfile.typestring-Chart configuration parameter
Allowed:RuntimeDefaultUnconfinedLocalhost
podSecurityContext.seccompProfile.localhostProfilestring-Chart configuration parameter

Container Security(7)

ParameterTypeDefaultDescription
securityContext.allowPrivilegeEscalationboolean-Chart configuration parameter
securityContext.capabilities.droparray-Chart configuration parameter
securityContext.capabilities.addarray-Chart configuration parameter
securityContext.readOnlyRootFilesystemboolean-Chart configuration parameter
securityContext.runAsNonRootboolean-Chart configuration parameter
securityContext.seccompProfile.typestring-Chart configuration parameter
Allowed:RuntimeDefaultUnconfinedLocalhost
securityContext.seccompProfile.localhostProfilestring-Chart configuration parameter

Pdb(2)

ParameterTypeDefaultDescription
pdb.enabledboolean-Chart configuration parameter
pdb.minAvailableinteger-Chart configuration parameter

Network Policy(6)

ParameterTypeDefaultDescription
networkPolicy.enabledboolean-Chart configuration parameter
networkPolicy.ingressFromarray-Chart configuration parameter
networkPolicy.egress.enabledboolean-Chart configuration parameter
networkPolicy.egress.allowDNSboolean-Chart configuration parameter
networkPolicy.egress.extraToarray-Chart configuration parameter
networkPolicy.egress.extraEgressarray-Chart configuration parameter

Node Selector(1)

ParameterTypeDefaultDescription
nodeSelectorobject-Chart configuration parameter

Tolerations(1)

ParameterTypeDefaultDescription
tolerationsarray-Chart configuration parameter

Affinity(1)

ParameterTypeDefaultDescription
affinityobject-Chart configuration parameter

Topology Spread Constraints(1)

ParameterTypeDefaultDescription
topologySpreadConstraintsarray-Chart configuration parameter

Priority Class Name(1)

ParameterTypeDefaultDescription
priorityClassNamestring-Chart configuration parameter

Termination Grace Period Seconds(1)

ParameterTypeDefaultDescription
terminationGracePeriodSecondsinteger-Chart configuration parameter

Pod Labels(1)

ParameterTypeDefaultDescription
podLabelsobject-Chart configuration parameter

Pod Annotations(1)

ParameterTypeDefaultDescription
podAnnotationsobject-Chart configuration parameter

Extra Volumes(1)

ParameterTypeDefaultDescription
extraVolumesarray-Chart configuration parameter

Extra Volume Mounts(1)

ParameterTypeDefaultDescription
extraVolumeMountsarray-Chart configuration parameter

Extra Manifests(1)

ParameterTypeDefaultDescription
extraManifestsarray-Chart configuration parameter