Skip to content

Commit f733587

Browse files
docs: Updated readme for deployment
2 parents b32f17a + a60f6ce commit f733587

File tree

1 file changed

+59
-0
lines changed

1 file changed

+59
-0
lines changed

docs/DeploymentGuide.md

Lines changed: 59 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -51,6 +51,65 @@ azd env set AZURE_ENV_VM_ADMIN_PASSWORD <your-password>
5151
> The WAF-aligned configuration is under active development. More Azure Well-Architected recommendations will be added in future updates.
5252
5353
---
54+
## Deployment Environment Setup
55+
56+
Pick from the options below to see step-by-step instructions for Visual Studio Code (WEB) and Local Environment:
57+
58+
<details>
59+
<summary><b>Deploy in Visual Studio Code (WEB)</b></summary>
60+
61+
### Visual Studio Code (WEB)
62+
63+
You can run this solution in VS Code Web. The button will open a web-based VS Code instance in your browser:
64+
65+
1. Open the solution accelerator (this may take several minutes):
66+
67+
[![Open in Visual Studio Code Web](https://img.shields.io/static/v1?style=for-the-badge&label=Visual%20Studio%20Code%20(Web)&message=Open&color=blue&logo=visualstudiocode&logoColor=white)](https://insiders.vscode.dev/azure/?vscode-azure-exp=foundry&agentPayload=eyJiYXNlVXJsIjogImh0dHBzOi8vcmF3LmdpdGh1YnVzZXJjb250ZW50LmNvbS9taWNyb3NvZnQvQnVpbGQteW91ci1vd24tY29waWxvdC1Tb2x1dGlvbi1BY2NlbGVyYXRvci9yZWZzL2hlYWRzL2J5b2MtcmVzZWFyY2hlci9pbmZyYS92c2NvZGVfd2ViIiwgImluZGV4VXJsIjogIi9pbmRleC5qc29uIiwgInZhcmlhYmxlcyI6IHsiYWdlbnRJZCI6ICIiLCAiY29ubmVjdGlvblN0cmluZyI6ICIiLCAidGhyZWFkSWQiOiAiIiwgInVzZXJNZXNzYWdlIjogIiIsICJwbGF5Z3JvdW5kTmFtZSI6ICIiLCAibG9jYXRpb24iOiAiIiwgInN1YnNjcmlwdGlvbklkIjogIiIsICJyZXNvdXJjZUlkIjogIiIsICJwcm9qZWN0UmVzb3VyY2VJZCI6ICIiLCAiZW5kcG9pbnQiOiAiIn0sICJjb2RlUm91dGUiOiBbImFpLXByb2plY3RzLXNkayIsICJweXRob24iLCAiZGVmYXVsdC1henVyZS1hdXRoIiwgImVuZHBvaW50Il19)
68+
69+
2. When prompted, sign in using your Microsoft account linked to your Azure subscription.
70+
71+
Select the appropriate subscription to continue.
72+
73+
4. Once the solution opens, the **AI Foundry terminal** will automatically start running the following command to install the required dependencies:
74+
75+
```shell
76+
sh install.sh
77+
```
78+
During this process, you’ll be prompted with the message:
79+
```
80+
What would you like to do with these files?
81+
- Overwrite with versions from template
82+
- Keep my existing files unchanged
83+
```
84+
Choose “**Overwrite with versions from template**” and provide a unique environment name when prompted.
85+
86+
6. Continue with the [deploying steps](#deploying-with-azd).
87+
88+
</details>
89+
90+
<details>
91+
<summary><b>Deploy in your local Environment</b></summary>
92+
93+
### Local Environment
94+
95+
1. Make sure the following tools are installed:
96+
- [PowerShell](https://learn.microsoft.com/en-us/powershell/scripting/install/installing-powershell?view=powershell-7.5) <small>(v7.0+)</small> - available for Windows, macOS, and Linux.
97+
- [Azure Developer CLI (azd)](https://aka.ms/install-azd) <small>(v1.18.0+)</small> - version
98+
- [Python 3.9 to 3.11](https://www.python.org/downloads/)
99+
- [Docker Desktop](https://www.docker.com/products/docker-desktop/)
100+
- [Git](https://git-scm.com/downloads)
101+
102+
2. Clone the repository or download the project code via command-line:
103+
104+
```shell
105+
azd init -t microsoft/build-your-own-copilot-solution-accelerator/ -b byoc-researcher
106+
```
107+
108+
3. Open the project folder in your terminal or editor.
109+
4. Continue with the [deploying steps](#deploying-with-azd).
110+
111+
</details>
112+
54113

55114
### Deploying with AZD
56115

0 commit comments

Comments
 (0)