Skip to content

Commit

Permalink
Update README
Browse files Browse the repository at this point in the history
  • Loading branch information
HenningCash committed Nov 4, 2021
1 parent 0afb367 commit 5572164
Showing 1 changed file with 11 additions and 3 deletions.
14 changes: 11 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -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)
Expand All @@ -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
Expand Down

0 comments on commit 5572164

Please sign in to comment.