first commit

notely/README.md

@@ -0,0 +1,69 @@
+# notely Helm Chart
+
+This chart deploys Notely (notely) and can also provision MongoDB and Redis.
+
+## What this chart creates
+
+- notely Deployment and Service
+- ConfigMap and Secret for application configuration
+- Optional MongoDB StatefulSet, Service, Secret, and PVC
+- Optional Redis Deployment and Service
+- Optional Ingress
+- Optional HPA
+
+## Install
+
+```bash
+helm install notely ./notely -n notely --create-namespace
+```
+
+## Upgrade
+
+```bash
+helm upgrade notely ./notely -n notely
+```
+
+## Uninstall
+
+```bash
+helm uninstall notely -n notely
+```
+
+## Important values
+
+- `image.repository`, `image.tag`
+- `secrets.jwtSecret`, `secrets.encryptionKey`
+- `secrets.defaultAdminEmail`, `secrets.defaultAdminUsername`, `secrets.defaultAdminPassword`
+- `secrets.redisUser`, `secrets.redisPassword`
+- `mongodb.enabled` and `mongodb.auth.*`
+- `redis.enabled` and `redis.auth.enabled`
+- `ingress.enabled`
+- `autoscaling.enabled`
+
+## Example override file
+
+```yaml
+image:
+    repository: your-registry/notely
+    tag: v1.0.0
+
+secrets:
+    jwtSecret: replace-with-production-secret
+    encryptionKey: 32-char-encryption-key-goes-here
+    defaultAdminEmail: admin@example.com
+    defaultAdminUsername: admin
+    defaultAdminPassword: replace-with-strong-password
+
+ingress:
+    enabled: true
+    className: nginx
+    annotations:
+        nginx.ingress.kubernetes.io/ssl-redirect: "false"
+    hosts:
+        - host: notely.local
+          paths:
+              - path: /api
+                pathType: Prefix
+              - path: /
+                pathType: Prefix
+```