pengjunjie/ragflow
1
0
Fork 1
mirror of https://github.com/infiniflow/ragflow.git synced 2025-12-08 20:42:30 +08:00
Code Issues Packages Projects Releases Wiki Activity

Obsoleted dev and dev-slim (#3930)

Browse Source 
### What problem does this PR solve?

Obsoleted dev and dev-slim
### Type of change

- [x] Documentation Update
This commit is contained in:
Zhichang Yu
2024-12-09 12:44:57 +08:00
committed by GitHub
parent 3d735dca87
commit aaec630759
15 changed files with 143 additions and 126 deletions
Download Patch File Download Diff File Expand all files Collapse all files

16
docs/configurations.md
View File

@ -93,8 +93,8 @@ The [.env](https://github.com/infiniflow/ragflow/blob/main/docker/.env) file con
- `RAGFLOW-IMAGE`
The Docker image edition. Available editions:
- `infiniflow/ragflow:dev-slim` (default): The RAGFlow Docker image without embedding models.
- `infiniflow/ragflow:dev`: The RAGFlow Docker image with embedding models including:
- `infiniflow/ragflow:v0.14.1-slim` (default): The RAGFlow Docker image without embedding models.
- `infiniflow/ragflow:v0.14.1`: The RAGFlow Docker image with embedding models including:
- Built-in embedding models:
- `BAAI/bge-large-zh-v1.5`
- `BAAI/bge-reranker-v2-m3`
@ -113,12 +113,12 @@ The [.env](https://github.com/infiniflow/ragflow/blob/main/docker/.env) file con
:::tip NOTE
If you cannot download the RAGFlow Docker image, try the following mirrors.
- For the `dev-slim` edition:
- `RAGFLOW_IMAGE=swr.cn-north-4.myhuaweicloud.com/infiniflow/ragflow:dev-slim` or,
- `RAGFLOW_IMAGE=registry.cn-hangzhou.aliyuncs.com/infiniflow/ragflow:dev-slim`.
- For the `dev` edition:
- `RAGFLOW_IMAGE=swr.cn-north-4.myhuaweicloud.com/infiniflow/ragflow:dev` or,
- `RAGFLOW_IMAGE=registry.cn-hangzhou.aliyuncs.com/infiniflow/ragflow:dev`.
- For the `nightly-slim` edition:
- `RAGFLOW_IMAGE=swr.cn-north-4.myhuaweicloud.com/infiniflow/ragflow:nightly-slim` or,
- `RAGFLOW_IMAGE=registry.cn-hangzhou.aliyuncs.com/infiniflow/ragflow:nightly-slim`.
- For the `nightly` edition:
- `RAGFLOW_IMAGE=swr.cn-north-4.myhuaweicloud.com/infiniflow/ragflow:nightly` or,
- `RAGFLOW_IMAGE=registry.cn-hangzhou.aliyuncs.com/infiniflow/ragflow:nightly`.
:::
### Timezone

6
docs/guides/develop/build_docker_image.mdx
View File

@ -31,7 +31,7 @@ A guide explaining how to build a RAGFlow Docker image from its source code. By
]}>
<TabItem value="without">
This image is approximately 1 GB in size and relies on external LLM and embedding services.
This image is approximately 2 GB in size and relies on external LLM and embedding services.
:::tip NOTE
While we also test RAGFlow on ARM64 platforms, we do not plan to maintain RAGFlow Docker images for ARM. However, you can build an image yourself on a `linux/arm64` or `darwin/arm64` host machine as well.
@ -40,7 +40,7 @@ While we also test RAGFlow on ARM64 platforms, we do not plan to maintain RAGFlo
```bash
git clone https://github.com/infiniflow/ragflow.git
cd ragflow/
docker build --build-arg LIGHTEN=1 -f Dockerfile -t infiniflow/ragflow:dev-slim .
docker build --build-arg LIGHTEN=1 -f Dockerfile -t infiniflow/ragflow:nightly-slim .
```
@ -56,7 +56,7 @@ While we also test RAGFlow on ARM64 platforms, we do not plan to maintain RAGFlo
```bash
git clone https://github.com/infiniflow/ragflow.git
cd ragflow/
docker build -f Dockerfile -t infiniflow/ragflow:dev .
docker build -f Dockerfile -t infiniflow/ragflow:nightly .
```
</TabItem>

22
docs/guides/upgrade_ragflow.mdx
View File

@ -7,11 +7,11 @@ slug: /upgrade_ragflow
import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';
Upgrade RAGFlow to `dev-slim`/`dev` or the latest, published release.
Upgrade RAGFlow to `nightly-slim`/`nightly` or the latest, published release.
## Upgrade RAGFlow to `dev-slim`/`dev`, the most recent, tested Docker image
## Upgrade RAGFlow to `nightly-slim`/`nightly`, the most recent, tested Docker image
`dev-slim` refers to the RAGFlow Docker image *without* embedding models, while `dev` refers to the RAGFlow Docker image with embedding models. For details on their differences, see [ragflow/docker/.env](https://github.com/infiniflow/ragflow/blob/main/docker/.env).
`nightly-slim` refers to the RAGFlow Docker image *without* embedding models, while `nightly` refers to the RAGFlow Docker image with embedding models. For details on their differences, see [ragflow/docker/.env](https://github.com/infiniflow/ragflow/blob/main/docker/.env).
To upgrade RAGFlow, you must upgrade **both** your code **and** your Docker image:
@ -24,22 +24,22 @@ To upgrade RAGFlow, you must upgrade **both** your code **and** your Docker imag
2. Update **ragflow/docker/.env**:
<Tabs
defaultValue="dev-slim"
defaultValue="nightly-slim"
values={[
{label: 'dev-slim', value: 'dev-slim'},
{label: 'dev', value: 'dev'},
{label: 'nightly-slim', value: 'nightly-slim'},
{label: 'nightly', value: 'nightly'},
]}>
<TabItem value="dev-slim">
<TabItem value="nightly-slim">
```bash
RAGFLOW_IMAGE=infiniflow/ragflow:dev-slim
RAGFLOW_IMAGE=infiniflow/ragflow:nightly-slim
```
</TabItem>
<TabItem value="dev">
<TabItem value="nightly">
```bash
RAGFLOW_IMAGE=infiniflow/ragflow:dev
RAGFLOW_IMAGE=infiniflow/ragflow:nightly
```
</TabItem>
@ -65,7 +65,7 @@ To upgrade RAGFlow, you must upgrade **both** your code **and** your Docker imag
2. Switch to the latest, officially published release, e.g., `v0.14.1`:
```bash
git checkout v0.14.1
git checkout -f v0.14.1
```
3. Update **ragflow/docker/.env** as follows:

21
docs/quickstart.mdx
View File

@ -177,20 +177,27 @@ This section provides instructions on setting up the RAGFlow server on Linux. If
```bash
$ git clone https://github.com/infiniflow/ragflow.git
$ cd ragflow
$ git checkout -f v0.14.1
```
3. Build the pre-built Docker images and start up the server:
3. Use the pre-built Docker images and start up the server:
> The command below downloads the dev version Docker image for RAGFlow slim (`dev-slim`). Note that RAGFlow slim Docker images do not include embedding models or Python libraries and hence are approximately 1GB in size.
> The command below downloads the v0.14.1 version Docker image for RAGFlow slim (`v0.14.1-slim`). Note that RAGFlow slim Docker images do not include embedding models or Python libraries and hence are approximately 2 GB in size.
```bash
$ cd ragflow/docker
$ docker compose -f docker-compose.yml up -d
$ docker compose -f docker/docker-compose.yml up -d
```
> - To download a RAGFlow slim Docker image of a specific version, update the `RAGFlOW_IMAGE` variable in **docker/.env** to your desired version. For example, `RAGFLOW_IMAGE=infiniflow/ragflow:v0.14.1-slim`. After making this change, rerun the command above to initiate the download.
> - To download the dev version of RAGFlow Docker image *including* embedding models and Python libraries, update the `RAGFlOW_IMAGE` variable in **docker/.env** to `RAGFLOW_IMAGE=infiniflow/ragflow:dev`. After making this change, rerun the command above to initiate the download.
> - To download a specific version of RAGFlow Docker image *including* embedding models and Python libraries, update the `RAGFlOW_IMAGE` variable in **docker/.env** to your desired version. For example, `RAGFLOW_IMAGE=infiniflow/ragflow:v0.14.1`. After making this change, rerun the command above to initiate the download.
| RAGFLOW_IMAGE tag in docker/.env | size | Including embedding models and related Python packages? | comments |
| -------------------------------- | ----- | ------------------------------------------------------- | ---------------------- |
| v0.14.1 | ~9 GB | YES | stable release |
| v0.14.1-slim | ~2 GB | NO | stable release |
| v0.15.0-dev1 | ~9 GB | YES | unstable beta release |
| v0.15.0-dev1-slim | ~2 GB | NO | unstable beta release |
| nightly | ~9 GB | YES | unstable nightly build |
| nightly-slim | ~2 GB | NO | unstable nightly build |
:::tip NOTE
A RAGFlow Docker image that includes embedding models and Python libraries is approximately 9GB in size and may take significantly longer time to load.

6
docs/references/faq.md
View File

@ -42,10 +42,10 @@ We officially support x86 CPU and nvidia GPU. While we also test RAGFlow on ARM6
### Which embedding models can be deployed locally?
RAGFlow offers two Docker image editions, `dev-slim` and `dev`:
RAGFlow offers two Docker image editions, `v0.14.1-slim` and `v0.14.1`:
- `infiniflow/ragflow:dev-slim` (default): The RAGFlow Docker image without embedding models.
- `infiniflow/ragflow:dev`: The RAGFlow Docker image with embedding models including:
- `infiniflow/ragflow:v0.14.1-slim` (default): The RAGFlow Docker image without embedding models.
- `infiniflow/ragflow:v0.14.1`: The RAGFlow Docker image with embedding models including:
- Built-in embedding models:
- `BAAI/bge-large-zh-v1.5`
- `BAAI/bge-reranker-v2-m3`

6
docs/release_notes.md
View File

@ -102,11 +102,11 @@ Released on September 30, 2024.
As of this release, RAGFlow offers slim editions of its Docker images to improve the experience for users with limited Internet access. A slim edition of RAGFlow's Docker image does not include built-in BGE/BCE embedding models and has a size of about 1GB; a full edition of RAGFlow is approximately 9GB and includes both built-in embedding models and embedding models that will be downloaded once you select them in the RAGFlow UI.
The default Docker image edition is `dev-slim`. The following list clarifies the differences between various editions:
The default Docker image edition is `nightly-slim`. The following list clarifies the differences between various editions:
- `dev-slim`: The slim edition of the most recent tested Docker image.
- `nightly-slim`: The slim edition of the most recent tested Docker image.
- `v0.12.0-slim`: The slim edition of the most recent **officially released** Docker image.
- `dev`: The full edition of the most recent tested Docker image.
- `nightly`: The full edition of the most recent tested Docker image.
- `v0.12.0`: The full edition of the most recent **officially released** Docker image.
See [Upgrade RAGFlow](https://ragflow.io/docs/dev/upgrade_ragflow) for instructions on upgrading.