Skip to content

docs: updated the env example and local setup guide #666

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
Dhruvkumar-Microsoft wants to merge 1 commit into
base: dev-v3
Choose a base branch
from
Open

docs: updated the env example and local setup guide #666

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
22 changes: 19 additions & 3 deletions docs/DeploymentGuide.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -366,7 +366,7 @@ When you start the development container for the first time, the container will

The files for the dev container are located in `/.devcontainer/` folder.

## Local deployment and debugging:
## Local deployment, Setup and debugging:

1. **Clone the repository.**

Expand Down Expand Up @@ -410,7 +410,7 @@ The files for the dev container are located in `/.devcontainer/` folder.

**Role Assignments in Bicep Deployment:**

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:
The **main.bicep** deployment includes the assignment of the appropriate roles to AOAI, Storage account, Search service and Cosmos services. If you want to use resource group which is not deployed by you for local debugging—you will need to add your own credentials to access the Cosmos Storage account, Search service and AOAI services. You can add these permissions using the following commands:

```bash
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>
Expand All @@ -420,6 +420,22 @@ The files for the dev container are located in `/.devcontainer/` folder.
az role assignment create --assignee <aad-user-upn> --role "Azure AI User" --scope /subscriptions/<subscription-id>/resourceGroups/<solution-accelerator-rg>/providers/Microsoft.CognitiveServices/accounts/<azure-ai-foundry-name>
```

```bash
az role assignment create --assignee <aad-user-upn> --role " Azure AI Developer " --scope /subscriptions/<subscription-id>/resourceGroups/<solution-accelerator-rg>/providers/Microsoft.CognitiveServices/accounts/<azure-ai-foundry-name>
```

```bash
az role assignment create --assignee <aad-user-upn> --role " Cognitive Services OpenAI User " --scope /subscriptions/<subscription-id>/resourceGroups/<solution-accelerator-rg>/providers/Microsoft.CognitiveServices/accounts/<azure-ai-foundry-name>
```

```bash
az role assignment create --assignee <aad-user-upn> --role "Search Index Data Contributor" --scope /subscriptions/ <subscription-id> /resourceGroups/ <solution-accelerator-rg> /providers/Microsoft.Search/searchServices/<Search-service-name>
```

```bash
az role assignment create --assignee <aad-user-upn> --role "Storage Blob Data Contributor" --scope /subscriptions/ <subscription-id> /resourceGroups/ <solution-accelerator-rg> /providers/Microsoft.Storage/storageAccounts/<storage-account-name>
```

**Using a Different Database in Cosmos:**

You can set the solution up to use a different database in Cosmos. For example, you can name it something like macae-dev. To do this:
Expand All @@ -430,7 +446,7 @@ The files for the dev container are located in `/.devcontainer/` folder.
5. **Create a `.env` file:**

- Navigate to the `src\backend` folder and create a `.env` file based on the provided `.env.sample` file.
- Update the `.env` file with the required values from your Azure resource group in Azure Portal App Service environment variables.
- Update the `.env` file with the required values from your Azure resource group in Azure Portal Backend Container app environment variables.
- Alternatively, if resources were
provisioned using `azd provision` or `azd up`, a `.env` file is automatically generated in the `.azure/<env-name>/.env`
file. You can copy the contents of this file into your backend `.env` file.
Expand Down
23 changes: 11 additions & 12 deletions src/backend/.env.sample
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,30 +3,29 @@ COSMOSDB_DATABASE=macae
COSMOSDB_CONTAINER=memory

AZURE_OPENAI_ENDPOINT=
AZURE_OPENAI_MODEL_NAME=gpt-4o
AZURE_OPENAI_DEPLOYMENT_NAME=gpt-4o
AZURE_OPENAI_API_VERSION=2024-08-01-preview
AZURE_OPENAI_MODEL_NAME=gpt-4.1-mini
AZURE_OPENAI_DEPLOYMENT_NAME=gpt-4.1-mini
AZURE_OPENAI_API_VERSION=2024-12-01-preview

APPLICATIONINSIGHTS_INSTRUMENTATION_KEY=
AZURE_AI_PROJECT_ENDPOINT=
AZURE_AI_SUBSCRIPTION_ID=
AZURE_AI_RESOURCE_GROUP=
AZURE_AI_PROJECT_NAME=
AZURE_AI_MODEL_DEPLOYMENT_NAME=gpt-4o
AZURE_AI_MODEL_DEPLOYMENT_NAME=gpt-4.1-mini
APPLICATIONINSIGHTS_CONNECTION_STRING=
AZURE_AI_AGENT_MODEL_DEPLOYMENT_NAME=gpt-4o
AZURE_AI_AGENT_MODEL_DEPLOYMENT_NAME=gpt-4.1-mini
AZURE_COGNITIVE_SERVICES="https://cognitiveservices.azure.com/.default"
AZURE_AI_AGENT_ENDPOINT=
# AZURE_BING_CONNECTION_NAME=
REASONING_MODEL_NAME=o3
REASONING_MODEL_NAME="o4-mini"
APP_ENV=dev
MCP_SERVER_ENDPOINT=http://localhost:8080/mcp
MCP_SERVER_NAME=MyMC
MCP_SERVER_DESCRIPTION=My MCP Server
TENANT_ID=
CLIENT_ID=
MCP_SERVER_NAME=MacaeMcpServer
MCP_SERVER_DESCRIPTION="MCP server with greeting, HR, and planning tools"
AZURE_TENANT_ID=
AZURE_CLIENT_ID=
BACKEND_API_URL=http://localhost:8000
FRONTEND_SITE_NAME=
FRONTEND_SITE_NAME=*
SUPPORTED_MODELS='["o3","o4-mini","gpt-4.1","gpt-4.1-mini"]'
AZURE_AI_SEARCH_CONNECTION_NAME=
AZURE_AI_SEARCH_INDEX_NAME=
Expand Down
Loading