mirror of
https://github.com/arc53/DocsGPT.git
synced 2025-11-29 00:23:17 +00:00
finished
This commit is contained in:
39
README.md
39
README.md
@@ -19,10 +19,10 @@
|
|||||||
<a href="https://twitter.com/docsgptai"></a>
|
<a href="https://twitter.com/docsgptai"></a>
|
||||||
|
|
||||||
<br>
|
<br>
|
||||||
|
[⚡️ Quickstart](https://docs.docsgpt.cloud/quickstart) • [☁️ Cloud Version](https://app.docsgpt.cloud/) • [💬 Discord](https://discord.gg/n5BX8dh8rU)
|
||||||
[☁️ Cloud Version](https://app.docsgpt.cloud/) • [💬 Discord](https://discord.gg/n5BX8dh8rU) • [📖 Guides](https://docs.docsgpt.cloud/)
|
<br>
|
||||||
|
[📖 Documentation](https://docs.docsgpt.cloud/) • [👫 Contribute](https://github.com/arc53/DocsGPT/blob/main/CONTRIBUTING.md) • [🗞 Blog](https://blog.docsgpt.cloud/)
|
||||||
<br>
|
<br>
|
||||||
[👫 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)
|
|
||||||
|
|
||||||
</div>
|
</div>
|
||||||
<div align="center">
|
<div align="center">
|
||||||
@@ -35,6 +35,7 @@
|
|||||||
<li><strong>🗂️ Wide Format Support:</strong> Reads PDF, DOCX, CSV, XLSX, EPUB, MD, RST, HTML, MDX, JSON, PPTX, and images.</li>
|
<li><strong>🗂️ Wide Format Support:</strong> Reads PDF, DOCX, CSV, XLSX, EPUB, MD, RST, HTML, MDX, JSON, PPTX, and images.</li>
|
||||||
<li><strong>🌐 Web & Data Integration:</strong> Ingests from URLs, sitemaps, Reddit, GitHub and web crawlers.</li>
|
<li><strong>🌐 Web & Data Integration:</strong> Ingests from URLs, sitemaps, Reddit, GitHub and web crawlers.</li>
|
||||||
<li><strong>✅ Reliable Answers:</strong> Get accurate, hallucination-free responses with source citations viewable in a clean UI.</li>
|
<li><strong>✅ Reliable Answers:</strong> Get accurate, hallucination-free responses with source citations viewable in a clean UI.</li>
|
||||||
|
<li><strong>🔑 Streamlined API Keys:</strong> Generate keys linked to your settings, documents, and models, simplifying chatbot and integration setup.</li>
|
||||||
<li><strong>🔗 Actionable Tooling:</strong> Connect to APIs, tools, and other services to enable LLM actions.</li>
|
<li><strong>🔗 Actionable Tooling:</strong> Connect to APIs, tools, and other services to enable LLM actions.</li>
|
||||||
<li><strong>🧩 Pre-built Integrations:</strong> Use readily available HTML/React chat widgets, search tools, Discord/Telegram bots, and more.</li>
|
<li><strong>🧩 Pre-built Integrations:</strong> Use readily available HTML/React chat widgets, search tools, Discord/Telegram bots, and more.</li>
|
||||||
<li><strong>🔌 Flexible Deployment:</strong> Works with major LLMs (OpenAI, Google, Anthropic) and local models (Ollama, llama_cpp).</li>
|
<li><strong>🔌 Flexible Deployment:</strong> Works with major LLMs (OpenAI, Google, Anthropic) and local models (Ollama, llama_cpp).</li>
|
||||||
@@ -68,45 +69,39 @@ We're eager to provide personalized assistance when deploying your DocsGPT to a
|
|||||||
> [!Note]
|
> [!Note]
|
||||||
> Make sure you have [Docker](https://docs.docker.com/engine/install/) installed
|
> 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:**
|
||||||
|
|
||||||
1. Clone the repository and run the following command:
|
|
||||||
```bash
|
```bash
|
||||||
git clone https://github.com/arc53/DocsGPT.git
|
git clone https://github.com/arc53/DocsGPT.git
|
||||||
cd DocsGPT
|
cd DocsGPT
|
||||||
```
|
```
|
||||||
|
|
||||||
On Mac OS or Linux, write:
|
**For macOS and Linux:**
|
||||||
|
|
||||||
|
2. **Run the setup script:**
|
||||||
|
|
||||||
2. Run the following command:
|
|
||||||
```bash
|
```bash
|
||||||
./setup.sh
|
./setup.sh
|
||||||
```
|
```
|
||||||
|
|
||||||
It will install all the dependencies and allow you to download the local model, use OpenAI or use our LLM API.
|
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.
|
||||||
|
|
||||||
Otherwise, refer to this Guide for Windows:
|
**For Windows:**
|
||||||
|
|
||||||
On windows:
|
2. **Follow the Docker Deployment Guide:**
|
||||||
|
|
||||||
2. Create a `.env` file in your root directory and set the env variables.
|
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.
|
||||||
It should look like this inside:
|
|
||||||
|
|
||||||
```
|
**Navigate to http://localhost:5173/**
|
||||||
LLM_NAME=[docsgpt or openai or others]
|
|
||||||
API_KEY=[if LLM_NAME is openai]
|
|
||||||
```
|
|
||||||
|
|
||||||
See optional environment variables in the [/application/.env_sample](https://github.com/arc53/DocsGPT/blob/main/application/.env_sample) file.
|
To stop DocsGPT, open a terminal in the `DocsGPT` directory and run:
|
||||||
|
|
||||||
3. Run the following command:
|
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
docker compose -f deployment/docker-compose.yaml up --build
|
docker compose -f deployment/docker-compose.yaml down
|
||||||
```
|
```
|
||||||
4. Navigate to http://localhost:5173/.
|
(or use the specific `docker compose down` command shown after running `setup.sh`).
|
||||||
|
|
||||||
To stop, just run `Ctrl + C`.
|
|
||||||
|
|
||||||
> [!Note]
|
> [!Note]
|
||||||
> For development environment setup instructions, please refer to the [Development Environment Guide](https://docs.docsgpt.cloud/Deploying/Development-Environment).
|
> For development environment setup instructions, please refer to the [Development Environment Guide](https://docs.docsgpt.cloud/Deploying/Development-Environment).
|
||||||
|
|||||||
@@ -6,7 +6,7 @@ description: This step-by-step guide walks you through the process of setting up
|
|||||||
|
|
||||||
### Step 1: Prepare and Start DocsGPT
|
### 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
|
### Step 2: Get Access Token from Chatwoot
|
||||||
|
|
||||||
|
|||||||
Reference in New Issue
Block a user