Skip to content

Commit d683644

Browse files
KevinHuShJinHai-CN
KevinHuSh
and
JinHai-CN
authored
DOC: for release. (#5472)
### What problem does this PR solve? ### Type of change - [x] Documentation Update --------- Co-authored-by: Jin Hai <[email protected]>
1 parent 3b30799 commit d683644

22 files changed

+216
-221
lines changed

‎.github/workflows/tests.yml‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -65,7 +65,7 @@ jobs:
6565
6666
- name: Start ragflow:nightly-slim
6767
run: |
68-
echo "RAGFLOW_IMAGE=infiniflow/ragflow:nightly-slim" >> docker/.env
68+
echo -e "\nRAGFLOW_IMAGE=infiniflow/ragflow:nightly-slim" >> docker/.env
6969
sudo docker compose -f docker/docker-compose.yml up -d
7070
7171
- name: Stop ragflow:nightly-slim
@@ -75,7 +75,7 @@ jobs:
7575
7676
- name: Start ragflow:nightly
7777
run: |
78-
echo "RAGFLOW_IMAGE=infiniflow/ragflow:nightly" >> docker/.env
78+
echo -e "\nRAGFLOW_IMAGE=infiniflow/ragflow:nightly" >> docker/.env
7979
sudo docker compose -f docker/docker-compose.yml up -d
8080
8181
- name: Run sdk tests against Elasticsearch

‎README.md‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@
2222
<img alt="Static Badge" src="https://img.shields.io/badge/Online-Demo-4e6b99">
2323
</a>
2424
<a href="https://hub.docker.com/r/infiniflow/ragflow" target="_blank">
25-
<img src="https://img.shields.io/badge/docker_pull-ragflow:v0.16.0-brightgreen" alt="docker pull infiniflow/ragflow:v0.16.0">
25+
<img src="https://img.shields.io/badge/docker_pull-ragflow:v0.17.0-brightgreen" alt="docker pull infiniflow/ragflow:v0.17.0">
2626
</a>
2727
<a href="https://github.com/infiniflow/ragflow/releases/latest">
2828
<img src="https://img.shields.io/github/v/release/infiniflow/ragflow?color=blue&label=Latest%20Release" alt="Latest Release">
@@ -173,7 +173,7 @@ releases! 🌟
173173
174174
3. Start up the server using the pre-built Docker images:
175175
176-
> The command below downloads the `v0.16.0-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.16.0-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.16.0` for the full edition `v0.16.0`.
176+
> The command below downloads the `v0.17.0-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.17.0-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.17.0` for the full edition `v0.17.0`.
177177
178178
```bash
179179
$ cd ragflow/docker
@@ -182,8 +182,8 @@ releases! 🌟
182182
183183
| RAGFlow image tag | Image size (GB) | Has embedding models? | Stable? |
184184
|-------------------|-----------------|-----------------------|--------------------------|
185-
| v0.16.0 | &approx;9 | :heavy_check_mark: | Stable release |
186-
| v0.16.0-slim | &approx;2 | ❌ | Stable release |
185+
| v0.17.0 | &approx;9 | :heavy_check_mark: | Stable release |
186+
| v0.17.0-slim | &approx;2 | ❌ | Stable release |
187187
| nightly | &approx;9 | :heavy_check_mark: | _Unstable_ nightly build |
188188
| nightly-slim | &approx;2 | ❌ | _Unstable_ nightly build |
189189

‎README_id.md‎

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@
2222
<img alt="Lencana Daring" src="https://img.shields.io/badge/Online-Demo-4e6b99">
2323
</a>
2424
<a href="https://hub.docker.com/r/infiniflow/ragflow" target="_blank">
25-
<img src="https://img.shields.io/badge/docker_pull-ragflow:v0.16.0-brightgreen" alt="docker pull infiniflow/ragflow:v0.16.0">
25+
<img src="https://img.shields.io/badge/docker_pull-ragflow:v0.17.0-brightgreen" alt="docker pull infiniflow/ragflow:v0.17.0">
2626
</a>
2727
<a href="https://github.com/infiniflow/ragflow/releases/latest">
2828
<img src="https://img.shields.io/github/v/release/infiniflow/ragflow?color=blue&label=Rilis%20Terbaru" alt="Rilis Terbaru">
@@ -166,17 +166,17 @@ Coba demo kami di [https://demo.ragflow.io](https://demo.ragflow.io).
166166
167167
3. Bangun image Docker pre-built dan jalankan server:
168168

169-
> Perintah di bawah ini mengunduh edisi v0.16.0-slim dari gambar Docker RAGFlow. Silakan merujuk ke tabel berikut untuk deskripsi berbagai edisi RAGFlow. Untuk mengunduh edisi RAGFlow yang berbeda dari v0.16.0-slim, perbarui variabel RAGFLOW_IMAGE di docker/.env sebelum menggunakan docker compose untuk memulai server. Misalnya, atur RAGFLOW_IMAGE=infiniflow/ragflow:v0.16.0 untuk edisi lengkap v0.16.0.
169+
> Perintah di bawah ini mengunduh edisi v0.17.0-slim dari gambar Docker RAGFlow. Silakan merujuk ke tabel berikut untuk deskripsi berbagai edisi RAGFlow. Untuk mengunduh edisi RAGFlow yang berbeda dari v0.17.0-slim, perbarui variabel RAGFLOW_IMAGE di docker/.env sebelum menggunakan docker compose untuk memulai server. Misalnya, atur RAGFLOW_IMAGE=infiniflow/ragflow:v0.17.0 untuk edisi lengkap v0.17.0.
170170
171171
```bash
172172
$ cd ragflow/docker
173173
$ docker compose -f docker-compose.yml up -d
174174
```
175175

176176
| RAGFlow image tag | Image size (GB) | Has embedding models? | Stable? |
177-
|-------------------|-----------------|-----------------------|--------------------------|
178-
| v0.16.0 | &approx;9 | :heavy_check_mark: | Stable release |
179-
| v0.16.0-slim | &approx;2 | ❌ | Stable release |
177+
| ----------------- | --------------- | --------------------- | ------------------------ |
178+
| v0.17.0 | &approx;9 | :heavy_check_mark: | Stable release |
179+
| v0.17.0-slim | &approx;2 | ❌ | Stable release |
180180
| nightly | &approx;9 | :heavy_check_mark: | _Unstable_ nightly build |
181181
| nightly-slim | &approx;2 | ❌ | _Unstable_ nightly build |
182182

‎README_ja.md‎

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@
2222
<img alt="Static Badge" src="https://img.shields.io/badge/Online-Demo-4e6b99">
2323
</a>
2424
<a href="https://hub.docker.com/r/infiniflow/ragflow" target="_blank">
25-
<img src="https://img.shields.io/badge/docker_pull-ragflow:v0.16.0-brightgreen" alt="docker pull infiniflow/ragflow:v0.16.0">
25+
<img src="https://img.shields.io/badge/docker_pull-ragflow:v0.17.0-brightgreen" alt="docker pull infiniflow/ragflow:v0.17.0">
2626
</a>
2727
<a href="https://github.com/infiniflow/ragflow/releases/latest">
2828
<img src="https://img.shields.io/github/v/release/infiniflow/ragflow?color=blue&label=Latest%20Release" alt="Latest Release">
@@ -146,17 +146,17 @@
146146
147147
3. ビルド済みの Docker イメージをビルドし、サーバーを起動する:
148148

149-
> 以下のコマンドは、RAGFlow Docker イメージの v0.16.0-slim エディションをダウンロードします。異なる RAGFlow エディションの説明については、以下の表を参照してください。v0.16.0-slim とは異なるエディションをダウンロードするには、docker/.env ファイルの RAGFLOW_IMAGE 変数を適宜更新し、docker compose を使用してサーバーを起動してください。例えば、完全版 v0.16.0 をダウンロードするには、RAGFLOW_IMAGE=infiniflow/ragflow:v0.16.0 と設定します。
149+
> 以下のコマンドは、RAGFlow Docker イメージの v0.17.0-slim エディションをダウンロードします。異なる RAGFlow エディションの説明については、以下の表を参照してください。v0.17.0-slim とは異なるエディションをダウンロードするには、docker/.env ファイルの RAGFLOW_IMAGE 変数を適宜更新し、docker compose を使用してサーバーを起動してください。例えば、完全版 v0.17.0 をダウンロードするには、RAGFLOW_IMAGE=infiniflow/ragflow:v0.17.0 と設定します。
150150
151151
```bash
152152
$ cd ragflow/docker
153153
$ docker compose -f docker-compose.yml up -d
154154
```
155155

156156
| RAGFlow image tag | Image size (GB) | Has embedding models? | Stable? |
157-
|-------------------|-----------------|-----------------------|--------------------------|
158-
| v0.16.0 | &approx;9 | :heavy_check_mark: | Stable release |
159-
| v0.16.0-slim | &approx;2 | ❌ | Stable release |
157+
| ----------------- | --------------- | --------------------- | ------------------------ |
158+
| v0.17.0 | &approx;9 | :heavy_check_mark: | Stable release |
159+
| v0.17.0-slim | &approx;2 | ❌ | Stable release |
160160
| nightly | &approx;9 | :heavy_check_mark: | _Unstable_ nightly build |
161161
| nightly-slim | &approx;2 | ❌ | _Unstable_ nightly build |
162162

‎README_ko.md‎

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@
2222
<img alt="Static Badge" src="https://img.shields.io/badge/Online-Demo-4e6b99">
2323
</a>
2424
<a href="https://hub.docker.com/r/infiniflow/ragflow" target="_blank">
25-
<img src="https://img.shields.io/badge/docker_pull-ragflow:v0.16.0-brightgreen" alt="docker pull infiniflow/ragflow:v0.16.0">
25+
<img src="https://img.shields.io/badge/docker_pull-ragflow:v0.17.0-brightgreen" alt="docker pull infiniflow/ragflow:v0.17.0">
2626
</a>
2727
<a href="https://github.com/infiniflow/ragflow/releases/latest">
2828
<img src="https://img.shields.io/github/v/release/infiniflow/ragflow?color=blue&label=Latest%20Release" alt="Latest Release">
@@ -147,17 +147,17 @@
147147
148148
3. 미리 빌드된 Docker 이미지를 생성하고 서버를 시작하세요:
149149

150-
> 아래 명령어는 RAGFlow Docker 이미지의 v0.16.0-slim 버전을 다운로드합니다. 다양한 RAGFlow 버전에 대한 설명은 다음 표를 참조하십시오. v0.16.0-slim과 다른 RAGFlow 버전을 다운로드하려면, docker/.env 파일에서 RAGFLOW_IMAGE 변수를 적절히 업데이트한 후 docker compose를 사용하여 서버를 시작하십시오. 예를 들어, 전체 버전인 v0.16.0을 다운로드하려면 RAGFLOW_IMAGE=infiniflow/ragflow:v0.16.0로 설정합니다.
150+
> 아래 명령어는 RAGFlow Docker 이미지의 v0.17.0-slim 버전을 다운로드합니다. 다양한 RAGFlow 버전에 대한 설명은 다음 표를 참조하십시오. v0.17.0-slim과 다른 RAGFlow 버전을 다운로드하려면, docker/.env 파일에서 RAGFLOW_IMAGE 변수를 적절히 업데이트한 후 docker compose를 사용하여 서버를 시작하십시오. 예를 들어, 전체 버전인 v0.17.0을 다운로드하려면 RAGFLOW_IMAGE=infiniflow/ragflow:v0.17.0로 설정합니다.
151151
152152
```bash
153153
$ cd ragflow/docker
154154
$ docker compose -f docker-compose.yml up -d
155155
```
156156

157157
| RAGFlow image tag | Image size (GB) | Has embedding models? | Stable? |
158-
|-------------------|-----------------|-----------------------|--------------------------|
159-
| v0.16.0 | &approx;9 | :heavy_check_mark: | Stable release |
160-
| v0.16.0-slim | &approx;2 | ❌ | Stable release |
158+
| ----------------- | --------------- | --------------------- | ------------------------ |
159+
| v0.17.0 | &approx;9 | :heavy_check_mark: | Stable release |
160+
| v0.17.0-slim | &approx;2 | ❌ | Stable release |
161161
| nightly | &approx;9 | :heavy_check_mark: | _Unstable_ nightly build |
162162
| nightly-slim | &approx;2 | ❌ | _Unstable_ nightly build |
163163

‎README_pt_br.md‎

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@
2222
<img alt="Badge Estático" src="https://img.shields.io/badge/Online-Demo-4e6b99">
2323
</a>
2424
<a href="https://hub.docker.com/r/infiniflow/ragflow" target="_blank">
25-
<img src="https://img.shields.io/badge/docker_pull-ragflow:v0.16.0-brightgreen" alt="docker pull infiniflow/ragflow:v0.16.0">
25+
<img src="https://img.shields.io/badge/docker_pull-ragflow:v0.17.0-brightgreen" alt="docker pull infiniflow/ragflow:v0.17.0">
2626
</a>
2727
<a href="https://github.com/infiniflow/ragflow/releases/latest">
2828
<img src="https://img.shields.io/github/v/release/infiniflow/ragflow?color=blue&label=Última%20Relese" alt="Última Versão">
@@ -166,17 +166,17 @@ Experimente nossa demo em [https://demo.ragflow.io](https://demo.ragflow.io).
166166
167167
3. Inicie o servidor usando as imagens Docker pré-compiladas:
168168
169-
> O comando abaixo baixa a edição `v0.16.0-slim` da imagem Docker do RAGFlow. Consulte a tabela a seguir para descrições de diferentes edições do RAGFlow. Para baixar uma edição do RAGFlow diferente da `v0.16.0-slim`, atualize a variável `RAGFLOW_IMAGE` conforme necessário no **docker/.env** antes de usar `docker compose` para iniciar o servidor. Por exemplo: defina `RAGFLOW_IMAGE=infiniflow/ragflow:v0.16.0` para a edição completa `v0.16.0`.
169+
> O comando abaixo baixa a edição `v0.17.0-slim` da imagem Docker do RAGFlow. Consulte a tabela a seguir para descrições de diferentes edições do RAGFlow. Para baixar uma edição do RAGFlow diferente da `v0.17.0-slim`, atualize a variável `RAGFLOW_IMAGE` conforme necessário no **docker/.env** antes de usar `docker compose` para iniciar o servidor. Por exemplo: defina `RAGFLOW_IMAGE=infiniflow/ragflow:v0.17.0` para a edição completa `v0.17.0`.
170170
171171
```bash
172172
$ cd ragflow/docker
173173
$ docker compose -f docker-compose.yml up -d
174174
```
175175
176176
| Tag da imagem RAGFlow | Tamanho da imagem (GB) | Possui modelos de incorporação? | Estável? |
177-
|-----------------------|------------------------|---------------------------------|--------------------------|
178-
| v0.16.0 | ~9 | :heavy_check_mark: | Lançamento estável |
179-
| v0.16.0-slim | ~2 | ❌ | Lançamento estável |
177+
| --------------------- | ---------------------- | ------------------------------- | ------------------------ |
178+
| v0.17.0 | ~9 | :heavy_check_mark: | Lançamento estável |
179+
| v0.17.0-slim | ~2 | ❌ | Lançamento estável |
180180
| nightly | ~9 | :heavy_check_mark: | _Instável_ build noturno |
181181
| nightly-slim | ~2 | ❌ | _Instável_ build noturno |
182182

‎README_tzh.md‎

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@
2121
<img alt="Static Badge" src="https://img.shields.io/badge/Online-Demo-4e6b99">
2222
</a>
2323
<a href="https://hub.docker.com/r/infiniflow/ragflow" target="_blank">
24-
<img src="https://img.shields.io/badge/docker_pull-ragflow:v0.16.0-brightgreen" alt="docker pull infiniflow/ragflow:v0.16.0">
24+
<img src="https://img.shields.io/badge/docker_pull-ragflow:v0.17.0-brightgreen" alt="docker pull infiniflow/ragflow:v0.17.0">
2525
</a>
2626
<a href="https://github.com/infiniflow/ragflow/releases/latest">
2727
<img src="https://img.shields.io/github/v/release/infiniflow/ragflow?color=blue&label=Latest%20Release" alt="Latest Release">
@@ -145,17 +145,17 @@
145145
146146
3. 進入 **docker** 資料夾，利用事先編譯好的 Docker 映像啟動伺服器：
147147

148-
> 執行以下指令會自動下載 RAGFlow slim Docker 映像 `v0.16.0-slim`。請參考下表查看不同 Docker 發行版的說明。如需下載不同於 `v0.16.0-slim` 的 Docker 映像，請在執行 `docker compose` 啟動服務之前先更新 **docker/.env** 檔案內的 `RAGFLOW_IMAGE` 變數。例如，你可以透過設定 `RAGFLOW_IMAGE=infiniflow/ragflow:v0.16.0` 來下載 RAGFlow 鏡像的 `v0.16.0` 完整發行版。
148+
> 執行以下指令會自動下載 RAGFlow slim Docker 映像 `v0.17.0-slim`。請參考下表查看不同 Docker 發行版的說明。如需下載不同於 `v0.17.0-slim` 的 Docker 映像，請在執行 `docker compose` 啟動服務之前先更新 **docker/.env** 檔案內的 `RAGFLOW_IMAGE` 變數。例如，你可以透過設定 `RAGFLOW_IMAGE=infiniflow/ragflow:v0.17.0` 來下載 RAGFlow 鏡像的 `v0.17.0` 完整發行版。
149149
150150
```bash
151151
$ cd ragflow/docker
152152
$ docker compose -f docker-compose.yml up -d
153153
```
154154

155155
| RAGFlow image tag | Image size (GB) | Has embedding models? | Stable? |
156-
|-------------------|-----------------|-----------------------|--------------------------|
157-
| v0.16.0 | &approx;9 | :heavy_check_mark: | Stable release |
158-
| v0.16.0-slim | &approx;2 | ❌ | Stable release |
156+
| ----------------- | --------------- | --------------------- | ------------------------ |
157+
| v0.17.0 | &approx;9 | :heavy_check_mark: | Stable release |
158+
| v0.17.0-slim | &approx;2 | ❌ | Stable release |
159159
| nightly | &approx;9 | :heavy_check_mark: | _Unstable_ nightly build |
160160
| nightly-slim | &approx;2 | ❌ | _Unstable_ nightly build |
161161

‎README_zh.md‎

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@
2222
<img alt="Static Badge" src="https://img.shields.io/badge/Online-Demo-4e6b99">
2323
</a>
2424
<a href="https://hub.docker.com/r/infiniflow/ragflow" target="_blank">
25-
<img src="https://img.shields.io/badge/docker_pull-ragflow:v0.16.0-brightgreen" alt="docker pull infiniflow/ragflow:v0.16.0">
25+
<img src="https://img.shields.io/badge/docker_pull-ragflow:v0.17.0-brightgreen" alt="docker pull infiniflow/ragflow:v0.17.0">
2626
</a>
2727
<a href="https://github.com/infiniflow/ragflow/releases/latest">
2828
<img src="https://img.shields.io/github/v/release/infiniflow/ragflow?color=blue&label=Latest%20Release" alt="Latest Release">
@@ -146,17 +146,17 @@
146146
147147
3. 进入 **docker** 文件夹，利用提前编译好的 Docker 镜像启动服务器：
148148

149-
> 运行以下命令会自动下载 RAGFlow slim Docker 镜像 `v0.16.0-slim`。请参考下表查看不同 Docker 发行版的描述。如需下载不同于 `v0.16.0-slim` 的 Docker 镜像，请在运行 `docker compose` 启动服务之前先更新 **docker/.env** 文件内的 `RAGFLOW_IMAGE` 变量。比如，你可以通过设置 `RAGFLOW_IMAGE=infiniflow/ragflow:v0.16.0` 来下载 RAGFlow 镜像的 `v0.16.0` 完整发行版。
149+
> 运行以下命令会自动下载 RAGFlow slim Docker 镜像 `v0.17.0-slim`。请参考下表查看不同 Docker 发行版的描述。如需下载不同于 `v0.17.0-slim` 的 Docker 镜像，请在运行 `docker compose` 启动服务之前先更新 **docker/.env** 文件内的 `RAGFLOW_IMAGE` 变量。比如，你可以通过设置 `RAGFLOW_IMAGE=infiniflow/ragflow:v0.17.0` 来下载 RAGFlow 镜像的 `v0.17.0` 完整发行版。
150150
151151
```bash
152152
$ cd ragflow/docker
153153
$ docker compose -f docker-compose.yml up -d
154154
```
155155

156156
| RAGFlow image tag | Image size (GB) | Has embedding models? | Stable? |
157-
|-------------------|-----------------|-----------------------|--------------------------|
158-
| v0.16.0 | &approx;9 | :heavy_check_mark: | Stable release |
159-
| v0.16.0-slim | &approx;2 | ❌ | Stable release |
157+
| ----------------- | --------------- | --------------------- | ------------------------ |
158+
| v0.17.0 | &approx;9 | :heavy_check_mark: | Stable release |
159+
| v0.17.0-slim | &approx;2 | ❌ | Stable release |
160160
| nightly | &approx;9 | :heavy_check_mark: | _Unstable_ nightly build |
161161
| nightly-slim | &approx;2 | ❌ | _Unstable_ nightly build |
162162

0 commit comments

Comments
 (0)