LiKenun commited on
Commit
86644e7
·
1 Parent(s): 1fd6030

Update `README.md` regarding environment variables

Browse files
Files changed (1) hide show
  1. README.md +10 -0
README.md CHANGED
@@ -19,6 +19,16 @@ short_description: Spring 2025 CTP Slack Bot RAG system
19
 
20
  ## How to Run the Application
21
 
 
 
 
 
 
 
 
 
 
 
22
  ### Normally
23
 
24
  Just run the Docker image. 😉
 
19
 
20
  ## How to Run the Application
21
 
22
+ You need to configure it first. This is done via environment variables, or an `.env` file based on the template, `.env.template`.
23
+
24
+ Obtaining the values requires setting up API tokens/secrets with:
25
+
26
+ * Slack: for `SLACK_BOT_TOKEN` and `SLACK_APP_TOKEN`
27
+ * MongoDB: for `MONGODB_URI`
28
+ * OpenAI: for `OPENAI_API_KEY`
29
+ * Google Drive: for `GOOGLE_PROJECT_ID`, `GOOGLE_CLIENT_ID`, `GOOGLE_CLIENT_EMAIL`, `GOOGLE_PRIVATE_KEY_ID`, and `GOOGLE_PRIVATE_KEY`
30
+ * For Google Drive, set up a service account. It’s the only supported authentication type.
31
+
32
  ### Normally
33
 
34
  Just run the Docker image. 😉