@@ -162,6 +162,51 @@ cp api/.env.example api/.env
162162
163163Then edit ` api/.env ` to set your ` INFERENCE_API_ENDPOINT ` and ` INFERENCE_API_TOKEN ` .
164164
165+ Or manually create ` api/.env ` with:
166+
167+ ``` bash
168+ # Inference API Configuration
169+ # INFERENCE_API_ENDPOINT: URL to your inference service (without /v1 suffix)
170+ #
171+ # **GenAI Gateway**: Provide your GenAI Gateway URL and API key
172+ # - URL format: https://genai-gateway.example.com
173+ # - To generate the GenAI Gateway API key, use the [generate-vault-secrets.sh] script
174+ # - The API key is the litellm_master_key value from the generated vault.yml file
175+ #
176+ # **APISIX Gateway**: Provide your APISIX Gateway URL and authentication token
177+ # - For APISIX, include the model name in the INFERENCE_API_ENDPOINT path
178+ # - Example: https://apisix-gateway.example.com/Llama-3.1-8B-Instruct
179+ # - Set EMBEDDING_API_ENDPOINT separately for the embedding model
180+ # - Example: https://apisix-gateway.example.com/bge-base-en-v1.5
181+ # - To generate the APISIX authentication token, use the [generate-token.sh] script
182+ # - The token is generated using Keycloak client credentials
183+ #
184+ # INFERENCE_API_TOKEN: Authentication token/API key for the inference service
185+ INFERENCE_API_ENDPOINT=https://api.example.com
186+ INFERENCE_API_TOKEN=your-pre-generated-token-here
187+
188+ # Model Configuration
189+ EMBEDDING_MODEL_NAME=BAAI/bge-base-en-v1.5
190+ INFERENCE_MODEL_NAME=meta-llama/Llama-3.1-8B-Instruct
191+
192+ # APISIX Gateway Endpoints
193+ # Uncomment and set these when using APISIX Gateway:
194+ # IMPORTANT: Use exact APISIX route paths:
195+ # Example routes: /bge-base-en-v1.5/* and /Llama-3.1-8B-Instruct/*
196+ # INFERENCE_API_ENDPOINT=https://api.example.com/Llama-3.1-8B-Instruct
197+ # EMBEDDING_API_ENDPOINT=https://api.example.com/bge-base-en-v1.5
198+
199+ # Local URL Endpoint (only needed for non-public domains)
200+ # If using a local domain like api.example.com mapped to localhost:
201+ # Set this to: api.example.com (domain without https://)
202+ # If using a public domain, set any placeholder value like: not-needed
203+ LOCAL_URL_ENDPOINT=not-needed
204+
205+ # SSL Verification Settings
206+ # Set to false only for dev with self-signed certs
207+ VERIFY_SSL=true
208+ ```
209+
165210** Important Configuration Notes:**
166211
167212- ** INFERENCE_API_ENDPOINT** : Your actual inference service URL (replace ` https://your-actual-api-endpoint.com ` )
0 commit comments