doc: env vars

RoBorregos · Jan 12, 2025 · 4ba5f84 · 4ba5f84
1 parent 14cf1ba
commit 4ba5f84
Show file tree

Hide file tree

Showing 2 changed files with 10 additions and 0 deletions.
diff --git a/docker/hri/.env.example b/docker/hri/.env.example
@@ -0,0 +1,5 @@
+# Your OpenAI API key (when not using local LLM)
+OPENAI_API_KEY=
+
+# For KWS with porcupine
+ACCESS_KEY=
diff --git a/hri/README.md b/hri/README.md
@@ -29,10 +29,15 @@ home2
     └── speech.txt
 ```
 
+
 ## Setup with docker
 
 Run the script `setup.bash` located in `home2/docker/hri` to setup the configuration for docker. The script provides additional setup instructions.
 
+In addition, the following files are required:
+- `docker/hri/.env`: Contains the environment variables for the docker compose files. `docker/hri/.env.example` contains examples of the required variables.
+
+
 ## Using with docker
 
 ```bash