From 839ad2553d4c2cd4aedd59b6d115186d3eb7aa99 Mon Sep 17 00:00:00 2001 From: Ian Seabock Date: Fri, 31 May 2024 11:58:33 -0700 Subject: [PATCH] Update README for SQL support (#891) Co-authored-by: Ian Seabock (Centific Technologies Inc) --- README.md | 10 ++++++++++ 1 file changed, 10 insertions(+) diff --git a/README.md b/README.md index 72c0ec169b..73f7597f7f 100644 --- a/README.md +++ b/README.md @@ -46,6 +46,8 @@ Please see the [section below](#add-an-identity-provider) for important informat 3. You can see the local running app at http://127.0.0.1:50505. +NOTE: You may find you need to set: MacOS: `export NODE_OPTIONS="--max-old-space-size=8192"` or Windows: `set NODE_OPTIONS=--max-old-space-size=8192` to avoid running out of memory when building the frontend. + #### Local Setup: Chat with your data using Azure Cognitive Search [More information about Azure OpenAI on your data](https://learn.microsoft.com/en-us/azure/cognitive-services/openai/concepts/use-your-data) @@ -76,6 +78,8 @@ Please see the [section below](#add-an-identity-provider) for important informat 3. Start the app with `start.cmd`. This will build the frontend, install backend dependencies, and then start the app. Or, just run the backend in debug mode using the VSCode debug configuration in `.vscode/launch.json`. 4. You can see the local running app at http://127.0.0.1:50505. +NOTE: You may find you need to set: MacOS: `export NODE_OPTIONS="--max-old-space-size=8192"` or Windows: `set NODE_OPTIONS=--max-old-space-size=8192` to avoid running out of memory when building the frontend. + #### Local Setup: Enable Chat History To enable chat history, you will need to set up CosmosDB resources. The ARM template in the `infrastructure` folder can be used to deploy an app service and a CosmosDB with the database and container configured. Then specify these additional environment variables: - `AZURE_COSMOSDB_ACCOUNT` @@ -91,6 +95,12 @@ To enable message feedback, you will need to set up CosmosDB resources. Then spe /.env - `AZURE_COSMOSDB_ENABLE_FEEDBACK=True` +#### Local Setup: Enable SQL Server +To enable SQL Server, you will need to set up SQL Server resources. Then specify these additional environment variables: +- `DATASOURCE_TYPE` (Should be set to `AzureSqlServer`) +- `AZURE_SQL_SERVER_CONNECTION_STRING` +- `AZURE_SQL_SERVER_TABLE_SCHEMA` + #### Deploy with the Azure CLI **NOTE**: If you've made code changes, be sure to **build the app code** with `start.cmd` or `start.sh` before you deploy, otherwise your changes will not be picked up. If you've updated any files in the `frontend` folder, make sure you see updates to the files in the `static` folder before you deploy.