diff --git a/charts/devhub/README.md b/charts/devhub/README.md index 6f323c7..30e5920 100644 --- a/charts/devhub/README.md +++ b/charts/devhub/README.md @@ -1,6 +1,6 @@ # devhub -![Version: 2.11.0](https://img.shields.io/badge/Version-2.11.0-informational?style=flag) ![AppVersion: v2.17.0](https://img.shields.io/badge/AppVersion-v2.17.0-informational?style=flag) +![Version: 2.17.0](https://img.shields.io/badge/Version-2.17.0-informational?style=flag) ![AppVersion: v2.17.0](https://img.shields.io/badge/AppVersion-v2.17.0-informational?style=flag) Instructions for running self hosted install of Devhub/QueryDesk. Currently only k8s install is supported, reach out to support@devhub.tools if you would like additional methods supported. @@ -10,16 +10,30 @@ Instructions for running self hosted install of Devhub/QueryDesk. Currently only 1. Create a secret with the required application config - ```yaml + | Key | Description | + |-----|-------------| + | `CLOAK_KEY_V1` | A base64 encoded 32 byte random value. Used as an encryption key for field level encryption. | + | `SECRET_KEY_BASE` | A base64 encoded 64 byte random value. Used for signing cookies. | + | `SIGNING_KEY` | A base64 encoded ECDSA private key using the prime256v1 curve. Used for signing JWT tokens. | + + The following example shows how to generate these values and create the secret using kubectl: + + ```bash + CLOAK_KEY_V1=$(openssl rand -base64 32 | base64) + SECRET_KEY_BASE=$(openssl rand -hex 64 | base64) + SIGNING_KEY=$(openssl ecparam -name prime256v1 -genkey -noout | openssl ec 2>/dev/null | base64) + + kubectl apply -f - </dev/null | base64) + + kubectl apply -f - <