Obsoleted dev and dev-slim (#3930)

### 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

View File

@ -165,29 +165,25 @@ releases! 🌟
$ git clone https://github.com/infiniflow/ragflow.git
```
3. Build the pre-built Docker images and start up the server:
3. Start up the server using the pre-built Docker images:
> 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
```
> - 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 |
> **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.
4. Check the server status after having the server up and running:
@ -267,12 +263,12 @@ RAGFlow uses Elasticsearch by default for storing full text and vectors. To swit
## 🔧 Build a Docker image without embedding models
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.
```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 .
```
## 🔧 Build a Docker image including embedding models
@ -282,7 +278,7 @@ This image is approximately 9 GB in size. As it includes embedding models, it re
```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 .
```
## 🔨 Launch service from source for development