diff --git a/README.md b/README.md index 0ae8ec99..56816a6c 100644 --- a/README.md +++ b/README.md @@ -19,10 +19,10 @@ ![X (formerly Twitter) URL](https://img.shields.io/twitter/follow/docsgptai)
- - [☁️ Cloud Version](https://app.docsgpt.cloud/) • [💬 Discord](https://discord.gg/n5BX8dh8rU) • [📖 Guides](https://docs.docsgpt.cloud/) + [⚡️ Quickstart](https://docs.docsgpt.cloud/quickstart) • [☁️ Cloud Version](https://app.docsgpt.cloud/) • [💬 Discord](https://discord.gg/n5BX8dh8rU) +
+ [📖 Documentation](https://docs.docsgpt.cloud/) • [👫 Contribute](https://github.com/arc53/DocsGPT/blob/main/CONTRIBUTING.md) • [🗞 Blog](https://blog.docsgpt.cloud/)
- [👫 Contribute](https://github.com/arc53/DocsGPT/blob/main/CONTRIBUTING.md) • [🏠 Self-host](https://docs.docsgpt.cloud/Guides/How-to-use-different-LLM) • [⚡️ Quickstart](https://github.com/arc53/DocsGPT#quickstart)
@@ -35,6 +35,7 @@
  • 🗂️ Wide Format Support: Reads PDF, DOCX, CSV, XLSX, EPUB, MD, RST, HTML, MDX, JSON, PPTX, and images.
  • 🌐 Web & Data Integration: Ingests from URLs, sitemaps, Reddit, GitHub and web crawlers.
  • ✅ Reliable Answers: Get accurate, hallucination-free responses with source citations viewable in a clean UI.
  • +
  • 🔑 Streamlined API Keys: Generate keys linked to your settings, documents, and models, simplifying chatbot and integration setup.
  • 🔗 Actionable Tooling: Connect to APIs, tools, and other services to enable LLM actions.
  • 🧩 Pre-built Integrations: Use readily available HTML/React chat widgets, search tools, Discord/Telegram bots, and more.
  • 🔌 Flexible Deployment: Works with major LLMs (OpenAI, Google, Anthropic) and local models (Ollama, llama_cpp).
  • @@ -68,45 +69,39 @@ We're eager to provide personalized assistance when deploying your DocsGPT to a > [!Note] > Make sure you have [Docker](https://docs.docker.com/engine/install/) installed +A more detailed [Quickstart](https://docs.docsgpt.cloud/quickstart) is available in our documentation -1. Clone the repository and run the following command: - ```bash - git clone https://github.com/arc53/DocsGPT.git - cd DocsGPT - ``` +1. **Clone the repository:** -On Mac OS or Linux, write: - - -2. Run the following command: - ```bash - ./setup.sh - ``` - -It will install all the dependencies and allow you to download the local model, use OpenAI or use our LLM API. - -Otherwise, refer to this Guide for Windows: - -On windows: - -2. Create a `.env` file in your root directory and set the env variables. - It should look like this inside: - - ``` - LLM_NAME=[docsgpt or openai or others] - API_KEY=[if LLM_NAME is openai] + ```bash + git clone https://github.com/arc53/DocsGPT.git + cd DocsGPT ``` - See optional environment variables in the [/application/.env_sample](https://github.com/arc53/DocsGPT/blob/main/application/.env_sample) file. +**For macOS and Linux:** -3. Run the following command: +2. **Run the setup script:** - ```bash - docker compose -f deployment/docker-compose.yaml up --build - ``` -4. Navigate to http://localhost:5173/. + ```bash + ./setup.sh + ``` -To stop, just run `Ctrl + C`. +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:** + + 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. + +**Navigate to http://localhost:5173/** + +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`). > [!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/Extensions/Chatwoot-extension.mdx b/docs/pages/Extensions/Chatwoot-extension.mdx index 762e1784..68abc949 100644 --- a/docs/pages/Extensions/Chatwoot-extension.mdx +++ b/docs/pages/Extensions/Chatwoot-extension.mdx @@ -6,7 +6,7 @@ description: This step-by-step guide walks you through the process of setting up ### Step 1: Prepare and Start DocsGPT -- **Launch DocsGPT**: Follow the instructions in our [DocsGPT Wiki](https://github.com/arc53/DocsGPT/wiki) to start DocsGPT. Make sure to load your documentation. +- **Launch DocsGPT**: Follow the instructions in our [Quickstart](/quickstart) to start DocsGPT. Make sure to load your documentation. ### Step 2: Get Access Token from Chatwoot