writinwaters commited on
Commit
5aed7de
ยท
1 Parent(s): aa02c70

Translated Korean README (#2666)

Browse files

### What problem does this PR solve?



### Type of change


- [x] Documentation Update

Files changed (1) hide show
  1. README_ko.md +16 -16
README_ko.md CHANGED
@@ -199,9 +199,9 @@
199
  > $ docker-compose up -d
200
  > ```
201
 
202
- ## ๐Ÿช› Build the Docker image without embedding models
203
 
204
- This image is approximately 1 GB in size and relies on external LLM and embedding services.
205
 
206
  ```bash
207
  git clone https://github.com/infiniflow/ragflow.git
@@ -211,9 +211,9 @@ python3 download_deps.py
211
  docker build -f Dockerfile.slim -t infiniflow/ragflow:dev-slim .
212
  ```
213
 
214
- ## ๐Ÿชš Build the Docker image including embedding models
215
 
216
- This image includes embedding models and is approximately 9 GB in size, and so relies on external LLM services only.
217
 
218
  ```bash
219
  git clone https://github.com/infiniflow/ragflow.git
@@ -223,14 +223,14 @@ python3 download_deps.py
223
  docker build -f Dockerfile -t infiniflow/ragflow:dev .
224
  ```
225
 
226
- ## ๐Ÿ”จ Launch service from source for development
227
 
228
- 1. Install Poetry, or skip this step if it is already installed:
229
  ```bash
230
  curl -sSL https://install.python-poetry.org | python3 -
231
  ```
232
 
233
- 2. Clone the source code and install Python dependencies:
234
  ```bash
235
  git clone https://github.com/infiniflow/ragflow.git
236
  cd ragflow/
@@ -238,42 +238,42 @@ docker build -f Dockerfile -t infiniflow/ragflow:dev .
238
  ~/.local/bin/poetry install --sync --no-root # install RAGFlow dependent python modules
239
  ```
240
 
241
- 3. Launch the dependent services (MinIO, Elasticsearch, Redis, and MySQL) using Docker Compose:
242
  ```bash
243
  docker compose -f docker/docker-compose-base.yml up -d
244
  ```
245
 
246
- Add the following line to `/etc/hosts` to resolve all hosts specified in **docker/service_conf.yaml** to `127.0.0.1`:
247
  ```
248
  127.0.0.1 es01 mysql minio redis
249
  ```
250
- In **docker/service_conf.yaml**, update mysql port to `5455` and es port to `1200`, as specified in **docker/.env**.
251
 
252
- 4. If you cannot access HuggingFace, set the `HF_ENDPOINT` environment variable to use a mirror site:
253
 
254
  ```bash
255
  export HF_ENDPOINT=https://hf-mirror.com
256
  ```
257
 
258
- 5. Launch backend service:
259
  ```bash
260
  source .venv/bin/activate
261
  export PYTHONPATH=$(pwd)
262
  bash docker/launch_backend_service.sh
263
  ```
264
 
265
- 6. Install frontend dependencies:
266
  ```bash
267
  cd web
268
  npm install --force
269
  ```
270
- 7. Configure frontend to update `proxy.target` in **.umirc.ts** to `http://127.0.0.1:9380`:
271
- 8. Launch frontend service:
272
  ```bash
273
  npm run dev
274
  ```
275
 
276
- _The following output confirms a successful launch of the system:_
277
 
278
  ![](https://github.com/user-attachments/assets/0daf462c-a24d-4496-a66f-92533534e187)
279
 
 
199
  > $ docker-compose up -d
200
  > ```
201
 
202
+ ## ๐Ÿช› ์†Œ์Šค ์ฝ”๋“œ๋กœ Docker ์ด๋ฏธ์ง€๋ฅผ ์ปดํŒŒ์ผํ•ฉ๋‹ˆ๋‹ค(์ž„๋ฒ ๋”ฉ ๋ชจ๋ธ ํฌํ•จํ•˜์ง€ ์•Š์Œ)
203
 
204
+ ์ด Docker ์ด๋ฏธ์ง€์˜ ํฌ๊ธฐ๋Š” ์•ฝ 1GB์ด๋ฉฐ, ์™ธ๋ถ€ ๋Œ€ํ˜• ๋ชจ๋ธ๊ณผ ์ž„๋ฒ ๋”ฉ ์„œ๋น„์Šค์— ์˜์กดํ•ฉ๋‹ˆ๋‹ค.
205
 
206
  ```bash
207
  git clone https://github.com/infiniflow/ragflow.git
 
211
  docker build -f Dockerfile.slim -t infiniflow/ragflow:dev-slim .
212
  ```
213
 
214
+ ## ๐Ÿชš ์†Œ์Šค ์ฝ”๋“œ๋กœ Docker ์ด๋ฏธ์ง€๋ฅผ ์ปดํŒŒ์ผํ•ฉ๋‹ˆ๋‹ค(์ž„๋ฒ ๋”ฉ ๋ชจ๋ธ ํฌํ•จ)
215
 
216
+ ์ด Docker์˜ ํฌ๊ธฐ๋Š” ์•ฝ 9GB์ด๋ฉฐ, ์ด๋ฏธ ์ž„๋ฒ ๋”ฉ ๋ชจ๋ธ์„ ํฌํ•จํ•˜๊ณ  ์žˆ์œผ๋ฏ€๋กœ ์™ธ๋ถ€ ๋Œ€ํ˜• ๋ชจ๋ธ ์„œ๋น„์Šค์—๋งŒ ์˜์กดํ•˜๋ฉด ๋ฉ๋‹ˆ๋‹ค.
217
 
218
  ```bash
219
  git clone https://github.com/infiniflow/ragflow.git
 
223
  docker build -f Dockerfile -t infiniflow/ragflow:dev .
224
  ```
225
 
226
+ ## ๐Ÿ”จ ์†Œ์Šค ์ฝ”๋“œ๋กœ ์„œ๋น„์Šค๋ฅผ ์‹œ์ž‘ํ•ฉ๋‹ˆ๋‹ค.
227
 
228
+ 1. Poetry๋ฅผ ์„ค์น˜ํ•˜๊ฑฐ๋‚˜ ์ด๋ฏธ ์„ค์น˜๋œ ๊ฒฝ์šฐ ์ด ๋‹จ๊ณ„๋ฅผ ๊ฑด๋„ˆ๋œ๋‹ˆ๋‹ค:
229
  ```bash
230
  curl -sSL https://install.python-poetry.org | python3 -
231
  ```
232
 
233
+ 2. ์†Œ์Šค ์ฝ”๋“œ๋ฅผ ํด๋ก ํ•˜๊ณ  Python ์˜์กด์„ฑ์„ ์„ค์น˜ํ•ฉ๋‹ˆ๋‹ค:
234
  ```bash
235
  git clone https://github.com/infiniflow/ragflow.git
236
  cd ragflow/
 
238
  ~/.local/bin/poetry install --sync --no-root # install RAGFlow dependent python modules
239
  ```
240
 
241
+ 3. Docker Compose๋ฅผ ์‚ฌ์šฉํ•˜์—ฌ ์˜์กด ์„œ๋น„์Šค(MinIO, Elasticsearch, Redis ๋ฐ MySQL)๋ฅผ ์‹œ์ž‘ํ•ฉ๋‹ˆ๋‹ค:
242
  ```bash
243
  docker compose -f docker/docker-compose-base.yml up -d
244
  ```
245
 
246
+ `/etc/hosts` ์— ๋‹ค์Œ ์ค„์„ ์ถ”๊ฐ€ํ•˜์—ฌ **docker/service_conf.yaml** ์— ์ง€์ •๋œ ๋ชจ๋“  ํ˜ธ์ŠคํŠธ๋ฅผ `127.0.0.1` ๋กœ ํ•ด๊ฒฐํ•ฉ๋‹ˆ๋‹ค:
247
  ```
248
  127.0.0.1 es01 mysql minio redis
249
  ```
250
+ **docker/service_conf.yaml** ์—์„œ mysql ํฌํŠธ๋ฅผ `5455` ๋กœ, es ํฌํŠธ๋ฅผ `1200` ์œผ๋กœ ์—…๋ฐ์ดํŠธํ•ฉ๋‹ˆ๋‹ค( **docker/.env** ์— ์ง€์ •๋œ ๋Œ€๋กœ).
251
 
252
+ 4. HuggingFace์— ์ ‘๊ทผํ•  ์ˆ˜ ์—†๋Š” ๊ฒฝ์šฐ, `HF_ENDPOINT` ํ™˜๊ฒฝ ๋ณ€์ˆ˜๋ฅผ ์„ค์ •ํ•˜์—ฌ ๋ฏธ๋Ÿฌ ์‚ฌ์ดํŠธ๋ฅผ ์‚ฌ์šฉํ•˜์„ธ์š”:
253
 
254
  ```bash
255
  export HF_ENDPOINT=https://hf-mirror.com
256
  ```
257
 
258
+ 5. ๋ฐฑ์—”๋“œ ์„œ๋น„์Šค๋ฅผ ์‹œ์ž‘ํ•ฉ๋‹ˆ๋‹ค:
259
  ```bash
260
  source .venv/bin/activate
261
  export PYTHONPATH=$(pwd)
262
  bash docker/launch_backend_service.sh
263
  ```
264
 
265
+ 6. ํ”„๋ก ํŠธ์—”๋“œ ์˜์กด์„ฑ์„ ์„ค์น˜ํ•ฉ๋‹ˆ๋‹ค:
266
  ```bash
267
  cd web
268
  npm install --force
269
  ```
270
+ 7. **.umirc.ts** ์—์„œ `proxy.target` ์„ `http://127.0.0.1:9380` ์œผ๋กœ ์—…๋ฐ์ดํŠธํ•ฉ๋‹ˆ๋‹ค:
271
+ 8. ํ”„๋ก ํŠธ์—”๋“œ ์„œ๋น„์Šค๋ฅผ ์‹œ์ž‘ํ•ฉ๋‹ˆ๋‹ค:
272
  ```bash
273
  npm run dev
274
  ```
275
 
276
+ _๋‹ค์Œ ์ธํ„ฐํŽ˜์ด์Šค๋Š” ์‹œ์Šคํ…œ์ด ์„ฑ๊ณต์ ์œผ๋กœ ์‹œ์ž‘๋˜์—ˆ์Œ์„ ๋‚˜ํƒ€๋ƒ…๋‹ˆ๋‹ค:_
277
 
278
  ![](https://github.com/user-attachments/assets/0daf462c-a24d-4496-a66f-92533534e187)
279