Skip to content

Commit 493dc86

Browse files
committed
guide-updates
1 parent 1223fd2 commit 493dc86

File tree

2 files changed

+44
-7
lines changed

2 files changed

+44
-7
lines changed

README.md

Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -92,13 +92,15 @@ A more detailed [Quickstart](https://docs.docsgpt.cloud/quickstart) is available
9292
./setup.sh
9393
```
9494

95-
This interactive script will guide you through setting up DocsGPT. It offers four options: using the public API, running locally, connecting to a local inference engine, or using a cloud API provider. The script will automatically configure your `.env` file and handle necessary downloads and installations based on your chosen option.
96-
9795
**For Windows:**
9896

99-
2. **Follow the Docker Deployment Guide:**
97+
2. **Run the PowerShell setup script:**
98+
99+
```powershell
100+
PowerShell -ExecutionPolicy Bypass -File .\setup.ps1
101+
```
100102

101-
Please refer to the [Docker Deployment documentation](https://docs.docsgpt.cloud/Deploying/Docker-Deploying) for detailed step-by-step instructions on setting up DocsGPT using Docker.
103+
Either script will guide you through setting up DocsGPT. Four options available: using the public API, running locally, connecting to a local inference engine, or using a cloud API provider. Scripts will automatically configure your `.env` file and handle necessary downloads and installations based on your chosen option.
102104

103105
**Navigate to http://localhost:5173/**
104106

@@ -107,7 +109,7 @@ To stop DocsGPT, open a terminal in the `DocsGPT` directory and run:
107109
```bash
108110
docker compose -f deployment/docker-compose.yaml down
109111
```
110-
(or use the specific `docker compose down` command shown after running `setup.sh`).
112+
(or use the specific `docker compose down` command shown after running the setup script).
111113

112114
> [!Note]
113115
> For development environment setup instructions, please refer to the [Development Environment Guide](https://docs.docsgpt.cloud/Deploying/Development-Environment).

docs/pages/quickstart.mdx

Lines changed: 37 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -73,9 +73,44 @@ The easiest way to launch DocsGPT is using the provided `setup.sh` script. This
7373

7474
## Launching DocsGPT (Windows)
7575

76-
For Windows users, we recommend following the Docker deployment guide for detailed instructions. Please refer to the [Docker Deployment documentation](/Deploying/Docker-Deploying) for step-by-step instructions on setting up DocsGPT on Windows using Docker.
76+
For Windows users, we provide a PowerShell script that offers the same functionality as the macOS/Linux setup script.
7777

78-
**Important for Windows:** Ensure Docker Desktop is installed and running correctly on your Windows system before proceeding.
78+
**Steps:**
79+
80+
1. **Download the DocsGPT Repository:**
81+
82+
First, you need to download the DocsGPT repository to your local machine. You can do this using Git:
83+
84+
```powershell
85+
git clone https://github.com/arc53/DocsGPT.git
86+
cd DocsGPT
87+
```
88+
89+
2. **Run the `setup.ps1` script:**
90+
91+
Execute the PowerShell setup script:
92+
93+
```powershell
94+
PowerShell -ExecutionPolicy Bypass -File .\setup.ps1
95+
```
96+
97+
3. **Follow the interactive setup:**
98+
99+
Just like the Linux/macOS script, the PowerShell script will guide you through setting DocsGPT.
100+
The script will handle environment configuration and start DocsGPT based on your selections.
101+
102+
4. **Access DocsGPT in your browser:**
103+
104+
Once the setup is complete and Docker containers are running, navigate to [http://localhost:5173/](http://localhost:5173/) in your web browser to access the DocsGPT web application.
105+
106+
5. **Stopping DocsGPT:**
107+
108+
To stop DocsGPT run the Docker Compose down command displayed at the end of the setup script's execution.
109+
110+
**Important for Windows:** Ensure Docker Desktop is installed and running correctly on your Windows system before proceeding. The script will attempt to start Docker if it's not running, but you may need to start it manually if there are issues.
111+
112+
**Alternative Method:**
113+
If you prefer a more manual approach, you can follow our [Docker Deployment documentation](/Deploying/Docker-Deploying) for detailed instructions on setting up DocsGPT on Windows using Docker commands directly.
79114

80115
## Advanced Configuration
81116

0 commit comments

Comments
 (0)