mirror of
https://github.com/rtomik/helm-charts.git
synced 2026-07-17 00:36:43 +00:00
release 0.0.1 for karakeep
This commit is contained in:
46
charts/karakeep/NOTES.txt
Normal file
46
charts/karakeep/NOTES.txt
Normal file
@ -0,0 +1,46 @@
|
||||
1. Get the application URL by running these commands:
|
||||
{{- if .Values.ingress.enabled }}
|
||||
{{- range $host := .Values.ingress.hosts }}
|
||||
{{- range .paths }}
|
||||
http{{ if $.Values.ingress.tls }}s{{ end }}://{{ $host.host }}{{ .path }}
|
||||
{{- end }}
|
||||
{{- end }}
|
||||
{{- else if contains "NodePort" .Values.service.type }}
|
||||
export NODE_PORT=$(kubectl get --namespace {{ .Release.Namespace }} -o jsonpath="{.spec.ports[0].nodePort}" services {{ include "karakeep.fullname" . }})
|
||||
export NODE_IP=$(kubectl get nodes --namespace {{ .Release.Namespace }} -o jsonpath="{.items[0].status.addresses[0].address}")
|
||||
echo http://$NODE_IP:$NODE_PORT
|
||||
{{- else if contains "LoadBalancer" .Values.service.type }}
|
||||
NOTE: It may take a few minutes for the LoadBalancer IP to be available.
|
||||
You can watch the status of by running 'kubectl get --namespace {{ .Release.Namespace }} svc -w {{ include "karakeep.fullname" . }}'
|
||||
export SERVICE_IP=$(kubectl get svc --namespace {{ .Release.Namespace }} {{ include "karakeep.fullname" . }} --template "{{"{{ range (index .status.loadBalancer.ingress 0) }}{{.}}{{ end }}"}}")
|
||||
echo http://$SERVICE_IP:{{ .Values.service.port }}
|
||||
{{- else if contains "ClusterIP" .Values.service.type }}
|
||||
export POD_NAME=$(kubectl get pods --namespace {{ .Release.Namespace }} -l "{{ include "karakeep.selectorLabels" . }}" -o jsonpath="{.items[0].metadata.name}")
|
||||
export CONTAINER_PORT=$(kubectl get pod --namespace {{ .Release.Namespace }} $POD_NAME -o jsonpath="{.spec.containers[0].ports[0].containerPort}")
|
||||
echo "Visit http://127.0.0.1:3000 to use your application"
|
||||
kubectl --namespace {{ .Release.Namespace }} port-forward $POD_NAME 3000:$CONTAINER_PORT
|
||||
{{- end }}
|
||||
|
||||
2. Karakeep has been deployed with the following components:
|
||||
- Main application (Karakeep)
|
||||
- MeiliSearch for search functionality
|
||||
- Chrome browser for web scraping
|
||||
|
||||
{{- if not .Values.persistence.enabled }}
|
||||
3. WARNING: Persistence is disabled. Data will be lost when pods are restarted.
|
||||
Enable persistence by setting:
|
||||
persistence.enabled=true
|
||||
{{- end }}
|
||||
|
||||
4. IMPORTANT: Configuration for production:
|
||||
- Generate a secure 32-character random string for NEXTAUTH_SECRET
|
||||
- NEXTAUTH_URL is automatically set when ingress is enabled
|
||||
- Update secrets or environment variables as needed
|
||||
|
||||
{{- if not .Values.secrets.create }}
|
||||
{{- if not .Values.secrets.existingSecret }}
|
||||
5. Optional: Configure additional API keys via secrets:
|
||||
- OPENAI_API_KEY for AI features
|
||||
- MEILI_MASTER_KEY for MeiliSearch authentication
|
||||
{{- end }}
|
||||
{{- end }}
|
||||
Reference in New Issue
Block a user