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
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.
Image Parameters
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.
Application Parameters
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.
Persistence Parameters
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.
Exposure Parameters
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.
Security Parameters
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.
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>-poznoteand verify the data PVC is writable by GID 82. - Service has no response: verify
containerPorts.httpmatchesPOZNOTE_LISTEN_PORTin the rendered Deployment and that the Service targets the namedhttpport. - 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=trueand 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 SyncedVerified 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]
Poznote Values Schema Reference
Official schema parameters, default values, and types extracted directly from the chart repository.
Global(1)
| Parameter | Type | Default | Description |
|---|---|---|---|
| global | object | - | Global settings shared by the chart. |
Name Override(1)
| Parameter | Type | Default | Description |
|---|---|---|---|
| nameOverride | string | - | Chart configuration parameter |
Fullname Override(1)
| Parameter | Type | Default | Description |
|---|---|---|---|
| fullnameOverride | string | - | Chart configuration parameter |
Common Labels(1)
| Parameter | Type | Default | Description |
|---|---|---|---|
| commonLabels | object | - | Chart configuration parameter |
Image(3)
| Parameter | Type | Default | Description |
|---|---|---|---|
| image.repository | string | - | Chart configuration parameter |
| image.tag | string | - | Chart configuration parameter |
| image.pullPolicy | string | - | Chart configuration parameter Allowed: AlwaysIfNotPresentNever |
Image Pull Secrets(1)
| Parameter | Type | Default | Description |
|---|---|---|---|
| imagePullSecrets | array | - | Chart configuration parameter |
Replica Count(1)
| Parameter | Type | Default | Description |
|---|---|---|---|
| replicaCount | integer | - | Chart configuration parameter |
Container Ports(1)
| Parameter | Type | Default | Description |
|---|---|---|---|
| containerPorts.http | integer | - | Chart configuration parameter |
App(6)
| Parameter | Type | Default | Description |
|---|---|---|---|
| app.timezone | string | - | Chart configuration parameter |
| app.debug | boolean | - | Chart configuration parameter |
| app.command | array | - | Chart configuration parameter |
| app.args | array | - | Chart configuration parameter |
| app.env | array | - | Chart configuration parameter |
| app.envFrom | array | - | Chart configuration parameter |
Secrets(5)
| Parameter | Type | Default | Description |
|---|---|---|---|
| secrets.existingSecret | string | - | Chart configuration parameter |
| secrets.oidcClientIdKey | string | - | Chart configuration parameter |
| secrets.oidcClientId | string | - | Chart configuration parameter |
| secrets.oidcClientSecretKey | string | - | Chart configuration parameter |
| secrets.oidcClientSecret | string | - | Chart configuration parameter |
Poznote(2)
| Parameter | Type | Default | Description |
|---|---|---|---|
| poznote.oidc.disableNormalLogin | boolean | - | Chart configuration parameter |
| poznote.sharing.hideRestrictUsers | boolean | - | Chart configuration parameter |
Persistence(5)
| Parameter | Type | Default | Description |
|---|---|---|---|
| persistence.data.enabled | boolean | - | Chart configuration parameter |
| persistence.data.size | string | - | Chart configuration parameter |
| persistence.data.storageClass | string | - | Chart configuration parameter |
| persistence.data.accessModes | array | - | Chart configuration parameter |
| persistence.data.existingClaim | string | - | Chart configuration parameter |
Service Account(4)
| Parameter | Type | Default | Description |
|---|---|---|---|
| serviceAccount.create | boolean | - | Chart configuration parameter |
| serviceAccount.name | string | - | Chart configuration parameter |
| serviceAccount.annotations | object | - | Chart configuration parameter |
| serviceAccount.automountServiceAccountToken | boolean | - | Chart configuration parameter |
Service & Networking(5)
| Parameter | Type | Default | Description |
|---|---|---|---|
| service.type | string | - | Chart configuration parameter Allowed: ClusterIPNodePortLoadBalancer |
| service.port | integer | - | Chart configuration parameter |
| service.annotations | object | - | Chart configuration parameter |
| service.ipFamilyPolicy | string | - | Chart configuration parameter Allowed: SingleStackPreferDualStackRequireDualStack |
| service.ipFamilies | array | - | Chart configuration parameter |
Ingress(5)
| Parameter | Type | Default | Description |
|---|---|---|---|
| ingress.enabled | boolean | - | Chart configuration parameter |
| ingress.ingressClassName | string | - | Chart configuration parameter |
| ingress.annotations | object | - | Chart configuration parameter |
| ingress.hosts | array | - | Chart configuration parameter |
| ingress.tls | array | - | Chart configuration parameter |
Gateway API(2)
| Parameter | Type | Default | Description |
|---|---|---|---|
| gatewayAPI.enabled | boolean | - | Chart configuration parameter |
| gatewayAPI.httpRoutes | array | - | Chart configuration parameter |
External Secrets(4)
| Parameter | Type | Default | Description |
|---|---|---|---|
| externalSecrets.enabled | boolean | - | Chart configuration parameter |
| externalSecrets.apiVersion | string | - | Chart configuration parameter |
| externalSecrets.refreshInterval | string | - | Chart configuration parameter |
| externalSecrets.items | array | - | Chart configuration parameter |
Health Probes(15)
| Parameter | Type | Default | Description |
|---|---|---|---|
| probes.startup.enabled | boolean | - | Chart configuration parameter |
| probes.startup.initialDelaySeconds | integer | - | Chart configuration parameter |
| probes.startup.periodSeconds | integer | - | Chart configuration parameter |
| probes.startup.timeoutSeconds | integer | - | Chart configuration parameter |
| probes.startup.failureThreshold | integer | - | Chart configuration parameter |
| probes.liveness.enabled | boolean | - | Chart configuration parameter |
| probes.liveness.initialDelaySeconds | integer | - | Chart configuration parameter |
| probes.liveness.periodSeconds | integer | - | Chart configuration parameter |
| probes.liveness.timeoutSeconds | integer | - | Chart configuration parameter |
| probes.liveness.failureThreshold | integer | - | Chart configuration parameter |
| probes.readiness.enabled | boolean | - | Chart configuration parameter |
| probes.readiness.initialDelaySeconds | integer | - | Chart configuration parameter |
| probes.readiness.periodSeconds | integer | - | Chart configuration parameter |
| probes.readiness.timeoutSeconds | integer | - | Chart configuration parameter |
| probes.readiness.failureThreshold | integer | - | Chart configuration parameter |
Resources(4)
| Parameter | Type | Default | Description |
|---|---|---|---|
| resources.requests.cpu | stringnumber | - | Chart configuration parameter |
| resources.requests.memory | stringnumber | - | Chart configuration parameter |
| resources.limits.cpu | stringnumber | - | Chart configuration parameter |
| resources.limits.memory | stringnumber | - | Chart configuration parameter |
Pod Security(4)
| Parameter | Type | Default | Description |
|---|---|---|---|
| podSecurityContext.fsGroup | integer | - | Chart configuration parameter |
| podSecurityContext.fsGroupChangePolicy | string | - | Chart configuration parameter Allowed: AlwaysOnRootMismatch |
| podSecurityContext.seccompProfile.type | string | - | Chart configuration parameter Allowed: RuntimeDefaultUnconfinedLocalhost |
| podSecurityContext.seccompProfile.localhostProfile | string | - | Chart configuration parameter |
Container Security(7)
| Parameter | Type | Default | Description |
|---|---|---|---|
| securityContext.allowPrivilegeEscalation | boolean | - | Chart configuration parameter |
| securityContext.capabilities.drop | array | - | Chart configuration parameter |
| securityContext.capabilities.add | array | - | Chart configuration parameter |
| securityContext.readOnlyRootFilesystem | boolean | - | Chart configuration parameter |
| securityContext.runAsNonRoot | boolean | - | Chart configuration parameter |
| securityContext.seccompProfile.type | string | - | Chart configuration parameter Allowed: RuntimeDefaultUnconfinedLocalhost |
| securityContext.seccompProfile.localhostProfile | string | - | Chart configuration parameter |
Pdb(2)
| Parameter | Type | Default | Description |
|---|---|---|---|
| pdb.enabled | boolean | - | Chart configuration parameter |
| pdb.minAvailable | integer | - | Chart configuration parameter |
Network Policy(6)
| Parameter | Type | Default | Description |
|---|---|---|---|
| networkPolicy.enabled | boolean | - | Chart configuration parameter |
| networkPolicy.ingressFrom | array | - | Chart configuration parameter |
| networkPolicy.egress.enabled | boolean | - | Chart configuration parameter |
| networkPolicy.egress.allowDNS | boolean | - | Chart configuration parameter |
| networkPolicy.egress.extraTo | array | - | Chart configuration parameter |
| networkPolicy.egress.extraEgress | array | - | Chart configuration parameter |
Node Selector(1)
| Parameter | Type | Default | Description |
|---|---|---|---|
| nodeSelector | object | - | Chart configuration parameter |
Tolerations(1)
| Parameter | Type | Default | Description |
|---|---|---|---|
| tolerations | array | - | Chart configuration parameter |
Affinity(1)
| Parameter | Type | Default | Description |
|---|---|---|---|
| affinity | object | - | Chart configuration parameter |
Topology Spread Constraints(1)
| Parameter | Type | Default | Description |
|---|---|---|---|
| topologySpreadConstraints | array | - | Chart configuration parameter |
Priority Class Name(1)
| Parameter | Type | Default | Description |
|---|---|---|---|
| priorityClassName | string | - | Chart configuration parameter |
Termination Grace Period Seconds(1)
| Parameter | Type | Default | Description |
|---|---|---|---|
| terminationGracePeriodSeconds | integer | - | Chart configuration parameter |
Pod Labels(1)
| Parameter | Type | Default | Description |
|---|---|---|---|
| podLabels | object | - | Chart configuration parameter |
Pod Annotations(1)
| Parameter | Type | Default | Description |
|---|---|---|---|
| podAnnotations | object | - | Chart configuration parameter |
Extra Volumes(1)
| Parameter | Type | Default | Description |
|---|---|---|---|
| extraVolumes | array | - | Chart configuration parameter |
Extra Volume Mounts(1)
| Parameter | Type | Default | Description |
|---|---|---|---|
| extraVolumeMounts | array | - | Chart configuration parameter |
Extra Manifests(1)
| Parameter | Type | Default | Description |
|---|---|---|---|
| extraManifests | array | - | Chart configuration parameter |
No schema parameters match your search
Try searching for a different keyword or reset the filter.