writinwaters commited on
Commit
aa02c70
·
1 Parent(s): f4d932c

Translated Japanese README (#2664)

Browse files

### What problem does this PR solve?



### Type of change


- [x] Documentation Update

Files changed (1) hide show
  1. README_ja.md +16 -16
README_ja.md CHANGED
@@ -194,9 +194,9 @@
194
  > $ docker-compose up -d
195
  > ```
196
 
197
- ## 🪛 Build the Docker image without embedding models
198
 
199
- This image is approximately 1 GB in size and relies on external LLM and embedding services.
200
 
201
  ```bash
202
  git clone https://github.com/infiniflow/ragflow.git
@@ -206,9 +206,9 @@ python3 download_deps.py
206
  docker build -f Dockerfile.slim -t infiniflow/ragflow:dev-slim .
207
  ```
208
 
209
- ## 🪚 Build the Docker image including embedding models
210
 
211
- This image includes embedding models and is approximately 9 GB in size, and so relies on external LLM services only.
212
 
213
  ```bash
214
  git clone https://github.com/infiniflow/ragflow.git
@@ -218,14 +218,14 @@ python3 download_deps.py
218
  docker build -f Dockerfile -t infiniflow/ragflow:dev .
219
  ```
220
 
221
- ## 🔨 Launch service from source for development
222
 
223
- 1. Install Poetry, or skip this step if it is already installed:
224
  ```bash
225
  curl -sSL https://install.python-poetry.org | python3 -
226
  ```
227
 
228
- 2. Clone the source code and install Python dependencies:
229
  ```bash
230
  git clone https://github.com/infiniflow/ragflow.git
231
  cd ragflow/
@@ -233,42 +233,42 @@ docker build -f Dockerfile -t infiniflow/ragflow:dev .
233
  ~/.local/bin/poetry install --sync --no-root # install RAGFlow dependent python modules
234
  ```
235
 
236
- 3. Launch the dependent services (MinIO, Elasticsearch, Redis, and MySQL) using Docker Compose:
237
  ```bash
238
  docker compose -f docker/docker-compose-base.yml up -d
239
  ```
240
 
241
- Add the following line to `/etc/hosts` to resolve all hosts specified in **docker/service_conf.yaml** to `127.0.0.1`:
242
  ```
243
  127.0.0.1 es01 mysql minio redis
244
  ```
245
- In **docker/service_conf.yaml**, update mysql port to `5455` and es port to `1200`, as specified in **docker/.env**.
246
 
247
- 4. If you cannot access HuggingFace, set the `HF_ENDPOINT` environment variable to use a mirror site:
248
 
249
  ```bash
250
  export HF_ENDPOINT=https://hf-mirror.com
251
  ```
252
 
253
- 5. Launch backend service:
254
  ```bash
255
  source .venv/bin/activate
256
  export PYTHONPATH=$(pwd)
257
  bash docker/launch_backend_service.sh
258
  ```
259
 
260
- 6. Install frontend dependencies:
261
  ```bash
262
  cd web
263
  npm install --force
264
  ```
265
- 7. Configure frontend to update `proxy.target` in **.umirc.ts** to `http://127.0.0.1:9380`:
266
- 8. Launch frontend service:
267
  ```bash
268
  npm run dev
269
  ```
270
 
271
- _The following output confirms a successful launch of the system:_
272
 
273
  ![](https://github.com/user-attachments/assets/0daf462c-a24d-4496-a66f-92533534e187)
274
 
 
194
  > $ docker-compose up -d
195
  > ```
196
 
197
+ ## 🪛 ソースコードでDockerイメージを作成(埋め込みモデルなし)
198
 
199
+ この Docker イメージのサイズは約 1GB で、外部の大モデルと埋め込みサービスに依存しています。
200
 
201
  ```bash
202
  git clone https://github.com/infiniflow/ragflow.git
 
206
  docker build -f Dockerfile.slim -t infiniflow/ragflow:dev-slim .
207
  ```
208
 
209
+ ## 🪚 ソースコードをコンパイルしたDockerイメージ(埋め込みモデルを含む)
210
 
211
+ この Docker のサイズは約 9GB で、埋め込みモデルを含むため、外部の大モデルサービスのみが必要です。
212
 
213
  ```bash
214
  git clone https://github.com/infiniflow/ragflow.git
 
218
  docker build -f Dockerfile -t infiniflow/ragflow:dev .
219
  ```
220
 
221
+ ## 🔨 ソースコードからサービスを起動する方法
222
 
223
+ 1. Poetry をインストールする。すでにインストールされている場合は、このステップをスキップしてください:
224
  ```bash
225
  curl -sSL https://install.python-poetry.org | python3 -
226
  ```
227
 
228
+ 2. ソースコードをクローンし、Python の依存関係をインストールする:
229
  ```bash
230
  git clone https://github.com/infiniflow/ragflow.git
231
  cd ragflow/
 
233
  ~/.local/bin/poetry install --sync --no-root # install RAGFlow dependent python modules
234
  ```
235
 
236
+ 3. Docker Compose を使用して依存サービス(MinIOElasticsearchRedisMySQL)を起動する:
237
  ```bash
238
  docker compose -f docker/docker-compose-base.yml up -d
239
  ```
240
 
241
+ `/etc/hosts` に以下の行を追加して、**docker/service_conf.yaml** に指定されたすべてのホストを `127.0.0.1` に解決します:
242
  ```
243
  127.0.0.1 es01 mysql minio redis
244
  ```
245
+ **docker/service_conf.yaml** mysql のポートを `5455` に、es のポートを `1200` に更新します(**docker/.env** に指定された通り).
246
 
247
+ 4. HuggingFace にアクセスできない場合は、`HF_ENDPOINT` 環境変数を設定してミラーサイトを使用してください:
248
 
249
  ```bash
250
  export HF_ENDPOINT=https://hf-mirror.com
251
  ```
252
 
253
+ 5. バックエンドサービスを起動する:
254
  ```bash
255
  source .venv/bin/activate
256
  export PYTHONPATH=$(pwd)
257
  bash docker/launch_backend_service.sh
258
  ```
259
 
260
+ 6. フロントエンドの依存関係をインストールする:
261
  ```bash
262
  cd web
263
  npm install --force
264
  ```
265
+ 7. フロントエンドを設定し、**.umirc.ts** `proxy.target` `http://127.0.0.1:9380` に更新します:
266
+ 8. フロントエンドサービスを起動する:
267
  ```bash
268
  npm run dev
269
  ```
270
 
271
+ _以下の画面で、システムが正常に起動したことを示します:_
272
 
273
  ![](https://github.com/user-attachments/assets/0daf462c-a24d-4496-a66f-92533534e187)
274