Skip to content

Commit 6e7e1bd

Browse files
committed
update README.md
1 parent 4a59911 commit 6e7e1bd

File tree

1 file changed

+41
-0
lines changed

1 file changed

+41
-0
lines changed

README.md

Lines changed: 41 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,50 @@
11
# AI Doctor Bot
22

3+
## Configuration
4+
5+
### Secret Values
6+
7+
The application requires several secret configuration values that should be stored in a values-secret.yaml file. This
8+
file is excluded from version control (via .gitignore).
9+
Create a values-secret.yaml file in the charts/chart/ directory with the following structure:
10+
11+
```yaml
12+
apps:
13+
- name: ai-doctor-bot
14+
replicaCount: 1
15+
env:
16+
# Database configuration
17+
DATABASE_URL: "postgresql://username:password@hostname:5432/database_name"
18+
19+
# Reddit API credentials
20+
REDDIT_USERNAME: "your_reddit_username"
21+
REDDIT_PASSWORD: "your_reddit_password"
22+
REDDIT_USER_AGENT: "your_user_agent" # e.g., "AI Doctor Bot v1.0 by /u/your_username"
23+
REDDIT_CLIENT_ID: "your_reddit_client_id"
24+
REDDIT_CLIENT_SECRET: "your_reddit_client_secret"
25+
REDDIT_SUBREDDIT: "subreddit_name" # e.g., "askdocs" (without the r/)
26+
27+
# Application configuration
28+
SLEEP_DURATION: "60" # Time in seconds to wait between processing posts
29+
ASSISTANT_MODE_ID: "your_assistant_mode_id" # ID from the database for the assistant mode to use
30+
31+
# LangChain configuration (if using LangSmith)
32+
LANGCHAIN_API_KEY: "your_langchain_api_key" # Optional
33+
LANGCHAIN_PROJECT: "ai-doctor-bot" # Optional
34+
LANGCHAIN_TRACING_V2: "true" # Optional
35+
```
36+
37+
Replace the placeholder values with your actual configuration. The application uses these environment variables to
38+
connect to the PostgreSQL database, authenticate with Reddit's API, and configure the behavior of the AI doctor bot.
39+
40+
## Deployment
41+
342
```shell
443
$ helm upgrade --install ai-doctor-bot ./chart -f ./chart/values.yaml -f ./chart/values-secret.yaml
544
```
645

46+
## Uninstall
47+
748
```shell
849
helm uninstall ai-doctor-bot
950
```

0 commit comments

Comments
 (0)