added .env.example
This commit is contained in:
parent
08d0eef8e5
commit
c4d6109ea2
19
README.md
19
README.md
@ -33,20 +33,25 @@ python app.py
|
||||
|
||||
## Environment Variables
|
||||
|
||||
This project requires a `.env` file for configuration.
|
||||
|
||||
### **.env File Placement**
|
||||
1. Copy `.env.example` to `.env`
|
||||
2. Edit `.env` and fill in the required values.
|
||||
|
||||
|
||||
### **File Placement of .env in Development**
|
||||
- Place the `.env` file inside `src` directory.
|
||||
|
||||
### **Example `.env` File**
|
||||
```ini
|
||||
QDRANT_HOST = "localhost"
|
||||
QDRANT_HOST=localhost
|
||||
QDRANT_PORT=6333
|
||||
QDRANT_API_KEY=''
|
||||
QDRANT_API_KEY=
|
||||
QDRANT_HTTPS='true'
|
||||
QDRANT_SSL_VERIFY= 'false'
|
||||
QDRANT_CLUSTER=''
|
||||
QDRANT_COLLECTION_NAME='titan'
|
||||
TOKENIZER_FOLDER=''
|
||||
MODEL_FOLDER=''
|
||||
QDRANT_COLLECTION_NAME='mocktestdata'
|
||||
MODEL_FOLDER=
|
||||
TOKENIZER_FOLDER=
|
||||
```
|
||||
ℹ️ **Note for production/docker container:**
|
||||
`TOKENIZER_FOLDER` and `MODEL_FOLDER` are **only required for local development**.
|
||||
|
||||
12
src/.env.example
Normal file
12
src/.env.example
Normal file
@ -0,0 +1,12 @@
|
||||
# Qdrant configuration
|
||||
QDRANT_HOST=localhost
|
||||
QDRANT_PORT=6333
|
||||
QDRANT_API_KEY=
|
||||
QDRANT_HTTPS='true'
|
||||
QDRANT_SSL_VERIFY= 'false'
|
||||
QDRANT_CLUSTER=''
|
||||
QDRANT_COLLECTION_NAME='mocktestdata'
|
||||
|
||||
# Local model/tokenizer folders (only needed in development)
|
||||
MODEL_FOLDER=
|
||||
TOKENIZER_FOLDER=
|
||||
Loading…
Reference in New Issue
Block a user