charlene/recommender-service-flask
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

added .env.example

Browse Source
This commit is contained in:
charlene tau express 2025-04-23 10:33:28 +08:00
parent 08d0eef8e5
commit c4d6109ea2
2 changed files with 25 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

21
README.md
View File

@ -33,20 +33,25 @@ python app.py
## Environment Variables ## 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. - Place the `.env` file inside `src` directory.
### **Example `.env` File** ### **Example `.env` File**
```ini ```ini
QDRANT_HOST = "localhost" QDRANT_HOST=localhost
QDRANT_PORT = 6333 QDRANT_PORT=6333
QDRANT_API_KEY='' QDRANT_API_KEY=
QDRANT_HTTPS='true'
QDRANT_SSL_VERIFY= 'false'
QDRANT_CLUSTER='' QDRANT_CLUSTER=''
QDRANT_COLLECTION_NAME='titan' QDRANT_COLLECTION_NAME='mocktestdata'
TOKENIZER_FOLDER='' MODEL_FOLDER=
MODEL_FOLDER='' TOKENIZER_FOLDER=
``` ```
ℹ️ **Note for production/docker container:** ℹ️ **Note for production/docker container:**
`TOKENIZER_FOLDER` and `MODEL_FOLDER` are **only required for local development**. `TOKENIZER_FOLDER` and `MODEL_FOLDER` are **only required for local development**.

12
src/.env.example Normal file
View 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=