Commit 
							
							·
						
						847f564
	
1
								Parent(s):
							
							3f2f804
								
Refactor README on different docker version. (#2775)
Browse files### What problem does this PR solve?
1. Use two env files for slim and full docker image.
2. Update README
### Type of change
- [x] Documentation Update
- [x] Refactoring
---------
Signed-off-by: Jin Hai <[email protected]>
Co-authored-by: writinwaters <[email protected]>
- README_zh.md +3 -4
- docker/.env +30 -8
    	
        README_zh.md
    CHANGED
    
    | @@ -140,10 +140,9 @@ | |
| 140 | 
             
               $ docker compose -f docker-compose.yml up -d
         | 
| 141 | 
             
               ```
         | 
| 142 |  | 
| 143 | 
            -
               >  | 
| 144 | 
            -
             | 
| 145 | 
            -
                | 
| 146 | 
            -
             | 
| 147 | 
             
            4. 服务器启动成功后再次确认服务器状态:
         | 
| 148 |  | 
| 149 | 
             
               ```bash
         | 
|  | |
| 140 | 
             
               $ docker compose -f docker-compose.yml up -d
         | 
| 141 | 
             
               ```
         | 
| 142 |  | 
| 143 | 
            +
               > 运行上述命令会自动下载 RAGFlow 的 dev-slim 版本的 Docker 镜像,该镜像并不包含 embedding 模型以及一些 Python 库,因此镜像大小约 1GB。如果你想下载并运行特定版本的 Docker 镜像,请在 docker/slim.env 文件中找到 RAGFLOW_IMAGE 变量,将其改为对应版本。例如 `RAGFLOW_IMAGE=infiniflow/ragflow:v0.12.0-slim`,然后再运行上述命令。
         | 
| 144 | 
            +
               > 如果您想安装内置 embedding 模型的 dev 版本的 docker 镜像,需要把docker/.env文件中 RAGFLOW_IMAGE 变量,这样的修改: `RAGFLOW_IMAGE=infiniflow/ragflow:dev`。如果您想指定指定特定版本,则可以修改为:`RAGFLOW_IMAGE=infiniflow/ragflow:v0.12.0`。修改后,再运行上面的命令。注意 dev 版本的 RAGFlow Docker image 大小约 9 GB,可能需要一定时间下载,请耐心等待。
         | 
| 145 | 
            +
               
         | 
|  | |
| 146 | 
             
            4. 服务器启动成功后再次确认服务器状态:
         | 
| 147 |  | 
| 148 | 
             
               ```bash
         | 
    	
        docker/.env
    CHANGED
    
    | @@ -1,7 +1,6 @@ | |
| 1 | 
             
            # Version of Elastic products
         | 
| 2 | 
             
            STACK_VERSION=8.11.3
         | 
| 3 |  | 
| 4 | 
            -
             | 
| 5 | 
             
            # Port to expose Elasticsearch HTTP API to the host
         | 
| 6 | 
             
            ES_PORT=1200
         | 
| 7 |  | 
| @@ -13,11 +12,10 @@ KIBANA_PORT=6601 | |
| 13 | 
             
            KIBANA_USER=rag_flow
         | 
| 14 | 
             
            KIBANA_PASSWORD=infini_rag_flow
         | 
| 15 |  | 
| 16 | 
            -
            #  | 
| 17 |  | 
| 18 | 
             
            MEM_LIMIT=8073741824
         | 
| 19 |  | 
| 20 | 
            -
             | 
| 21 | 
             
            MYSQL_PASSWORD=infini_rag_flow
         | 
| 22 | 
             
            MYSQL_PORT=5455
         | 
| 23 |  | 
| @@ -33,21 +31,45 @@ REDIS_PASSWORD=infini_rag_flow | |
| 33 |  | 
| 34 | 
             
            SVR_HTTP_PORT=9380
         | 
| 35 |  | 
|  | |
| 36 | 
             
            RAGFLOW_IMAGE=infiniflow/ragflow:dev-slim
         | 
| 37 |  | 
| 38 | 
            -
            # If  | 
| 39 | 
             
            # RAGFLOW_IMAGE=swr.cn-north-4.myhuaweicloud.com/infiniflow/ragflow:dev-slim
         | 
| 40 | 
             
            # RAGFLOW_IMAGE=registry.cn-hangzhou.aliyuncs.com/infiniflow/ragflow:dev-slim
         | 
| 41 |  | 
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
| 42 | 
             
            TIMEZONE='Asia/Shanghai'
         | 
| 43 |  | 
| 44 | 
            -
            # If  | 
| 45 | 
             
            # HF_ENDPOINT=https://hf-mirror.com
         | 
| 46 |  | 
| 47 | 
             
            ######## OS setup for ES ###########
         | 
| 48 | 
             
            # sysctl vm.max_map_count
         | 
| 49 | 
             
            # sudo sysctl -w vm.max_map_count=262144
         | 
| 50 | 
            -
            #  | 
| 51 | 
            -
            # To make  | 
| 52 | 
            -
            #  | 
| 53 | 
             
            # vm.max_map_count=262144
         | 
|  | |
| 1 | 
             
            # Version of Elastic products
         | 
| 2 | 
             
            STACK_VERSION=8.11.3
         | 
| 3 |  | 
|  | |
| 4 | 
             
            # Port to expose Elasticsearch HTTP API to the host
         | 
| 5 | 
             
            ES_PORT=1200
         | 
| 6 |  | 
|  | |
| 12 | 
             
            KIBANA_USER=rag_flow
         | 
| 13 | 
             
            KIBANA_PASSWORD=infini_rag_flow
         | 
| 14 |  | 
| 15 | 
            +
            # Update according to the available host memory (in bytes)
         | 
| 16 |  | 
| 17 | 
             
            MEM_LIMIT=8073741824
         | 
| 18 |  | 
|  | |
| 19 | 
             
            MYSQL_PASSWORD=infini_rag_flow
         | 
| 20 | 
             
            MYSQL_PORT=5455
         | 
| 21 |  | 
|  | |
| 31 |  | 
| 32 | 
             
            SVR_HTTP_PORT=9380
         | 
| 33 |  | 
| 34 | 
            +
            # the Docker image for the slim version
         | 
| 35 | 
             
            RAGFLOW_IMAGE=infiniflow/ragflow:dev-slim
         | 
| 36 |  | 
| 37 | 
            +
            # If you cannot download the RAGFlow Docker image, try uncommenting either of the following hub.docker.com mirrors:
         | 
| 38 | 
             
            # RAGFLOW_IMAGE=swr.cn-north-4.myhuaweicloud.com/infiniflow/ragflow:dev-slim
         | 
| 39 | 
             
            # RAGFLOW_IMAGE=registry.cn-hangzhou.aliyuncs.com/infiniflow/ragflow:dev-slim
         | 
| 40 |  | 
| 41 | 
            +
            # To download the RAGFlow Docker image with embedding models, modify the line above as follows:
         | 
| 42 | 
            +
            # RAGFLOW_IMAGE=infiniflow/ragflow:dev
         | 
| 43 | 
            +
             | 
| 44 | 
            +
            # This Docker image includes the following four models:
         | 
| 45 | 
            +
            # - BAAI/bge-large-zh-v1.5
         | 
| 46 | 
            +
            # - BAAI/bge-reranker-v2-m3
         | 
| 47 | 
            +
            # - maidalun1020/bce-embedding-base_v1
         | 
| 48 | 
            +
            # - maidalun1020/bce-reranker-base_v1
         | 
| 49 | 
            +
             | 
| 50 | 
            +
            # And the following models will be downloaded if you select them in the RAGFlow UI.
         | 
| 51 | 
            +
            # - BAAI/bge-base-en-v1.5
         | 
| 52 | 
            +
            # - BAAI/bge-large-en-v1.5
         | 
| 53 | 
            +
            # - BAAI/bge-small-en-v1.5
         | 
| 54 | 
            +
            # - BAAI/bge-small-zh-v1.5
         | 
| 55 | 
            +
            # - jinaai/jina-embeddings-v2-base-en
         | 
| 56 | 
            +
            # - jinaai/jina-embeddings-v2-small-en
         | 
| 57 | 
            +
            # - nomic-ai/nomic-embed-text-v1.5
         | 
| 58 | 
            +
            # - sentence-transformers/all-MiniLM-L6-v2
         | 
| 59 | 
            +
             | 
| 60 | 
            +
            # If you cannot download the RAGFlow Docker image, try uncommenting either of the following hub.docker.com mirrors:
         | 
| 61 | 
            +
            # RAGFLOW_IMAGE=swr.cn-north-4.myhuaweicloud.com/infiniflow/ragflow:dev
         | 
| 62 | 
            +
            # RAGFLOW_IMAGE=registry.cn-hangzhou.aliyuncs.com/infiniflow/ragflow:dev
         | 
| 63 | 
            +
             | 
| 64 | 
             
            TIMEZONE='Asia/Shanghai'
         | 
| 65 |  | 
| 66 | 
            +
            # If you cannot download the RAGFlow Docker image, try uncommenting the following huggingface.co mirror:
         | 
| 67 | 
             
            # HF_ENDPOINT=https://hf-mirror.com
         | 
| 68 |  | 
| 69 | 
             
            ######## OS setup for ES ###########
         | 
| 70 | 
             
            # sysctl vm.max_map_count
         | 
| 71 | 
             
            # sudo sysctl -w vm.max_map_count=262144
         | 
| 72 | 
            +
            # Note that this change is not permanent and will be reset after a system reboot.
         | 
| 73 | 
            +
            # To make your change permanent, update /etc/sysctl.conf by:
         | 
| 74 | 
            +
            # Adding or modifying the following line:
         | 
| 75 | 
             
            # vm.max_map_count=262144
         |