You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+7-5Lines changed: 7 additions & 5 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -92,13 +92,15 @@ A more detailed [Quickstart](https://docs.docsgpt.cloud/quickstart) is available
92
92
./setup.sh
93
93
```
94
94
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.
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.
102
104
103
105
**Navigate to http://localhost:5173/**
104
106
@@ -107,7 +109,7 @@ To stop DocsGPT, open a terminal in the `DocsGPT` directory and run:
107
109
```bash
108
110
docker compose -f deployment/docker-compose.yaml down
109
111
```
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).
111
113
112
114
> [!Note]
113
115
> For development environment setup instructions, please refer to the [Development Environment Guide](https://docs.docsgpt.cloud/Deploying/Development-Environment).
Copy file name to clipboardExpand all lines: docs/pages/quickstart.mdx
+37-2Lines changed: 37 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -73,9 +73,44 @@ The easiest way to launch DocsGPT is using the provided `setup.sh` script. This
73
73
74
74
## Launching DocsGPT (Windows)
75
75
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.
77
77
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:
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.
0 commit comments