From 6f829ebcfb4d9f78410cf0f12140bb451fab786a Mon Sep 17 00:00:00 2001 From: John Matthews Date: Fri, 9 Aug 2024 11:17:22 -0400 Subject: [PATCH] Add note on GENAI_KEY being required (#288) Signed-off-by: John Matthews --- README.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 59805a75..b8170b4b 100644 --- a/README.md +++ b/README.md @@ -57,7 +57,8 @@ The quickest way to get running is to leverage sample data committed into the Ka - **_NOTE:_** The above edit of `compose.yaml` will not be needed once [Issue #257](https://github.com/konveyor/kai/issues/257) is fixed -1. Run `podman compose up`. The first time this is run it will take several minutes to download images and to populate sample data. +1. Run `GENAI_KEY="something" podman compose up`. The first time this is run it will take several minutes to download images and to populate sample data. + - **_NOTE:_** We need to provide some/any value to `GENAI_KEY` environment variable until we address [Issue #287](https://github.com/konveyor/kai/issues/287) - You will need to install [podman](https://podman.io/docs/installation) and [podman-compose](https://github.com/containers/podman-compose?tab=readme-ov-file#installation) if you do not already have it installed. This allows your system to run containers. - After the first run the DB will be populated and subsequent starts will be much faster, as long as the kai_kai_db_data volume is not deleted. - To clean up all resources run `podman compose down && podman volume rm kai_kai_db_data`.