Skip to content

Commit 1bd9a0a

Browse files
Merge pull request microsoft#378 from microsoft/updated-readme-local-deployment
docs: updated env in readme local setup
2 parents f0614de + 1f2758a commit 1bd9a0a

File tree

3 files changed

+34
-7
lines changed

3 files changed

+34
-7
lines changed

docs/DeploymentGuide.md

Lines changed: 19 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -233,7 +233,7 @@ The easiest way to run this accelerator is in a VS Code Dev Containers, which wi
233233

234234
## Detailed Development Container setup instructions
235235

236-
The solution contains a [development container](https://code.visualstudio.com/docs/remote/containers) with all the required tooling to develop and deploy the accelerator. To deploy the Chat With Your Data accelerator using the provided development container you will also need:
236+
The solution contains a [development container](https://code.visualstudio.com/docs/remote/containers) with all the required tooling to develop and deploy the accelerator. To deploy the Multi-Agent solutions accelerator using the provided development container you will also need:
237237

238238
- [Visual Studio Code](https://code.visualstudio.com)
239239
- [Remote containers extension for Visual Studio Code](https://marketplace.visualstudio.com/items?itemName=ms-vscode-remote.remote-containers)
@@ -287,7 +287,7 @@ The files for the dev container are located in `/.devcontainer/` folder.
287287

288288
- You can use the Bicep extension for VSCode (Right-click the `.bicep` file, then select "Show deployment plan") or use the Azure CLI:
289289
```bash
290-
az deployment group create -g <resource-group-name> -f deploy/macae-dev.bicep --query 'properties.outputs'
290+
az deployment group create -g <resource-group-name> -f infra/main.bicep --query 'properties.outputs'
291291
```
292292
- **Note**: You will be prompted for a `principalId`, which is the ObjectID of your user in Entra ID. To find it, use the Azure Portal or run:
293293
@@ -301,7 +301,7 @@ The files for the dev container are located in `/.devcontainer/` folder.
301301
302302
**Role Assignments in Bicep Deployment:**
303303
304-
The **macae-dev.bicep** deployment includes the assignment of the appropriate roles to AOAI and Cosmos services. If you want to modify an existing implementation—for example, to use resources deployed as part of the simple deployment for local debugging—you will need to add your own credentials to access the Cosmos and AOAI services. You can add these permissions using the following commands:
304+
The **main.bicep** deployment includes the assignment of the appropriate roles to AOAI and Cosmos services. If you want to modify an existing implementation—for example, to use resources deployed as part of the simple deployment for local debugging—you will need to add your own credentials to access the Cosmos and AOAI services. You can add these permissions using the following commands:
305305
306306
```bash
307307
az cosmosdb sql role assignment create --resource-group <solution-accelerator-rg> --account-name <cosmos-db-account-name> --role-definition-name "Cosmos DB Built-in Data Contributor" --principal-id <aad-user-object-id> --scope /subscriptions/<subscription-id>/resourceGroups/<solution-accelerator-rg>/providers/Microsoft.DocumentDB/databaseAccounts/<cosmos-db-account-name>
@@ -321,6 +321,10 @@ The files for the dev container are located in `/.devcontainer/` folder.
321321
5. **Create a `.env` file:**
322322
323323
- Navigate to the `src\backend` folder and create a `.env` file based on the provided `.env.sample` file.
324+
- Update the `.env` file with the required values from your Azure resource group in Azure Portal App Service environment variables.
325+
- Alternatively, if resources were
326+
provisioned using `azd provision` or `azd up`, a `.env` file is automatically generated in the `.azure/<env-name>/.env`
327+
file. To get your `<env-name>` run `azd env list` to see which env is default.
324328
325329
6. **Fill in the `.env` file:**
326330
@@ -338,8 +342,19 @@ The files for the dev container are located in `/.devcontainer/` folder.
338342
```bash
339343
pip install -r requirements.txt
340344
```
345+
346+
9. **Build the frontend (important):**
341347
342-
9. **Run the application:**
348+
- Before running the frontend server, you must build the frontend to generate the necessary `build/assets` directory.
349+
350+
From the `src/frontend` directory, run:
351+
352+
```bash
353+
npm install
354+
npm run build
355+
```
356+
357+
10. **Run the application:**
343358
344359
- From the src/backend directory:
345360

docs/LocalDeployment.md

Lines changed: 14 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ The easiest way to run this accelerator is in a VS Code Dev Containers, which wi
2020

2121
## Detailed Development Container setup instructions
2222

23-
The solution contains a [development container](https://code.visualstudio.com/docs/remote/containers) with all the required tooling to develop and deploy the accelerator. To deploy the Chat With Your Data accelerator using the provided development container you will also need:
23+
The solution contains a [development container](https://code.visualstudio.com/docs/remote/containers) with all the required tooling to develop and deploy the accelerator. To deploy the Multi Agent Solution accelerator using the provided development container you will also need:
2424

2525
* [Visual Studio Code](https://code.visualstudio.com)
2626
* [Remote containers extension for Visual Studio Code](https://marketplace.visualstudio.com/items?itemName=ms-vscode-remote.remote-containers)
@@ -74,7 +74,7 @@ The files for the dev container are located in `/.devcontainer/` folder.
7474

7575
- You can use the Bicep extension for VSCode (Right-click the `.bicep` file, then select "Show deployment plane") or use the Azure CLI:
7676
```bash
77-
az deployment group create -g <resource-group-name> -f deploy/macae-dev.bicep --query 'properties.outputs'
77+
az deployment group create -g <resource-group-name> -f infra/main.bicep --query 'properties.outputs'
7878
```
7979
- **Note**: You will be prompted for a `principalId`, which is the ObjectID of your user in Entra ID. To find it, use the Azure Portal or run:
8080
```bash
@@ -124,8 +124,19 @@ The files for the dev container are located in `/.devcontainer/` folder.
124124
```bash
125125
pip install -r requirements.txt
126126
```
127+
128+
9. **Build the frontend (important):**
129+
130+
- Before running the frontend server, you must build the frontend to generate the necessary `build/assets` directory.
131+
132+
From the `src/frontend` directory, run:
133+
134+
```bash
135+
npm install
136+
npm run build
137+
```
127138
128-
10. **Run the application:**
139+
11. **Run the application:**
129140
- From the src/backend directory:
130141
```bash
131142
python app_kernel.py

infra/main.bicep

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1738,3 +1738,4 @@ output AZURE_AI_MODEL_DEPLOYMENT_NAME string = aiFoundryAiServicesModelDeploymen
17381738
// output APPLICATIONINSIGHTS_CONNECTION_STRING string = applicationInsights.outputs.connectionString
17391739
output AZURE_AI_AGENT_MODEL_DEPLOYMENT_NAME string = aiFoundryAiServicesModelDeployment.name
17401740
output AZURE_AI_AGENT_ENDPOINT string = aiFoundryAiServices.outputs.aiProjectInfo.apiEndpoint
1741+
output APP_ENV string = 'Prod'

0 commit comments

Comments
 (0)