From 493dc8689ceba40bb0b4c79c5a0fd6b8d21291e7 Mon Sep 17 00:00:00 2001 From: Pavel Date: Sat, 5 Apr 2025 17:49:56 +0400 Subject: [PATCH] guide-updates --- README.md | 12 +++++++----- docs/pages/quickstart.mdx | 39 +++++++++++++++++++++++++++++++++++++-- 2 files changed, 44 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index 4c0953a3..caf0b367 100644 --- a/README.md +++ b/README.md @@ -92,13 +92,15 @@ A more detailed [Quickstart](https://docs.docsgpt.cloud/quickstart) is available ./setup.sh ``` -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. - **For Windows:** -2. **Follow the Docker Deployment Guide:** +2. **Run the PowerShell setup script:** - 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. + ```powershell + PowerShell -ExecutionPolicy Bypass -File .\setup.ps1 + ``` + +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. **Navigate to http://localhost:5173/** @@ -107,7 +109,7 @@ To stop DocsGPT, open a terminal in the `DocsGPT` directory and run: ```bash docker compose -f deployment/docker-compose.yaml down ``` -(or use the specific `docker compose down` command shown after running `setup.sh`). +(or use the specific `docker compose down` command shown after running the setup script). > [!Note] > For development environment setup instructions, please refer to the [Development Environment Guide](https://docs.docsgpt.cloud/Deploying/Development-Environment). diff --git a/docs/pages/quickstart.mdx b/docs/pages/quickstart.mdx index cef1cd68..11a17895 100644 --- a/docs/pages/quickstart.mdx +++ b/docs/pages/quickstart.mdx @@ -73,9 +73,44 @@ The easiest way to launch DocsGPT is using the provided `setup.sh` script. This ## Launching DocsGPT (Windows) -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. +For Windows users, we provide a PowerShell script that offers the same functionality as the macOS/Linux setup script. -**Important for Windows:** Ensure Docker Desktop is installed and running correctly on your Windows system before proceeding. +**Steps:** + +1. **Download the DocsGPT Repository:** + + First, you need to download the DocsGPT repository to your local machine. You can do this using Git: + + ```powershell + git clone https://github.com/arc53/DocsGPT.git + cd DocsGPT + ``` + +2. **Run the `setup.ps1` script:** + + Execute the PowerShell setup script: + + ```powershell + PowerShell -ExecutionPolicy Bypass -File .\setup.ps1 + ``` + +3. **Follow the interactive setup:** + + Just like the Linux/macOS script, the PowerShell script will guide you through setting DocsGPT. + The script will handle environment configuration and start DocsGPT based on your selections. + +4. **Access DocsGPT in your browser:** + + 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. + +5. **Stopping DocsGPT:** + + To stop DocsGPT run the Docker Compose down command displayed at the end of the setup script's execution. + +**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. + +**Alternative Method:** +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. ## Advanced Configuration