Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Moved the Upgrade Manuel out of FAQ #3131

Merged
merged 3 commits into from
Oct 31, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
43 changes: 43 additions & 0 deletions docs/guides/upgrade_ragflow.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,43 @@
---
sidebar_position: 7
slug: /upgrade_ragflow
---

# Upgrade RAGFlow

You can upgrade RAGFlow to dev version or the latest version:

- Dev versions are for developers and contributors. They are published on a nightly basis and may crash because they are not fully tested. We cannot guarantee their validity and you are at your own risk trying out latest, untested features.
- The latest version refers to the most recent, officially published release. It is stable and works best with regular users.

To upgrade RAGFlow to the dev version:

Update the RAGFlow image and restart RAGFlow:

1. Update **ragflow/docker/.env** as follows:

```bash
RAGFLOW_IMAGE=infiniflow/ragflow:dev
```

2. Update RAGFlow image and restart RAGFlow:

```bash
docker compose -f docker/docker-compose.yml pull
docker compose -f docker/docker-compose.yml up -d
```

To upgrade RAGFlow to the latest version:

1. Update **ragflow/docker/.env** as follows:

```bash
RAGFLOW_IMAGE=infiniflow/ragflow:latest
```

2. Update the RAGFlow image and restart RAGFlow:

```bash
docker compose -f docker/docker-compose.yml pull
docker compose -f docker/docker-compose.yml up -d
```
14 changes: 9 additions & 5 deletions docs/quickstart.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -351,13 +351,17 @@ Conversations in RAGFlow are based on a particular knowledge base or multiple kn

4. Update **Model Setting**.

5. RAGFlow also offers conversation APIs. Hover over your dialogue **>** **Chat Bot API** to integrate RAGFlow's chat capabilities into your applications:

![chatbot api](https://github.com/infiniflow/ragflow/assets/93570324/fec23715-f9af-4ac2-81e5-942c5035c5e6)

6. Now, let's start the show:
5. Now, let's start the show:

![question1](https://github.com/infiniflow/ragflow/assets/93570324/bb72dd67-b35e-4b2a-87e9-4e4edbd6e677)

![question2](https://github.com/infiniflow/ragflow/assets/93570324/7cc585ae-88d0-4aa2-817d-0370b2ad7230)


:::tip NOTE
RAGFlow also offers HTTP and Python APIs for you to integrate RAGFlow's capabilities into your applications. Read the following documents for more information:

- [Acquire a RAGFlow API key](./guides/develop/acquire_ragflow_api_key.md)
- [HTTP API reference](./references/http_api_reference.md)
- [Python API reference](./references/python_api_reference.md)
:::
6 changes: 3 additions & 3 deletions docs/references/http_api_reference.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ slug: /http_api_reference

# HTTP API Reference

This document provides a complete reference for RAGFlow's RESTful API. Before proceeding, please ensure you [have your RAGFlow API key ready for authentication](../guides/develop/acquire_ragflow_api_key.md).
A complete reference for RAGFlow's RESTful API. Before proceeding, please ensure you [have your RAGFlow API key ready for authentication](../guides/develop/acquire_ragflow_api_key.md).

---

Expand Down Expand Up @@ -1135,8 +1135,8 @@ Updates content or configurations for a specified chunk.
- `'Authorization: Bearer <YOUR_API_KEY>'`
- Body:
- `"content"`: `string`
- `"important_keywords"`: `string`
- `"available"`: `integer`
- `"important_keywords"`: `list[string]`
- `"available"`: `boolean`

#### Request example

Expand Down
2 changes: 1 addition & 1 deletion docs/references/python_api_reference.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ slug: /python_api_reference

# Python API Reference

This document offers a complete reference for RAGFlow's Python APIs. Before proceeding, please ensure you [have your RAGFlow API key ready for authentication](../guides/develop/acquire_ragflow_api_key.md).
A complete reference for RAGFlow's Python APIs. Before proceeding, please ensure you [have your RAGFlow API key ready for authentication](../guides/develop/acquire_ragflow_api_key.md).

---

Expand Down