Below are the required environment variables, to be added to the Azure Portal or in the .env.local file.
| App Setting | Value | Note |
|---|---|---|
OPENAI_API_KEY |
API keys of your Azure OpenAI resource | |
AZURE_OPENAI_API_INSTANCE_NAME |
the name of your Azure OpenAI resource | |
AZURE_OPENAI_API_DEPLOYMENT_NAME |
The name of your model deployment | |
AZURE_OPENAI_API_VERSION |
2023-03-15-preview |
API version when using gpt chat |
AUTH_GITHUB_ID |
Client ID of your GitHub OAuth application | |
AUTH_GITHUB_SECRET |
Client Secret of your GitHub OAuth application | |
NEXTAUTH_SECRET |
Used to encrypt the NextAuth.js JWT, and to hash email verification tokens. This is set by default as part of the deployment template | |
NEXTAUTH_URL |
Current webs hosting domain name with HTTP or HTTPS. This set by default as part of the deployment template | |
AZURE_COSMOSDB_URI |
URL of the Azure CosmosDB | |
AZURE_COSMOSDB_KEY |
API Key for Azure Cosmos DB | |
AZURE_AD_CLIENT_ID |
The client id specific to the application | |
AZURE_AD_CLIENT_SECRET |
The client secret specific to the application | |
AZURE_AD_TENANT_ID |
The organisation Tenant ID | |
AZURE_AD_GCCH_CLIENT_ID |
The government client id specific to the application | |
AZURE_AD_GCCH_CLIENT_SECRET |
The government client secret specific to the application | |
AZURE_AD_GCCH_TENANT_ID |
The government organisation Tenant ID | |
ADMIN_EMAIL_ADDRESS |
Comma separated list of email addresses of the admin users ID | |
| Azure Cognitive Search is optional. This is only required for chat over file feature. | ||
AZURE_SEARCH_API_KEY |
API Key of Azure Cognitive search | |
AZURE_SEARCH_URL |
https://NAME.search.azure.us/ |
The deployment name of your Azure Cognitive Search |
AZURE_SEARCH_INDEX_NAME |
The index name with vector search enabled | |
AZURE_SEARCH_API_VERSION |
2023-07-01-Preview |
API version which supports vector search 2023-07-01-Preview |
AZURE_DOCUMENT_INTELLIGENCE_ENDPOINT |
https://NAME.cognitiveservices.azure.us/ |
Endpoint url of the Azure document intelligence. |
PUBLIC_SPEECH_ENABLED |
false | Whether speech should be enabled (microphone button appears). Must be "true" to enable, any other value (or blank) will disable. |
AZURE_SPEECH_REGION |
Region of your Azure Speech service | |
AZURE_SPEECH_KEY |
API Key of Azure Speech service | |