MediKeep Helm Chart
Deploy MediKeep, a self-hosted personal medical records application built with React and FastAPI.
This chart packages the official ghcr.io/afairgiant/medikeep:v0.72.0 image with PostgreSQL, persistent uploads and backups,
Kubernetes Ingress, Gateway API, NetworkPolicy, and External Secrets Operator integration.
Upgrade Notes
MediKeep v0.72.0 adds visit relationships, broader advanced search and report
controls, and fixes health responses, SSO user identification, user-scoped tag
reads and attachment filenames. It does not change the service port, uploads
path or authentication environment contract. See
authentication configuration and the
upstream release.
Back up PostgreSQL and uploaded records before upgrading.
The legacy app.port value has been removed. The pinned upstream entrypoint
always starts Uvicorn on container port 8000, so that value changed only
Kubernetes metadata and could break traffic. Do not use --reuse-values for
this migration because it can retain the removed default. Export the
user-supplied values, remove app.port from the exported file, and reset old
defaults during the upgrade:
helm get values medikeep --namespace medikeep -o yaml > medikeep-user-values.yaml
# Remove app.port from medikeep-user-values.yaml if it is present.
helm upgrade medikeep helmforge/medikeep --namespace medikeep \
--reset-values -f medikeep-user-values.yaml
Use service.port when clients need a different Kubernetes Service port; the
Service continues to target the fixed named http listener.
Install
helm repo add helmforge https://repo.helmforge.dev
helm install medikeep helmforge/medikeep
MediKeep exposes HTTP on port 8000. For local access:
kubectl port-forward svc/medikeep 8000:8000
Configuration
The chart keeps the fixed upstream listener separate from the Kubernetes
Service port. This example exposes Service port 8080 while MediKeep continues
to listen on container port 8000:
service:
port: 8080
app:
timezone: America/New_York
logLevel: INFO
debug: false
enableApiDocs: false
Common configuration groups are:
image,app, andprobesfor the pinned image and application runtime.secretsandmedikeep.ssofor authentication and stable credentials.postgresqlordatabase.externalfor the database topology.persistencefor uploads, generated backups, and optional persistent logs.service,ingress, andgatewayAPIfor exposure.networkPolicy,resources,securityContext, andpodSecurityContextfor production controls.
See Authentication and Secrets, Exposure, Production, and Storage for complete examples and operational boundaries.
Security and Production Notes
MediKeep stores personal health data. Treat the database, uploads PVC, backups PVC, logs, and Kubernetes Secrets as sensitive.
On fresh installs, upstream creates an admin user with the default password
admin123 unless ADMIN_DEFAULT_PASSWORD is set before first startup. For
production, set a strong secrets.adminDefaultPassword during the first install
or provide secrets.existingSecret with the key configured by
secrets.adminDefaultPasswordKey, then rotate the password in the UI. The chart
rejects an inline admin123 value for public exposure. Helm cannot inspect the
contents of an existing Secret, so operators must ensure that its administrator
password key exists and contains a strong value. For public exposure, the pod
will not start when that key is missing.
secrets:
existingSecret: medikeep-runtime
secretKeyKey: secret-key
adminDefaultPasswordKey: admin-password
The Secret must contain:
apiVersion: v1
kind: Secret
metadata:
name: medikeep-runtime
type: Opaque
stringData:
secret-key: replace-with-a-long-random-secret
admin-password: replace-with-a-strong-initial-password
PostgreSQL
The chart enables the HelmForge PostgreSQL subchart by default:
postgresql:
enabled: true
auth:
database: medical_records
username: medapp
existingSecret: medikeep-postgresql
existingSecretPostgresPasswordKey: postgres-password
existingSecretUserPasswordKey: user-password
The referenced Secret must contain the PostgreSQL superuser and application password keys shown above.
To use an external PostgreSQL instance:
postgresql:
enabled: false
database:
external:
host: postgres.example.com
name: medical_records
username: medapp
existingSecret: medikeep-db
existingSecretPasswordKey: password
Persistence
MediKeep writes to three paths:
/app/uploadsfor uploaded lab files, patient photos, and record attachments./app/backupsfor backups generated by the app dashboard or CLI./app/logsfor application logs.
Uploads and backups are persisted by default. Logs use emptyDir by default to avoid retaining sensitive data unless explicitly requested.
persistence:
uploads:
size: 20Gi
backups:
size: 20Gi
logs:
enabled: true
size: 2Gi
Exposure
Ingress:
ingress:
enabled: true
ingressClassName: traefik
hosts:
- host: medikeep.example.com
paths:
- path: /
pathType: Prefix
Gateway API:
gatewayAPI:
enabled: true
httpRoutes:
- parentRefs:
- name: public
namespace: gateway-system
hostnames:
- medikeep.example.com
Validation
make validate-chart CHART=medikeep
Security Scan: medikeep
| Framework | Score |
|---|---|
| MITRE + NSA + SOC2 | 92.42424% |
Security posture acceptable.
Documentation
System Architecture
DESIGN.md SyncedVerified architecture contract rendered dynamically from GitHub DESIGN.md
flowchart LR User[User] --> Service[ClusterIP Service] Service --> App[MediKeep pod<br/>React and FastAPI<br/>TCP 8000] App --> Uploads[(Uploads PVC)] App --> Backups[(Backups PVC)] App --> Logs[Ephemeral logs] App --> PostgreSQL[(Bundled PostgreSQL)] App --> Secret[Application Secret]
MediKeep Values Schema Reference
Official schema parameters, default values, and types extracted directly from the chart repository.
Global(1)
| Parameter | Type | Default | Description |
|---|---|---|---|
| global | object | - | Chart configuration parameter |
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 | any | - | 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 |
App(9)
| Parameter | Type | Default | Description |
|---|---|---|---|
| app.timezone | string | - | Chart configuration parameter |
| app.logLevel | string | - | Chart configuration parameter Allowed: INFODEBUG |
| app.debug | boolean | - | Chart configuration parameter |
| app.enableApiDocs | boolean | - | Chart configuration parameter |
| app.enableSsl | 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(7)
| Parameter | Type | Default | Description |
|---|---|---|---|
| secrets.existingSecret | string | - | Chart configuration parameter |
| secrets.secretKeyKey | string | - | Chart configuration parameter |
| secrets.secretKey | string | - | Chart configuration parameter |
| secrets.adminDefaultPasswordKey | string | - | Chart configuration parameter |
| secrets.adminDefaultPassword | string | - | Chart configuration parameter |
| secrets.ssoClientSecretKey | string | - | Chart configuration parameter |
| secrets.ssoClientSecret | string | - | Chart configuration parameter |
Database(7)
| Parameter | Type | Default | Description |
|---|---|---|---|
| database.external.host | string | - | Chart configuration parameter |
| database.external.port | string | - | Chart configuration parameter |
| database.external.name | string | - | Chart configuration parameter |
| database.external.username | string | - | Chart configuration parameter |
| database.external.password | string | - | Chart configuration parameter |
| database.external.existingSecret | string | - | Chart configuration parameter |
| database.external.existingSecretPasswordKey | string | - | Chart configuration parameter |
Medikeep(6)
| Parameter | Type | Default | Description |
|---|---|---|---|
| medikeep.sso.enabled | boolean | - | Chart configuration parameter |
| medikeep.sso.providerType | string | - | Chart configuration parameter Allowed: oidcgithubgoogle |
| medikeep.sso.clientId | string | - | Chart configuration parameter |
| medikeep.sso.issuerUrl | string | - | Chart configuration parameter |
| medikeep.sso.redirectUri | string | - | Chart configuration parameter |
| medikeep.sso.allowedDomains | string | - | Chart configuration parameter |
Persistence(3)
| Parameter | Type | Default | Description |
|---|---|---|---|
| persistence.uploads | any | - | Chart configuration parameter |
| persistence.backups | any | - | Chart configuration parameter |
| persistence.logs | any | - | Chart configuration parameter |
Service Account(1)
| Parameter | Type | Default | Description |
|---|---|---|---|
| serviceAccount | any | - | Chart configuration parameter |
Service & Networking(1)
| Parameter | Type | Default | Description |
|---|---|---|---|
| service | any | - | Chart configuration parameter |
Ingress(1)
| Parameter | Type | Default | Description |
|---|---|---|---|
| ingress | any | - | Chart configuration parameter |
Gateway API(1)
| Parameter | Type | Default | Description |
|---|---|---|---|
| gatewayAPI | any | - | Chart configuration parameter |
External Secrets(1)
| Parameter | Type | Default | Description |
|---|---|---|---|
| externalSecrets | any | - | Chart configuration parameter |
Health Probes(1)
| Parameter | Type | Default | Description |
|---|---|---|---|
| probes | any | - | Chart configuration parameter |
Resources(1)
| Parameter | Type | Default | Description |
|---|---|---|---|
| resources | any | - | Chart configuration parameter |
Wait For Database(2)
| Parameter | Type | Default | Description |
|---|---|---|---|
| waitForDatabase.image | any | - | Chart configuration parameter |
| waitForDatabase.resources | any | - | Chart configuration parameter |
Pod Security(3)
| Parameter | Type | Default | Description |
|---|---|---|---|
| podSecurityContext.fsGroup | integer | - | Chart configuration parameter |
| podSecurityContext.fsGroupChangePolicy | string | - | Chart configuration parameter Allowed: AlwaysOnRootMismatch |
| podSecurityContext.seccompProfile | any | - | Chart configuration parameter |
Container Security(7)
| Parameter | Type | Default | Description |
|---|---|---|---|
| securityContext.allowPrivilegeEscalation | boolean | - | Chart configuration parameter |
| securityContext.capabilities | object | - | 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 | any | - | Chart configuration parameter |
Pdb(1)
| Parameter | Type | Default | Description |
|---|---|---|---|
| pdb | any | - | Chart configuration parameter |
Network Policy(1)
| Parameter | Type | Default | Description |
|---|---|---|---|
| networkPolicy | any | - | Chart configuration parameter |
Node Selector(1)
| Parameter | Type | Default | Description |
|---|---|---|---|
| nodeSelector | any | - | 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 | any | - | Chart configuration parameter |
Pod Annotations(1)
| Parameter | Type | Default | Description |
|---|---|---|---|
| podAnnotations | any | - | 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 |
Postgresql(1)
| Parameter | Type | Default | Description |
|---|---|---|---|
| postgresql | object | - | Values passed to the HelmForge PostgreSQL dependency. |
No schema parameters match your search
Try searching for a different keyword or reset the filter.