RektPunk commited on
Commit
c330cdb
ยท
1 Parent(s): 4eefe86

[Doc] Add Korean translation for README.md (#2040)

Browse files

### What problem does this PR solve?

Add Korean translation for the `README.md` file.
This translation aims to accurately convey the meaning of the original
document.

### Type of change

- [x] Documentation Update

Files changed (4) hide show
  1. README.md +2 -1
  2. README_ja.md +2 -1
  3. README_ko.md +332 -0
  4. README_zh.md +2 -1
README.md CHANGED
@@ -7,7 +7,8 @@
7
  <p align="center">
8
  <a href="./README.md">English</a> |
9
  <a href="./README_zh.md">็ฎ€ไฝ“ไธญๆ–‡</a> |
10
- <a href="./README_ja.md">ๆ—ฅๆœฌ่ชž</a>
 
11
  </p>
12
 
13
  <p align="center">
 
7
  <p align="center">
8
  <a href="./README.md">English</a> |
9
  <a href="./README_zh.md">็ฎ€ไฝ“ไธญๆ–‡</a> |
10
+ <a href="./README_ja.md">ๆ—ฅๆœฌ่ชž</a> |
11
+ <a href="./README_ko.md">ํ•œ๊ตญ์–ด</a>
12
  </p>
13
 
14
  <p align="center">
README_ja.md CHANGED
@@ -7,7 +7,8 @@
7
  <p align="center">
8
  <a href="./README.md">English</a> |
9
  <a href="./README_zh.md">็ฎ€ไฝ“ไธญๆ–‡</a> |
10
- <a href="./README_ja.md">ๆ—ฅๆœฌ่ชž</a>
 
11
  </p>
12
 
13
  <p align="center">
 
7
  <p align="center">
8
  <a href="./README.md">English</a> |
9
  <a href="./README_zh.md">็ฎ€ไฝ“ไธญๆ–‡</a> |
10
+ <a href="./README_ja.md">ๆ—ฅๆœฌ่ชž</a> |
11
+ <a href="./README_ko.md">ํ•œ๊ตญ์–ด</a>
12
  </p>
13
 
14
  <p align="center">
README_ko.md ADDED
@@ -0,0 +1,332 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ <div align="center">
2
+ <a href="https://demo.ragflow.io/">
3
+ <img src="web/src/assets/logo-with-text.png" width="520" alt="ragflow logo">
4
+ </a>
5
+ </div>
6
+
7
+ <p align="center">
8
+ <a href="./README.md">English</a> |
9
+ <a href="./README_zh.md">็ฎ€ไฝ“ไธญๆ–‡</a> |
10
+ <a href="./README_ja.md">ๆ—ฅๆœฌ่ชž</a> |
11
+ <a href="./README_ko.md">ํ•œ๊ตญ์–ด</a> |
12
+ </p>
13
+
14
+ <p align="center">
15
+ <a href="https://github.com/infiniflow/ragflow/releases/latest">
16
+ <img src="https://img.shields.io/github/v/release/infiniflow/ragflow?color=blue&label=Latest%20Release" alt="Latest Release">
17
+ </a>
18
+ <a href="https://demo.ragflow.io" target="_blank">
19
+ <img alt="Static Badge" src="https://img.shields.io/badge/Online-Demo-4e6b99"></a>
20
+ <a href="https://hub.docker.com/r/infiniflow/ragflow" target="_blank">
21
+ <img src="https://img.shields.io/badge/docker_pull-ragflow:v0.9.0-brightgreen" alt="docker pull infiniflow/ragflow:v0.9.0"></a>
22
+ <a href="https://github.com/infiniflow/ragflow/blob/main/LICENSE">
23
+ <img height="21" src="https://img.shields.io/badge/License-Apache--2.0-ffffff?labelColor=d4eaf7&color=2e6cc4" alt="license">
24
+ </a>
25
+ </p>
26
+
27
+ <h4 align="center">
28
+ <a href="https://ragflow.io/docs/dev/">Document</a> |
29
+ <a href="https://github.com/infiniflow/ragflow/issues/162">Roadmap</a> |
30
+ <a href="https://twitter.com/infiniflowai">Twitter</a> |
31
+ <a href="https://discord.gg/4XxujFgUN7">Discord</a> |
32
+ <a href="https://demo.ragflow.io">Demo</a>
33
+ </h4>
34
+
35
+
36
+ ## ๐Ÿ’ก RAGFlow๋ž€?
37
+
38
+ [RAGFlow](https://ragflow.io/)๋Š” ์‹ฌ์ธต ๋ฌธ์„œ ์ดํ•ด์— ๊ธฐ๋ฐ˜ํ•œ ์˜คํ”ˆ์†Œ์Šค RAG (Retrieval-Augmented Generation) ์—”์ง„์ž…๋‹ˆ๋‹ค. ์ด ์—”์ง„์€ ๋Œ€๊ทœ๋ชจ ์–ธ์–ด ๋ชจ๋ธ(LLM)๊ณผ ๊ฒฐํ•ฉํ•˜์—ฌ ์ •ํ™•ํ•œ ์งˆ๋ฌธ ์‘๋‹ต ๊ธฐ๋Šฅ์„ ์ œ๊ณตํ•˜๋ฉฐ, ๋‹ค์–‘ํ•œ ๋ณต์žกํ•œ ํ˜•์‹์˜ ๋ฐ์ดํ„ฐ์—์„œ ์‹ ๋ขฐํ•  ์ˆ˜ ์žˆ๋Š” ์ถœ์ฒ˜๋ฅผ ๋ฐ”ํƒ•์œผ๋กœ ํ•œ ์ธ์šฉ์„ ํ†ตํ•ด ์ด๋ฅผ ๋’ท๋ฐ›์นจํ•ฉ๋‹ˆ๋‹ค. RAGFlow๋Š” ๊ทœ๋ชจ์— ์ƒ๊ด€์—†์ด ๋ชจ๋“  ๊ธฐ์—…์— ์ตœ์ ํ™”๋œ RAG ์›Œํฌํ”Œ๋กœ์šฐ๋ฅผ ์ œ๊ณตํ•ฉ๋‹ˆ๋‹ค.
39
+
40
+
41
+
42
+ ## ๐ŸŽฎ ๋ฐ๋ชจ
43
+ ๋ฐ๋ชจ๋ฅผ [https://demo.ragflow.io](https://demo.ragflow.io)์—์„œ ์‹คํ–‰ํ•ด ๋ณด์„ธ์š”.
44
+ <div align="center" style="margin-top:20px;margin-bottom:20px;">
45
+ <img src="https://github.com/infiniflow/ragflow/assets/7248/2f6baa3e-1092-4f11-866d-36f6a9d075e5" width="1200"/>
46
+ <img src="https://github.com/infiniflow/ragflow/assets/12318111/b083d173-dadc-4ea9-bdeb-180d7df514eb" width="1200"/>
47
+ </div>
48
+
49
+
50
+ ## ๐Ÿ”ฅ ์—…๋ฐ์ดํŠธ
51
+
52
+ - 2024-08-02: [graphrag](https://github.com/microsoft/graphrag)์™€ ๋งˆ์ธ๋“œ๋งต์—์„œ ์˜๊ฐ์„ ๋ฐ›์€ GraphRAG๋ฅผ ์ง€์›ํ•ฉ๋‹ˆ๋‹ค.
53
+
54
+ - 2024-07-23: ์˜ค๋””์˜ค ํŒŒ์ผ ๋ถ„์„์„ ์ง€์›ํ•ฉ๋‹ˆ๋‹ค.
55
+
56
+ - 2024-07-21: ๋” ๋งŽ์€ LLMs(LocalAI, OpenRouter, StepFun, Nvidia)๋ฅผ ์ง€์›ํ•ฉ๋‹ˆ๋‹ค.
57
+
58
+ - 2024-07-18: ๊ทธ๋ž˜ํ”„์— ๋” ๋งŽ์€ ๊ตฌ์„ฑ์š”์†Œ(Wikipedia, PubMed, Baidu, Duckduckgo)๋ฅผ ์ถ”๊ฐ€ํ•ฉ๋‹ˆ๋‹ค.
59
+
60
+ - 2024-07-08: [Graph](./graph/README.md)๋ฅผ ๊ธฐ๋ฐ˜์œผ๋กœ ํ•œ ์›Œํฌํ”Œ๋กœ์šฐ๋ฅผ ์ง€์›ํ•ฉ๋‹ˆ๋‹ค.
61
+
62
+ - 2024-06-27: Q&A ๋ถ„์„ ๋ฐฉ๋ฒ•์—์„œ Markdown๊ณผ Docx๋ฅผ ์ง€์›ํ•ฉ๋‹ˆ๋‹ค.
63
+
64
+ - 2024-06-27: Docx ํŒŒ์ผ์—์„œ ์ด๋ฏธ์ง€ ์ถ”์ถœ์„ ์ง€์›ํ•ฉ๋‹ˆ๋‹ค.
65
+
66
+ - 2024-06-27: Markdown ํŒŒ์ผ์—์„œ ํ‘œ ์ถ”์ถœ์„ ์ง€์›ํ•ฉ๋‹ˆ๋‹ค.
67
+
68
+ - 2024-06-06: ๋Œ€ํ™” ์„ค์ •์—์„œ ๊ธฐ๋ณธ์œผ๋กœ [Self-RAG](https://huggingface.co/papers/2310.11511)๋ฅผ ์ง€์›ํ•ฉ๋‹ˆ๋‹ค.
69
+
70
+ - 2024-05-30: [BCE](https://github.com/netease-youdao/BCEmbedding) ๋ฐ [BGE](https://github.com/FlagOpen/FlagEmbedding) reranker ๋ชจ๋ธ์„ ํ†ตํ•ฉํ•ฉ๋‹ˆ๋‹ค.
71
+
72
+ - 2024-05-23: ๋” ๋‚˜์€ ํ…์ŠคํŠธ ๊ฒ€์ƒ‰์„ ์œ„ํ•ด [RAPTOR](https://arxiv.org/html/2401.18059v1)๋ฅผ ์ง€์›ํ•ฉ๋‹ˆ๋‹ค.
73
+
74
+ - 2024-05-15: OpenAI GPT-4o๋ฅผ ํ†ตํ•ฉํ•ฉ๋‹ˆ๋‹ค.
75
+
76
+
77
+ ## ๐ŸŒŸ ์ฃผ์š” ๊ธฐ๋Šฅ
78
+
79
+ ### ๐Ÿญ **"Quality in, quality out"**
80
+ - [์‹ฌ์ธต ๋ฌธ์„œ ์ดํ•ด](./deepdoc/README.md)๋ฅผ ๊ธฐ๋ฐ˜์œผ๋กœ ๋ณต์žกํ•œ ํ˜•์‹์˜ ๋น„์ •ํ˜• ๋ฐ์ดํ„ฐ์—์„œ ์ง€์‹์„ ์ถ”์ถœํ•ฉ๋‹ˆ๋‹ค.
81
+ - ๋ฌธ์ž ๊ทธ๋Œ€๋กœ ๋ฌดํ•œํ•œ ํ† ํฐ์—์„œ "๋ฐ์ดํ„ฐ ์†์˜ ๋ฐ”๋Š˜"์„ ์ฐพ์•„๋ƒ…๋‹ˆ๋‹ค.
82
+
83
+ ### ๐Ÿฑ **ํ…œํ”Œ๋ฆฟ ๊ธฐ๋ฐ˜์˜ chunking**
84
+ - ๋˜‘๋˜‘ํ•˜๊ณ  ์„ค๋ช… ๊ฐ€๋Šฅํ•œ ๋ฐฉ์‹.
85
+ - ๋‹ค์–‘ํ•œ ํ…œํ”Œ๋ฆฟ ์˜ต์…˜์„ ์ œ๊ณตํ•ฉ๋‹ˆ๋‹ค.
86
+
87
+
88
+ ### ๐ŸŒฑ **ํ• ๋ฃจ์‹œ๋„ค์ด์…˜์„ ์ค„์ธ ์‹ ๋ขฐํ•  ์ˆ˜ ์žˆ๋Š” ์ธ์šฉ**
89
+ - ํ…์ŠคํŠธ ์ฒญํ‚น์„ ์‹œ๊ฐํ™”ํ•˜์—ฌ ์‚ฌ์šฉ์ž๊ฐ€ ๊ฐœ์ž…ํ•  ์ˆ˜ ์žˆ๋„๋ก ํ•ฉ๋‹ˆ๋‹ค.
90
+ - ์ค‘์š”ํ•œ ์ฐธ๊ณ  ์ž๋ฃŒ์™€ ์ถ”์  ๊ฐ€๋Šฅํ•œ ์ธ์šฉ์„ ๋น ๋ฅด๊ฒŒ ํ™•์ธํ•˜์—ฌ ์‹ ๋ขฐํ•  ์ˆ˜ ์žˆ๋Š” ๋‹ต๋ณ€์„ ์ง€์›ํ•ฉ๋‹ˆ๋‹ค.
91
+
92
+
93
+ ### ๐Ÿ” **๋‹ค๋ฅธ ์ข…๋ฅ˜์˜ ๋ฐ์ดํ„ฐ ์†Œ์Šค์™€์˜ ํ˜ธํ™˜์„ฑ**
94
+ - ์›Œ๋“œ, ์Šฌ๋ผ์ด๋“œ, ์—‘์…€, ํ…์ŠคํŠธ ํŒŒ์ผ, ์ด๋ฏธ์ง€, ์Šค์บ”๋ณธ, ๊ตฌ์กฐํ™”๋œ ๋ฐ์ดํ„ฐ, ์›น ํŽ˜์ด์ง€ ๋“ฑ์„ ์ง€์›ํ•ฉ๋‹ˆ๋‹ค.
95
+
96
+ ### ๐Ÿ›€ **์ž๋™ํ™”๋˜๊ณ  ์†์‰ฌ์šด RAG ์›Œํฌํ”Œ๋กœ์šฐ**
97
+ - ๊ฐœ์ธ ๋ฐ ๋Œ€๊ทœ๋ชจ ๋น„์ฆˆ๋‹ˆ์Šค์— ๋งž์ถ˜ ํšจ์œจ์ ์ธ RAG ์˜ค์ผ€์ŠคํŠธ๋ ˆ์ด์…˜.
98
+ - ๊ตฌ์„ฑ ๊ฐ€๋Šฅํ•œ LLM ๋ฐ ์ž„๋ฒ ๋”ฉ ๋ชจ๋ธ.
99
+ - ๋‹ค์ค‘ ๊ฒ€์ƒ‰๊ณผ ๊ฒฐํ•ฉ๋œ re-ranking.
100
+ - ๋น„์ฆˆ๋‹ˆ์Šค์™€ ์›ํ™œํ•˜๊ฒŒ ํ†ตํ•ฉํ•  ์ˆ˜ ์žˆ๋Š” ์ง๊ด€์ ์ธ API.
101
+
102
+
103
+ ## ๐Ÿ”Ž ์‹œ์Šคํ…œ ์•„ํ‚คํ…์ฒ˜
104
+
105
+ <div align="center" style="margin-top:20px;margin-bottom:20px;">
106
+ <img src="https://github.com/infiniflow/ragflow/assets/12318111/d6ac5664-c237-4200-a7c2-a4a00691b485" width="1000"/>
107
+ </div>
108
+
109
+ ## ๐ŸŽฌ ์‹œ์ž‘ํ•˜๊ธฐ
110
+ ### ๐Ÿ“ ์‚ฌ์ „ ์ค€๋น„ ์‚ฌํ•ญ
111
+ - CPU >= 4 cores
112
+ - RAM >= 16 GB
113
+ - Disk >= 50 GB
114
+ - Docker >= 24.0.0 & Docker Compose >= v2.26.1
115
+ > ๋กœ์ปฌ ๋จธ์‹ (Windows, Mac, Linux)์— Docker๊ฐ€ ์„ค์น˜๋˜์ง€ ์•Š์€ ๊ฒฝ์šฐ, [Docker ์—”์ง„ ์„ค์น˜]((https://docs.docker.com/engine/install/))๋ฅผ ์ฐธ์กฐํ•˜์„ธ์š”.
116
+
117
+
118
+ ### ๐Ÿš€ ์„œ๋ฒ„ ์‹œ์ž‘ํ•˜๊ธฐ
119
+
120
+ 1. `vm.max_map_count`๊ฐ€ 262144 ์ด์ƒ์ธ์ง€ ํ™•์ธํ•˜์„ธ์š”:
121
+ > `vm.max_map_count`์˜ ๊ฐ’์„ ์•„๋ž˜ ๋ช…๋ น์–ด๋ฅผ ํ†ตํ•ด ํ™•์ธํ•˜์„ธ์š”:
122
+ >
123
+ > ```bash
124
+ > $ sysctl vm.max_map_count
125
+ > ```
126
+ >
127
+ > ๋งŒ์•ฝ `vm.max_map_count` ์ด 262144 ๋ณด๋‹ค ์ž‘๋‹ค๋ฉด ๊ฐ’์„ ์Ÿˆ์„ค์ •ํ•˜์„ธ์š”.
128
+ >
129
+ > ```bash
130
+ > # ์ด ๊ฒฝ์šฐ์— 262144๋กœ ์„ค์ •ํ–ˆ์Šต๋‹ˆ๋‹ค.:
131
+ > $ sudo sysctl -w vm.max_map_count=262144
132
+ > ```
133
+ >
134
+ > ์ด ๋ณ€๊ฒฝ ์‚ฌํ•ญ์€ ์‹œ์Šคํ…œ ์žฌ๋ถ€ํŒ… ํ›„์— ์ดˆ๊ธฐํ™”๋ฉ๋‹ˆ๋‹ค. ๋ณ€๊ฒฝ ์‚ฌํ•ญ์„ ์˜๊ตฌ์ ์œผ๋กœ ์ ์šฉํ•˜๋ ค๋ฉด /etc/sysctl.conf ํŒŒ์ผ์— vm.max_map_count ๊ฐ’์„ ์ถ”๊ฐ€ํ•˜๊ฑฐ๋‚˜ ์—…๋ฐ์ดํŠธํ•˜์„ธ์š”:
135
+ >
136
+ > ```bash
137
+ > vm.max_map_count=262144
138
+ > ```
139
+
140
+ 2. ๋ ˆํฌ์ง€ํ† ๋ฆฌ๋ฅผ ํด๋ก ํ•˜์„ธ์š”:
141
+
142
+ ```bash
143
+ $ git clone https://github.com/infiniflow/ragflow.git
144
+ ```
145
+
146
+ 3. ๋ฏธ๋ฆฌ ๋นŒ๋“œ๋œ Docker ์ด๋ฏธ์ง€๋ฅผ ์ƒ์„ฑํ•˜๊ณ  ์„œ๋ฒ„๋ฅผ ์‹œ์ž‘ํ•˜์„ธ์š”:
147
+
148
+ > ๋‹ค์Œ ๋ช…๋ น์–ด๋ฅผ ์‹คํ–‰ํ•˜๋ฉด *dev* ๋ฒ„์ „์˜ RAGFlow Docker ์ด๋ฏธ์ง€๊ฐ€ ์ž๋™์œผ๋กœ ๋‹ค์šด๋กœ๋“œ๋ฉ๋‹ˆ๋‹ค. ํŠน์ • Docker ๋ฒ„์ „์„ ๋‹ค์šด๋กœ๋“œํ•˜๊ณ  ์‹คํ–‰ํ•˜๋ ค๋ฉด, **docker/.env** ํŒŒ์ผ์—์„œ `RAGFLOW_VERSION`์„ ์›ํ•˜๋Š” ๋ฒ„์ „์œผ๋กœ ์—…๋ฐ์ดํŠธํ•œ ํ›„, ์˜ˆ๋ฅผ ๋“ค์–ด `RAGFLOW_VERSION=v0.9.0`๋กœ ์—…๋ฐ์ดํŠธ ํ•œ ๋’ค, ๋‹ค์Œ ๋ช…๋ น์–ด๋ฅผ ์‹คํ–‰ํ•˜์„ธ์š”.
149
+ ```bash
150
+ $ cd ragflow/docker
151
+ $ chmod +x ./entrypoint.sh
152
+ $ docker compose up -d
153
+ ```
154
+
155
+ > ๊ธฐ๋ณธ ์ด๋ฏธ์ง€๋Š” ์•ฝ 9GB ํฌ๊ธฐ์ด๋ฉฐ ๋กœ๋“œํ•˜๋Š” ๋ฐ ์‹œ๊ฐ„์ด ๊ฑธ๋ฆด ์ˆ˜ ์žˆ์Šต๋‹ˆ๋‹ค.
156
+
157
+
158
+ 4. ์„œ๋ฒ„๊ฐ€ ์‹œ์ž‘๋œ ํ›„ ์„œ๋ฒ„ ์ƒํƒœ๋ฅผ ํ™•์ธํ•˜์„ธ์š”:
159
+
160
+ ```bash
161
+ $ docker logs -f ragflow-server
162
+ ```
163
+
164
+ _๋‹ค์Œ ์ถœ๋ ฅ ๊ฒฐ๊ณผ๋กœ ์‹œ์Šคํ…œ์ด ์„ฑ๊ณต์ ์œผ๋กœ ์‹œ์ž‘๋˜์—ˆ์Œ์„ ํ™•์ธํ•ฉ๋‹ˆ๋‹ค:_
165
+
166
+ ```bash
167
+ ____ ______ __
168
+ / __ \ ____ _ ____ _ / ____// /____ _ __
169
+ / /_/ // __ `// __ `// /_ / // __ \| | /| / /
170
+ / _, _// /_/ // /_/ // __/ / // /_/ /| |/ |/ /
171
+ /_/ |_| \__,_/ \__, //_/ /_/ \____/ |__/|__/
172
+ /____/
173
+
174
+ * Running on all addresses (0.0.0.0)
175
+ * Running on http://127.0.0.1:9380
176
+ * Running on http://x.x.x.x:9380
177
+ INFO:werkzeug:Press CTRL+C to quit
178
+ ```
179
+ > ๋งŒ์•ฝ ํ™•์ธ ๋‹จ๊ณ„๋ฅผ ๊ฑด๋„ˆ๋›ฐ๊ณ  ๋ฐ”๋กœ RAGFlow์— ๋กœ๊ทธ์ธํ•˜๋ฉด, RAGFlow๊ฐ€ ์™„์ „ํžˆ ์ดˆ๊ธฐํ™”๋˜์ง€ ์•Š์•˜๊ธฐ ๋•Œ๋ฌธ์— ๋ธŒ๋ผ์šฐ์ €์—์„œ `network anomaly` ์˜ค๋ฅ˜๊ฐ€ ๋ฐœ์ƒํ•  ์ˆ˜ ์žˆ์Šต๋‹ˆ๋‹ค.
180
+
181
+ 5. ์›น ๋ธŒ๋ผ์šฐ์ €์— ์„œ๋ฒ„์˜ IP ์ฃผ์†Œ๋ฅผ ์ž…๋ ฅํ•˜๊ณ  RAGFlow์— ๋กœ๊ทธ์ธํ•˜์„ธ์š”.
182
+ > ๊ธฐ๋ณธ ์„ค์ •์„ ์‚ฌ์šฉํ•  ๊ฒฝ์šฐ, `http://IP_OF_YOUR_MACHINE`๋งŒ ์ž…๋ ฅํ•˜๋ฉด ๋ฉ๋‹ˆ๋‹ค (ํฌํŠธ ๋ฒˆํ˜ธ๋Š” ์ œ์™ธ). ๊ธฐ๋ณธ HTTP ์„œ๋น„์Šค ํฌํŠธ `80`์€ ๊ธฐ๋ณธ ๊ตฌ์„ฑ์œผ๋กœ ์‚ฌ์šฉํ•  ๋•Œ ์ƒ๋žตํ•  ์ˆ˜ ์žˆ์Šต๋‹ˆ๋‹ค.
183
+ 6. [service_conf.yaml](./docker/service_conf.yaml) ํŒŒ์ผ์—์„œ ์›ํ•˜๋Š” LLM ํŒฉํ† ๋ฆฌ๋ฅผ `user_default_llm`์— ์„ ํƒํ•˜๊ณ , `API_KEY` ํ•„๋“œ๋ฅผ ํ•ด๋‹น API ํ‚ค๋กœ ์—…๋ฐ์ดํŠธํ•˜์„ธ์š”.
184
+ > ์ž์„ธํ•œ ๋‚ด์šฉ์€ [llm_api_key_setup](https://ragflow.io/docs/dev/llm_api_key_setup)๋ฅผ ์ฐธ์กฐํ•˜์„ธ์š”.
185
+
186
+ _์ด์ œ ์‡ผ๊ฐ€ ์‹œ์ž‘๋ฉ๋‹ˆ๋‹ค!_
187
+
188
+ ## ๐Ÿ”ง ์„ค์ •
189
+
190
+ ์‹œ์Šคํ…œ ์„ค์ •๊ณผ ๊ด€๋ จํ•˜์—ฌ ๋‹ค์Œ ํŒŒ์ผ๋“ค์„ ๊ด€๋ฆฌํ•ด์•ผ ํ•ฉ๋‹ˆ๋‹ค:
191
+
192
+ - [.env](./docker/.env): `SVR_HTTP_PORT`, `MYSQL_PASSWORD`, `MINIO_PASSWORD`์™€ ๊ฐ™์€ ์‹œ์Šคํ…œ์˜ ๊ธฐ๋ณธ ์„ค์ •์„ ํฌํ•จํ•ฉ๋‹ˆ๋‹ค.
193
+ - [service_conf.yaml](./docker/service_conf.yaml): ๋ฐฑ์—”๋“œ ์„œ๋น„์Šค๋ฅผ ๊ตฌ์„ฑํ•ฉ๋‹ˆ๋‹ค.
194
+ - [docker-compose.yml](./docker/docker-compose.yml): ์‹œ์Šคํ…œ์€ [docker-compose.yml](./docker/docker-compose.yml)์„ ์‚ฌ์šฉํ•˜์—ฌ ์‹œ์ž‘๋ฉ๋‹ˆ๋‹ค.
195
+
196
+ [.env](./docker/.env) ํŒŒ์ผ์˜ ๋ณ€๊ฒฝ ์‚ฌํ•ญ์ด [service_conf.yaml](./docker/service_conf.yaml) ํŒŒ์ผ์˜ ๋‚ด์šฉ๊ณผ ์ผ์น˜ํ•˜๋„๋ก ํ•ด์•ผ ํ•ฉ๋‹ˆ๋‹ค.
197
+
198
+ > [./docker/README](./docker/README.md) ํŒŒ์ผ์—๋Š” ํ™˜๊ฒฝ ์„ค์ •๊ณผ ์„œ๋น„์Šค ๊ตฌ์„ฑ์— ๋Œ€ํ•œ ์ž์„ธํ•œ ์„ค๋ช…์ด ์žˆ์œผ๋ฉฐ, [./docker/README](./docker/README.md) ํŒŒ์ผ์— ๋‚˜์—ด๋œ ๋ชจ๋“  ํ™˜๊ฒฝ ์„ค์ •์ด [service_conf.yaml](./docker/service_conf.yaml) ํŒŒ์ผ์˜ ํ•ด๋‹น ๊ตฌ์„ฑ๊ณผ ์ผ์น˜ํ•˜๋„๋ก ํ•ด์•ผ ํ•ฉ๋‹ˆ๋‹ค.
199
+
200
+ ๊ธฐ๋ณธ HTTP ์„œ๋น„์Šค ํฌํŠธ(80)๋ฅผ ์—…๋ฐ์ดํŠธํ•˜๋ ค๋ฉด [docker-compose.yml](./docker/docker-compose.yml) ํŒŒ์ผ์—์„œ `80:80`์„ `<YOUR_SERVING_PORT>:80`์œผ๋กœ ๋ณ€๊ฒฝํ•˜์„ธ์š”.
201
+
202
+ > ๋ชจ๋“  ์‹œ์Šคํ…œ ๊ตฌ์„ฑ ์—…๋ฐ์ดํŠธ๋Š” ์ ์šฉ๋˜๊ธฐ ์œ„ํ•ด ์‹œ์Šคํ…œ ์žฌ๋ถ€ํŒ…์ด ํ•„์š”ํ•ฉ๋‹ˆ๋‹ค.
203
+ >
204
+ > ```bash
205
+ > $ docker-compose up -d
206
+ > ```
207
+
208
+ ## ๐Ÿ› ๏ธ ์†Œ์Šค์—์„œ ๋นŒ๋“œํ•˜๊ธฐ
209
+
210
+ Docker ์ด๋ฏธ์ง€๋ฅผ ์†Œ์Šค์—์„œ ๋นŒ๋“œํ•˜๋ ค๋ฉด:
211
+
212
+ ```bash
213
+ $ git clone https://github.com/infiniflow/ragflow.git
214
+ $ cd ragflow/
215
+ $ docker build -t infiniflow/ragflow:dev .
216
+ $ cd ragflow/docker
217
+ $ chmod +x ./entrypoint.sh
218
+ $ docker compose up -d
219
+ ```
220
+
221
+
222
+ ## ๐Ÿ› ๏ธ ์†Œ์Šค์—์„œ ์„œ๋น„์Šค ์‹œ์ž‘ํ•˜๊ธฐ
223
+
224
+ ์„œ๋น„์Šค๋ฅผ ์†Œ์Šค์—์„œ ์‹œ์ž‘ํ•˜๋ ค๋ฉด:
225
+
226
+ 1. ๋ ˆํฌ์ง€ํ† ๋ฆฌ๋ฅผ ํด๋ก ํ•˜์„ธ์š”:
227
+
228
+ ```bash
229
+ $ git clone https://github.com/infiniflow/ragflow.git
230
+ $ cd ragflow/
231
+ ```
232
+
233
+ 2. ๊ฐ€์ƒ ํ™˜๊ฒฝ์„ ์ƒ์„ฑํ•˜๊ณ , Anaconda ๋˜๋Š” Miniconda๊ฐ€ ์„ค์น˜๋˜์–ด ์žˆ๋Š”์ง€ ํ™•์ธํ•˜์„ธ์š”:
234
+ ```bash
235
+ $ conda create -n ragflow python=3.11.0
236
+ $ conda activate ragflow
237
+ $ pip install -r requirements.txt
238
+ ```
239
+
240
+ ```bash
241
+ # CUDA ๋ฒ„์ „์ด 12.0๋ณด๋‹ค ๋†’์€ ๊ฒฝ์šฐ, ๋‹ค์Œ ๋ช…๋ น์–ด๋ฅผ ์ถ”๊ฐ€๋กœ ์‹คํ–‰ํ•˜์„ธ์š”:
242
+ $ pip uninstall -y onnxruntime-gpu
243
+ $ pip install onnxruntime-gpu --extra-index-url https://aiinfra.pkgs.visualstudio.com/PublicPackages/_packaging/onnxruntime-cuda-12/pypi/simple/
244
+ ```
245
+
246
+ 3. ์ง„์ž… ์Šคํฌ๋ฆฝํŠธ๋ฅผ ๋ณต์‚ฌํ•˜๊ณ  ํ™˜๊ฒฝ ๋ณ€์ˆ˜๋ฅผ ์„ค์ •ํ•˜์„ธ์š”:
247
+ ```bash
248
+ # ํŒŒ์ด์ฌ ๊ฒฝ๋กœ๋ฅผ ๋ฐ›์•„์˜ต๋‹ˆ๋‹ค:
249
+ $ which python
250
+ # RAGFlow ํ”„๋กœ์ ํŠธ ๊ฒฝ๋กœ๋ฅผ ๋ฐ›์•„์˜ต๋‹ˆ๋‹ค:
251
+ $ pwd
252
+ ```
253
+
254
+ ```bash
255
+ $ cp docker/entrypoint.sh .
256
+ $ vi entrypoint.sh
257
+ ```
258
+
259
+ ```bash
260
+ # ์‹ค์ œ ์ƒํ™ฉ์— ๋งž๊ฒŒ ์„ค์ • ์กฐ์ •ํ•˜๊ธฐ (๋‹ค์Œ ๋‘ ๊ฐœ์˜ export ๋ช…๋ น์–ด๋Š” ์ƒˆ๋กœ ์ถ”๊ฐ€๋˜์—ˆ์Šต๋‹ˆ๋‹ค):
261
+ # - `which python`์˜ ๊ฒฐ๊ณผ๋ฅผ `PY`์— ํ• ๋‹นํ•ฉ๋‹ˆ๋‹ค.
262
+ # - `pwd`์˜ ๊ฒฐ๊ณผ๋ฅผ `PYTHONPATH`์— ํ• ๋‹นํ•ฉ๋‹ˆ๋‹ค.
263
+ # - `LD_LIBRARY_PATH`๊ฐ€ ์„ค์ •๋˜์–ด ์žˆ๋Š” ๊ฒฝ์šฐ ์ฃผ์„ ์ฒ˜๋ฆฌํ•ฉ๋‹ˆ๋‹ค.
264
+ # - ์„ ํƒ ์‚ฌํ•ญ: Hugging Face ๋ฏธ๋Ÿฌ ์ถ”๊ฐ€.
265
+ PY=${PY}
266
+ export PYTHONPATH=${PYTHONPATH}
267
+ export HF_ENDPOINT=https://hf-mirror.com
268
+ ```
269
+
270
+ 4. ๋‹ค๋ฅธ ์„œ๋น„์Šค(MinIO, Elasticsearch, Redis, MySQL)๋ฅผ ์‹œ์ž‘ํ•˜์„ธ์š”:
271
+ ```bash
272
+ $ cd docker
273
+ $ docker compose -f docker-compose-base.yml up -d
274
+ ```
275
+
276
+ 5. ์„ค์ • ํŒŒ์ผ์„ ํ™•์ธํ•˜์—ฌ ๋‹ค์Œ ์‚ฌํ•ญ์„ ํ™•์ธํ•˜์„ธ์š”:
277
+ - **docker/.env**์˜ ์„ค์ •์ด **conf/service_conf.yaml**์˜ ์„ค์ •๊ณผ ์ผ์น˜ํ•˜๋Š”์ง€ ํ™•์ธํ•ฉ๋‹ˆ๋‹ค.
278
+ - **service_conf.yaml**์˜ ๊ด€๋ จ ์„œ๋น„์Šค์— ๋Œ€ํ•œ IP ์ฃผ์†Œ์™€ ํฌํŠธ๊ฐ€ ๋กœ์ปฌ ๋จธ์‹ ์˜ IP ์ฃผ์†Œ์™€ ์ปจํ…Œ์ด๋„ˆ์—์„œ ๋…ธ์ถœ๋œ ํฌํŠธ์™€ ์ผ์น˜ํ•˜๋Š”์ง€ ํ™•์ธํ•ฉ๋‹ˆ๋‹ค.
279
+
280
+
281
+ 6. RAGFlow ๋ฐฑ์—”๋“œ ์„œ๋น„์Šค๋ฅผ ์‹œ์ž‘ํ•ฉ๋‹ˆ๋‹ค:
282
+
283
+ ```bash
284
+ $ chmod +x ./entrypoint.sh
285
+ $ bash ./entrypoint.sh
286
+ ```
287
+
288
+ 7. ํ”„๋ก ํŠธ์—”๋“œ ์„œ๋น„์Šค๋ฅผ ์‹œ์ž‘ํ•ฉ๋‹ˆ๋‹ค:
289
+
290
+ ```bash
291
+ $ cd web
292
+ $ npm install --registry=https://registry.npmmirror.com --force
293
+ $ vim .umirc.ts
294
+ # proxy.target์„ http://127.0.0.1:9380๋กœ ์—…๋ฐ์ดํŠธํ•ฉ๋‹ˆ๋‹ค.
295
+ $ npm run dev
296
+ ```
297
+
298
+ 8. ํ”„๋ก ํŠธ์—”๋“œ ์„œ๋น„์Šค๋ฅผ ๋ฐฐํฌํ•ฉ๋‹ˆ๋‹ค:
299
+
300
+ ```bash
301
+ $ cd web
302
+ $ npm install --registry=https://registry.npmmirror.com --force
303
+ $ umi build
304
+ $ mkdir -p /ragflow/web
305
+ $ cp -r dist /ragflow/web
306
+ $ apt install nginx -y
307
+ $ cp ../docker/nginx/proxy.conf /etc/nginx
308
+ $ cp ../docker/nginx/nginx.conf /etc/nginx
309
+ $ cp ../docker/nginx/ragflow.conf /etc/nginx/conf.d
310
+ $ systemctl start nginx
311
+ ```
312
+
313
+ ## ๐Ÿ“š ๋ฌธ์„œ
314
+
315
+ - [Quickstart](https://ragflow.io/docs/dev/)
316
+ - [User guide](https://ragflow.io/docs/dev/category/user-guides)
317
+ - [References](https://ragflow.io/docs/dev/category/references)
318
+ - [FAQ](https://ragflow.io/docs/dev/faq)
319
+
320
+ ## ๐Ÿ“œ ๋กœ๋“œ๋งต
321
+
322
+ [RAGFlow ๋กœ๋“œ๋งต 2024](https://github.com/infiniflow/ragflow/issues/162)์„ ํ™•์ธํ•˜์„ธ์š”.
323
+
324
+ ## ๐Ÿ„ ์ปค๋ฎค๋‹ˆํ‹ฐ
325
+
326
+ - [Discord](https://discord.gg/4XxujFgUN7)
327
+ - [Twitter](https://twitter.com/infiniflowai)
328
+ - [GitHub Discussions](https://github.com/orgs/infiniflow/discussions)
329
+
330
+ ## ๐Ÿ™Œ ์ปจํŠธ๋ฆฌ๋ทฐ์…˜
331
+
332
+ RAGFlow๋Š” ์˜คํ”ˆ์†Œ์Šค ํ˜‘์—…์„ ํ†ตํ•ด ๋ฐœ์ „ํ•ฉ๋‹ˆ๋‹ค. ์ด๋Ÿฌํ•œ ์ •์‹ ์„ ๋ฐ”ํƒ•์œผ๋กœ, ์šฐ๋ฆฌ๋Š” ์ปค๋ฎค๋‹ˆํ‹ฐ์˜ ๋‹ค์–‘ํ•œ ๊ธฐ์—ฌ๋ฅผ ํ™˜์˜ํ•ฉ๋‹ˆ๋‹ค. ์ฐธ์—ฌํ•˜๊ณ  ์‹ถ์œผ์‹œ๋‹ค๋ฉด, ๋จผ์ € [๊ฐ€์ด๋“œ๋ผ์ธ](./docs/references/CONTRIBUTING.md)์„ ๊ฒ€ํ† ํ•ด ์ฃผ์„ธ์š”.
README_zh.md CHANGED
@@ -7,7 +7,8 @@
7
  <p align="center">
8
  <a href="./README.md">English</a> |
9
  <a href="./README_zh.md">็ฎ€ไฝ“ไธญๆ–‡</a> |
10
- <a href="./README_ja.md">ๆ—ฅๆœฌ่ชž</a>
 
11
  </p>
12
 
13
  <p align="center">
 
7
  <p align="center">
8
  <a href="./README.md">English</a> |
9
  <a href="./README_zh.md">็ฎ€ไฝ“ไธญๆ–‡</a> |
10
+ <a href="./README_ja.md">ๆ—ฅๆœฌ่ชž</a> |
11
+ <a href="./README_ko.md">ํ•œ๊ตญ์–ด</a>
12
  </p>
13
 
14
  <p align="center">