Skip to content

Commit 18cb489

Browse files
committed
Update readme
1 parent bc8c9e6 commit 18cb489

1 file changed

Lines changed: 17 additions & 2 deletions

File tree

readme.md

Lines changed: 17 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -32,8 +32,23 @@ It helps accelerate migrations to Denodo by automating SQL-to-VQL conversion.
3232
git clone https://github.com/banickn/VQLForge.git
3333
cd VQLForge
3434
```
35-
3. **Configure Environment:** Create a `.env` file in the project root based on the `template.env` and add your Gemini API key and Denodo properties:
36-
This is required for all AI Assistant features.
35+
3. **Configure Environment:** Create a `.env` file in the project root based on the `template.env` and add modify the following properties:
36+
- **Denodo settings**
37+
- DENODO_HOST=<DENODO_HOST> # Server url
38+
- DENODO_DB=<DENODO_DB_NAME> # Default VDB
39+
- DENODO_USER=<DENODO_USER> # This user should read/execute access to all VDBs
40+
- DENODO_PW=<DENODO_USER_PW>
41+
42+
- **AI API**
43+
- AI_API_KEY=<GEMINI_KEY> # This needs to be a valid Gemini 2.5 Flash key
44+
- **Others**
45+
- APP_NETWORK_NAME=denodo-lab-net # Rename or remove if you don't connect via docker network
46+
- HOST_PROJECT_PATH=<repository_path> # Path to your VQLForge directory. Required for VDB config
47+
48+
Go to ./backend/vdb_conf.yaml and configure the name of your available Denodo VDBs so they are selectable in VQLForge.
49+
50+
These configurations are required to run the advanced query analysis features.
51+
3752
4. **Docker Network (Required for VDP Validation):** For the AI VQL validation feature, ensure a `denodo-docker-network` exists (`docker network create denodo-docker-network`) and your Denodo VDP container is connected to it.
3853
5. **Run:**
3954
If you want to build the images yourself for local development use:

0 commit comments

Comments
 (0)