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

Docs: Removed descriptions of the slim edition. (#11192)

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

### Type of change

- [x] Documentation Update
This commit is contained in:
writinwaters
2025-11-12 11:34:45 +08:00
committed by GitHub
parent 27211a9b34
commit 39120d49cf
5 changed files with 9 additions and 61 deletions
Download Patch File Download Diff File Expand all files Collapse all files

9
docs/configurations.md
View File

@ -97,14 +97,7 @@ RAGFlow utilizes MinIO as its object storage solution, leveraging its scalabilit
- `SVR_HTTP_PORT` - `SVR_HTTP_PORT`
The port used to expose RAGFlow's HTTP API service to the host machine, allowing **external** access to the service running inside the Docker container. Defaults to `9380`. The port used to expose RAGFlow's HTTP API service to the host machine, allowing **external** access to the service running inside the Docker container. Defaults to `9380`.
- `RAGFLOW-IMAGE` - `RAGFLOW-IMAGE`
The Docker image edition. Available editions: The Docker image edition. Defaults to `infiniflow/ragflow:v0.21.1` (the RAGFlow Docker image without embedding models).
- `infiniflow/ragflow:v0.21.1-slim` (default): The RAGFlow Docker image without embedding models.
- `infiniflow/ragflow:v0.21.1`: The RAGFlow Docker image with embedding models including:
- Built-in embedding models:
- `BAAI/bge-large-zh-v1.5`
- `maidalun1020/bce-embedding-base_v1`
:::tip NOTE :::tip NOTE
If you cannot download the RAGFlow Docker image, try the following mirrors. If you cannot download the RAGFlow Docker image, try the following mirrors.

6
docs/develop/launch_ragflow_from_source.md
View File

@ -42,11 +42,7 @@ cd ragflow/
``` ```
2. Install Python dependencies: 2. Install Python dependencies:
- slim:
```bash
uv sync --python 3.10 # install RAGFlow dependent python modules
```
- full:
```bash ```bash
uv sync --python 3.10 # install RAGFlow dependent python modules uv sync --python 3.10 # install RAGFlow dependent python modules
``` ```

25
docs/faq.mdx
View File

@ -26,27 +26,9 @@ The "garbage in garbage out" status quo remains unchanged despite the fact that
--- ---
### Differences between RAGFlow full edition and RAGFlow slim edition?
Each RAGFlow release is available in two editions:
- **Slim edition**: excludes built-in embedding models and is identified by a **-slim** suffix added to the version name. Example: `infiniflow/ragflow:v0.21.1-slim`
- **Full edition**: includes built-in embedding models and has no suffix added to the version name. Example: `infiniflow/ragflow:v0.21.1`
Note: Starting with `v0.22.0`, we ship only the slim edition and no longer append the **-slim** suffix to the image tag.
---
### Which embedding models can be deployed locally? ### Which embedding models can be deployed locally?
RAGFlow offers two Docker image editions, `v0.21.1-slim` and `v0.21.1`: Starting from `v0.22.0`, we ship only the slim edition and no longer append the **-slim** suffix to the image tag.
- `infiniflow/ragflow:v0.21.1-slim` (default): The RAGFlow Docker image without embedding models.
- `infiniflow/ragflow:v0.21.1`: The RAGFlow Docker image with the following built-in embedding models:
- `BAAI/bge-large-zh-v1.5`
- `maidalun1020/bce-embedding-base_v1`
Note: Starting with `v0.22.0`, we ship only the slim edition and no longer append the **-slim** suffix to the image tag.
--- ---
@ -65,7 +47,7 @@ If you build RAGFlow from source, the version number is also in the system log:
/ _, _// ___ |/ /_/ // __/ / // /_/ /| |/ |/ / / _, _// ___ |/ /_/ // __/ / // /_/ /| |/ |/ /
/_/ |_|/_/ |_|\____//_/ /_/ \____/ |__/|__/ /_/ |_|/_/ |_|\____//_/ /_/ \____/ |__/|__/
2025-02-18 10:10:43,835 INFO 1445658 RAGFlow version: v0.15.0-50-g6daae7f2 full 2025-02-18 10:10:43,835 INFO 1445658 RAGFlow version: v0.15.0-50-g6daae7f2
``` ```
Where: Where:
@ -73,9 +55,6 @@ Where:
- `v0.15.0`: The officially published release. - `v0.15.0`: The officially published release.
- `50`: The number of git commits since the official release. - `50`: The number of git commits since the official release.
- `g6daae7f2`: `g` is the prefix, and `6daae7f2` is the first seven characters of the current commit ID. - `g6daae7f2`: `g` is the prefix, and `6daae7f2` is the first seven characters of the current commit ID.
- `full`/`slim`: The RAGFlow edition.
- `full`: The full RAGFlow edition.
- `slim`: The RAGFlow edition without embedding models and Python packages.
--- ---

15
docs/quickstart.mdx
View File

@ -189,10 +189,6 @@ This section provides instructions on setting up the RAGFlow server on Linux. If
3. Use the pre-built Docker images and start up the server: 3. Use the pre-built Docker images and start up the server:
:::tip NOTE
The command below downloads the `v0.21.1-slim` edition of the RAGFlow Docker image. Refer to the following table for descriptions of different RAGFlow editions. To download a RAGFlow edition different from `v0.21.1-slim`, update the `RAGFLOW_IMAGE` variable accordingly in **docker/.env** before using `docker compose` to start the server. For example: set `RAGFLOW_IMAGE=infiniflow/ragflow:v0.21.1` for the full edition `v0.21.1`.
:::
```bash ```bash
# Use CPU for embedding and DeepDoc tasks: # Use CPU for embedding and DeepDoc tasks:
$ docker compose -f docker-compose.yml up -d $ docker compose -f docker-compose.yml up -d
@ -202,11 +198,10 @@ This section provides instructions on setting up the RAGFlow server on Linux. If
<APITable> <APITable>
``` ```
| RAGFlow image tag | Image size (GB) | Has embedding models and Python packages? | Stable? | | RAGFlow image tag | Image size (GB) | Stable? |
| ------------------- | --------------- | ----------------------------------------- | ------------------------ | | ------------------- | --------------- | ------------------------ |
| v0.21.1 | &approx;9 | ✔️ | Stable release | | v0.21.1 | &approx;2 | Stable release |
| v0.21.1-slim | &approx;2 | ❌ | Stable release | | nightly | &approx;2 | _Unstable_ nightly build |
| nightly | &approx;2 | ❌ | _Unstable_ nightly build |
```mdx-code-block ```mdx-code-block
</APITable> </APITable>
@ -222,7 +217,7 @@ These two embedding models are optimized specifically for English and Chinese, s
::: :::
:::tip NOTE :::tip NOTE
The image size shown refers to the size of the *downloaded* Docker image, which is compressed. When Docker runs the image, it unpacks it, resulting in significantly greater disk usage. For example, a slim edition image will expand to around 7 GB once unpacked. The image size shown refers to the size of the *downloaded* Docker image, which is compressed. When Docker runs the image, it unpacks it, resulting in significantly greater disk usage. A Docker image will expand to around 7 GB once unpacked.
::: :::
4. Check the server status after having the server up and running: 4. Check the server status after having the server up and running:

15
docs/release_notes.md
View File

@ -7,21 +7,6 @@ slug: /release_notes
Key features, improvements and bug fixes in the latest releases. Key features, improvements and bug fixes in the latest releases.
:::info
Each RAGFlow release is available in two editions:
- **Slim edition**: excludes built-in embedding models and is identified by a **-slim** suffix added to the version name. Example: `infiniflow/ragflow:v0.21.1-slim`
- **Full edition**: includes built-in embedding models and has no suffix added to the version name. Example: `infiniflow/ragflow:v0.21.1`
:::
:::danger IMPORTANT
The embedding models included in a full edition are:
- BAAI/bge-large-zh-v1.5
- maidalun1020/bce-embedding-base_v1
These two embedding models are optimized specifically for English and Chinese, so performance may be compromised if you use them to embed documents in other languages.
:::
## v0.21.1 ## v0.21.1
Released on October 23, 2025. Released on October 23, 2025.