From 5572164f7ceffa3c72cba3c268ee4d0e0c113198 Mon Sep 17 00:00:00 2001 From: Henning Kasch Date: Thu, 4 Nov 2021 17:56:13 +0100 Subject: [PATCH] Update README --- README.md | 14 +++++++++++--- 1 file changed, 11 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 4ba3920..903dbcb 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,18 @@ # Code FREAK Helm Chart +![GitHub release (latest by date including pre-releases)](https://img.shields.io/github/v/release/codefreak/charts?include_prereleases&label=Chart&logo=helm) Official Helm chart for installing Code FREAK on a Kubernetes cluster. +## Quickstart + +``` +helm repo add codefreak https://codefreak.github.io/charts +helm install my-codefreak-install codefreak/codefreak +``` + +## Configuration values +Please check out the [`values.yaml`](./charts/codefreak/values.yaml) for a list of supported values and their purposes. + ## Prerequisites * Helm * Kubernetes Cluster (version >=1.19 recommended for stable Ingress support) @@ -10,9 +21,6 @@ Official Helm chart for installing Code FREAK on a Kubernetes cluster. ## Resource requirements The resource requirements will depend on the number of concurrent users you expect. For a production environment you should expect 1-2GiB RAM per concurrent user. -## Configuration values -Please check out the [`values.yml`](./values.yaml) for a list of supported values and their purposes. - ## Creating the JWT signing keypair Code FREAK will use signed JWTs for authenticating users. For this to work you have to create an RSA keypair once and store it in a secret that will be accessible from the backend