NoteDiscovery Helm Chart
Deploy NoteDiscovery, a self-hosted Markdown knowledge base with graph view, search, sharing, and MCP integration.
This chart packages the official ghcr.io/gamosoft/notediscovery:0.32.1 image
and exposes the runtime settings that matter for Kubernetes: persistent note
storage, generated or externally managed config.yaml, optional authentication,
ingress/Gateway API exposure, network policy, pod disruption budget, and
non-root security context.
Architecture
NoteDiscovery runs as one Python web service listening on port 8000. The
upstream container stores durable notes and related files under /app/data and
reads application settings from /app/config.yaml.
The default chart topology is intentionally conservative:
- one Deployment replica with
Recreaterollout strategy - one PersistentVolumeClaim mounted at
/app/data - generated ConfigMap for unauthenticated
config.yaml - ServiceAccount token automount disabled
- non-root container security context
When authentication is enabled, the generated config.yaml is stored in a
Kubernetes Secret so secret_key, password, and api_key are not rendered
into a ConfigMap. For GitOps and production, prefer auth.existingSecret with a
complete config.yaml key.
Install
helm repo add helmforge https://repo.helmforge.dev
helm install notediscovery helmforge/notediscovery
Forward the service for local validation:
kubectl port-forward svc/notediscovery 8000:8000
Then open http://127.0.0.1:8000.
Production Values
notediscovery:
allowedOrigins:
- https://notes.example.com
defaultTheme: dracula
auth:
enabled: true
existingSecret: notediscovery-config
existingSecretKey: config.yaml
ingress:
enabled: true
ingressClassName: traefik
hosts:
- host: notes.example.com
paths:
- path: /
pathType: Prefix
tls:
- secretName: notediscovery-tls
hosts:
- notes.example.com
persistence:
enabled: true
size: 20Gi
resources:
requests:
cpu: 100m
memory: 256Mi
limits:
cpu: 1
memory: 1Gi
networkPolicy:
enabled: true
extraEgress:
- to:
- ipBlock:
cidr: 10.0.0.0/8
ports:
- protocol: TCP
port: 8443
Create the existing Secret with a complete NoteDiscovery config file:
apiVersion: v1
kind: Secret
metadata:
name: notediscovery-config
type: Opaque
stringData:
config.yaml: |
app:
name: "NoteDiscovery"
server:
host: "0.0.0.0"
port: 8000
reload: false
allowed_origins:
- https://notes.example.com
debug: false
storage:
notes_dir: "/app/data"
plugins_dir: "/app/data/plugins"
search:
enabled: true
ui:
autosave_delay_ms: 1000
default_theme: "dracula"
authentication:
enabled: true
secret_key: "replace-with-a-long-random-secret"
password: "replace-with-a-strong-password"
session_max_age: 604800
api_key: ""
Authentication
auth.enabled=false is the default so first-time local installs start without
credentials. For any shared or internet-facing deployment, enable authentication
and provide either:
auth.secretKeyandauth.password, which render into a chart-managed Secretauth.existingSecret, which must contain a completeconfig.yaml
auth.existingSecret is preferred for production because it avoids putting secret values in Helm values files.
Storage
Back up the PersistentVolumeClaim before upgrades. NoteDiscovery stores notes
and local application data under /app/data by default.
The chart blocks replicaCount > 1 unless persistence.existingClaim is set.
Multiple pods require storage semantics chosen by the operator, typically a
shared ReadWriteMany claim; the default generated claim is a single-writer
volume.
Upgrade Notes
Upgrading to 0.32.1
NoteDiscovery 0.32.1 is an upstream release containing new features, bug fixes, and stability improvements.
No breaking configuration or schema changes are introduced in this release.
Review the upstream 0.32.1 release notes.
Upgrading to 0.31.7
NoteDiscovery 0.31.7 adds a homepage list view without changing the service,
configuration or persistence contracts. Review the
upstream 0.31.7 release
and back up the data PVC before upgrading.
Generated configuration now stores plugin state under the writable data volume
and bootstraps the official bundled plugins there. Existing Secrets should use
storage.plugins_dir: "/app/data/plugins" (or another writable directory).
The chart sets PLUGINS_DIR to notediscovery.pluginsDir, derived from
persistence.mountPath when empty, so the effective path stays consistent for
generated config, existing Secrets, and External Secrets. Bootstrap preserves
files already present on the volume.
Back up the PVC and keep persistence.mountPath stable, then apply the new
chart defaults while preserving explicit overrides:
helm repo update helmforge
helm upgrade notediscovery helmforge/notediscovery \
--version 1.1.0 \
--namespace notediscovery \
--reset-then-reuse-values
Network Policy
networkPolicy.enabled=true restricts inbound HTTP traffic to the configured
networkPolicy.ingressFrom peers, or to all namespaces when ingressFrom is
empty. networkPolicy.extraEgress enables egress isolation and appends custom
egress rules after built-in DNS and HTTPS allowances.
Documentation
Security Scan: notediscovery
| Framework | Score |
|---|---|
| MITRE + NSA + SOC2 | 87.37% |
Security posture acceptable.
System Architecture
DESIGN.md SyncedVerified architecture contract rendered dynamically from GitHub DESIGN.md
flowchart LR users[Trusted users] --> edge[Ingress or Gateway API] edge --> service[NoteDiscovery Service] service --> app[Singleton NoteDiscovery Deployment] config[ConfigMap or Secret config.yaml] --> app eso[External Secrets Operator optional] -. materializes .-> config app --> notes[(Markdown data PVC)] app --> plugins[(Plugin data on PVC)] mcp[MCP clients] --> service
NoteDiscovery 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 | ghcr.io/gamosoft/notediscovery | Chart configuration parameter |
| image.tag | string | 0.32.1 | Chart configuration parameter |
| image.pullPolicy | string | IfNotPresent | 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 | 1 | Chart configuration parameter |
App(6)
| Parameter | Type | Default | Description |
|---|---|---|---|
| app.port | integer | 8000 | Chart configuration parameter |
| app.timezone | string | UTC | 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 |
Notediscovery(7)
| Parameter | Type | Default | Description |
|---|---|---|---|
| notediscovery.appName | string | NoteDiscovery | Chart configuration parameter |
| notediscovery.allowedOrigins | array | - | Chart configuration parameter |
| notediscovery.debug | boolean | false | Chart configuration parameter |
| notediscovery.searchEnabled | boolean | true | Chart configuration parameter |
| notediscovery.autosaveDelayMs | integer | 1000 | Chart configuration parameter |
| notediscovery.defaultTheme | string | light | Chart configuration parameter |
| notediscovery.pluginsDir | string | "" | Chart configuration parameter |
Authentication(7)
| Parameter | Type | Default | Description |
|---|---|---|---|
| auth.enabled | boolean | false | Chart configuration parameter |
| auth.secretKey | string | "" | Chart configuration parameter |
| auth.password | string | "" | Chart configuration parameter |
| auth.apiKey | string | "" | Chart configuration parameter |
| auth.sessionMaxAge | integer | 604800 | Chart configuration parameter |
| auth.existingSecret | string | "" | Chart configuration parameter |
| auth.existingSecretKey | string | config.yaml | Chart configuration parameter |
Persistence(6)
| Parameter | Type | Default | Description |
|---|---|---|---|
| persistence.enabled | boolean | true | Chart configuration parameter |
| persistence.size | string | 5Gi | Chart configuration parameter |
| persistence.storageClass | string | "" | Chart configuration parameter |
| persistence.accessModes | array | - | Chart configuration parameter |
| persistence.existingClaim | string | "" | Chart configuration parameter |
| persistence.mountPath | string | /app/data | Chart configuration parameter |
Service Account(4)
| Parameter | Type | Default | Description |
|---|---|---|---|
| serviceAccount.create | boolean | true | Chart configuration parameter |
| serviceAccount.name | string | "" | Chart configuration parameter |
| serviceAccount.annotations | object | - | Chart configuration parameter |
| serviceAccount.automountServiceAccountToken | boolean | false | Chart configuration parameter |
Service & Networking(5)
| Parameter | Type | Default | Description |
|---|---|---|---|
| service.type | string | ClusterIP | Chart configuration parameter Allowed: ClusterIPNodePortLoadBalancer |
| service.port | integer | 8000 | 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 | false | Chart configuration parameter |
| ingress.ingressClassName | string | traefik | 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 | false | Chart configuration parameter |
| gatewayAPI.httpRoutes | array | - | Chart configuration parameter |
External Secrets(4)
| Parameter | Type | Default | Description |
|---|---|---|---|
| externalSecrets.enabled | boolean | false | Chart configuration parameter |
| externalSecrets.apiVersion | string | external-secrets.io/v1 | Chart configuration parameter |
| externalSecrets.refreshInterval | string | 1h | 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(1)
| Parameter | Type | Default | Description |
|---|---|---|---|
| resources | object | - | Chart configuration parameter |
Pod Security(2)
| Parameter | Type | Default | Description |
|---|---|---|---|
| podSecurityContext.fsGroup | integer | - | Chart configuration parameter |
| podSecurityContext.fsGroupChangePolicy | string | - | Chart configuration parameter Allowed: AlwaysOnRootMismatch |
Container Security(7)
| Parameter | Type | Default | Description |
|---|---|---|---|
| securityContext.allowPrivilegeEscalation | boolean | - | Chart configuration parameter |
| securityContext.capabilities.drop | array | - | Chart configuration parameter |
| securityContext.readOnlyRootFilesystem | boolean | - | Chart configuration parameter |
| securityContext.runAsNonRoot | boolean | - | Chart configuration parameter |
| securityContext.runAsUser | integer | - | Chart configuration parameter |
| securityContext.runAsGroup | integer | - | Chart configuration parameter |
| securityContext.seccompProfile.type | string | - | Chart configuration parameter Allowed: RuntimeDefaultLocalhostUnconfined |
Pdb(2)
| Parameter | Type | Default | Description |
|---|---|---|---|
| pdb.enabled | boolean | false | Chart configuration parameter |
| pdb.minAvailable | any | - | Chart configuration parameter |
Network Policy(3)
| Parameter | Type | Default | Description |
|---|---|---|---|
| networkPolicy.enabled | boolean | false | Chart configuration parameter |
| networkPolicy.ingressFrom | array | - | Chart configuration parameter |
| networkPolicy.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 | 30 | 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.