KrugleBiblio‐Deployment‐Guide - krugle-jp/Krugle-Library GitHub Wiki

Krugle Biblio導入手順書

1. 概要

本手順書では、以下の2つのパッケージを使用して、Flow LiteとKrugle Biblioを導入する手順を説明します。

区分 製品 / コンポーネント パッケージ例 GPU
A Flow Lite GPU flow-lite-gpu-*.tar.gz 必須
B Krugle Biblio biblio-*.tar.gz -

導入順序は必ず以下の順番で実施してください。

A → B

Krugle BiblioとFlow Liteは一つのGPUを搭載したホスト上に導入します。


2. 前提条件

2.1 パッケージのダウンロード

以下の3つのパッケージが、あらかじめ導入対象サーバー上に配置されていることを確認してください。

https://downloads.krugle.org/.archaea/
 flow-lite-gpu-*.tar.gz
 biblio-*.tar.gz
 
 checkpoints.tgz [Option]

2.2 HTTPS用証明書ファイルの準備

HTTPS通信用の証明書ファイルを準備してください。

例:自己証明書の場合

openssl req -newkey rsa:4096 -nodes -sha256 -keyout server.key -x509 -days 3650 -out server.crt

以降の手順では例として以下のファイル名を使用します。

server.crt
server.key

3. A: Flow Lite GPU の導入

3.1 パッケージの展開

tar -xzf flow-lite-gpu-*.tar.gz
cd flow-lite-gpu

3.2 インストーラーの実行

sudo ./install.sh

インストール中に表示されるプロンプトに従って、以下の内容を入力します。

  • 出力言語
  • マルチモーダルモデル名
  • マルチモーダルモデル用のAPIキー

3.3 [Option] checkpointモデルの展開

このステップは、デフォルトの日本語パーサーLinguastarに替えてIngestarを使用する場合にのみ必要ですので、通常はスキップしてください。

tar -xzf checkpoints.tgz -C /opt/flow-lite/

3.4 Flow Lite サービスの起動

sudo systemctl start flow-lite

3.5 ライセンス登録

Flow Lite のみライセンス登録が必要です。

まず、フィンガープリントファイルを作成します。

cd /opt/flow-lite
sudo ./fingerprint.sh > fingerprint.txt

作成された fingerprint.txt をKrugle担当者へご送付ください。

ライセンスファイルarchaea.licを受領したら、以下の場所に保存します。

/opt/flow-lite/archaea.lic

注意:

  • ライセンスファイルを受領するまで、以降のステップへの進行はお待ちください。

3.6 Flow Lite の再起動

ライセンスファイル配置後、Flow Lite を再起動します。

sudo systemctl start flow-lite

4. B: Krugle Biblio の導入

4.1 パッケージの展開

tar -xzf biblio-*.tar.gz
cd biblio

4.2 インストーラーの実行

sudo ./install.sh
Install system dependencies? (y/n): y

AI Response Language (English/Japanese/Chinese) [English]: Japanese

Multi-Modal LLM Model [gpt-5.2]: <your LLM model>
Multi-Modal LLM API Host[https://api.openai.com/v1]: <your API URL> 
Multi-Modal LLM API Key: <your API Key>   

Flow Lite Service Host [flow-lite]:  

LLM Model [gpt-5.2]: <your LLM model>
LLM API Host [https://api.openai.com/v1]: <your API URL> 
LLM API Key:  <your API Key>   


Embedding Model [text-embedding-3-large]: <your embedding model>
Embedding Dimension [3072]: <your embedding dimention>
Embedding API Key: 

インストール中求められる Flow Lite Service Host に対し、今回の「Flow Liteを同一ホスト上で動かす場合」にはデフォルトのままか、あるいはflow-liteと回答します。

Flow Lite が別のGPUサーバー上にある場合は、Flow Lite サーバーのIPアドレスを入力します。 例:192.168.0.1

インストール手順中で設定された内容について、導入完了後は随時環境変数定義ファイル/opt/biblio/.envで変更することができます。

4.3 HTTPS証明書の配置

Biblio Web UI 用のSSL証明書を配置します。

sudo cp server.crt server.key /opt/biblio/webui/ssl/

4.4 Biblio サービスの起動

sudo systemctl start biblio

4.5 データベースマイグレーションの実行

Biblio サービス起動後に、データベースマイグレーションを実行します。

sudo /opt/biblio/db-migrate.sh

注意:

  • db-migrate.sh は、必ず Biblio 起動後に実行してください。

5. Krugle Biblioへのアクセス確認

導入完了後、ブラウザから以下のURLにアクセスします。 <host> には、導入したサーバーのホスト名またはIPアドレスを指定してください。

https://<host>/
  • デフォルトの管理ユーザ::admin/123456
  • ログイン後、実際に利用されるユーザごとにアカウントを作成してください

6. 運用・メンテナンス

6.1 サービス名一覧

区分 コンポーネント systemdサービス名
A Flow Lite flow-lite
B Krugle Biblio biblio

6.2 サービスの起動・停止・再起動・状態確認

例:Biblio を再起動する場合

sudo systemctl restart biblio

例:Biblio の状態を確認する場合

sudo systemctl status biblio

一般的な操作は以下の形式で実行します。

sudo systemctl start <service-name>
sudo systemctl stop <service-name>
sudo systemctl restart <service-name>
sudo systemctl status <service-name>

例:

sudo systemctl restart flow-lite
sudo systemctl restart biblio

6.3 稼働中コンテナの確認

Dockerコンテナの稼働状況を確認します。

docker ps
docker stats

6.4 コンテナログの確認

例:manufact-api コンテナのログを確認する場合

docker logs -f manufact-api

6.5 設定変更後の再起動

製品の設定ファイルを変更した場合は、対象サービスを再起動します。

例:ArcFact の設定を変更する場合

sudo nano /opt/arcfact/.env
sudo systemctl restart arcfact

7. 運用上の注意事項

7.1 起動・停止は systemctl を使用してください

各サービスの起動、停止、再起動には、原則として systemctl を使用してください。

sudo systemctl restart flow-lite

docker compose を直接使用して起動・停止することは推奨されません。

7.2 docker compose を手動実行する場合

やむを得ず docker compose を手動で実行する場合は、必要な環境変数を読み込んだ上で実行してください。

例:ArcFact の compose 状態を確認する場合

cd /opt/biblio
sudo bash -c 'set -a; . ./compose.env; docker compose ps'

8. 自動起動について

以下の4サービスは、サーバー再起動時に自動起動します。

flow-lite
biblio

9. 再起動時の影響範囲

操作 影響
biblio の再起動 Biblioサービスのみ再起動します。
Flow Liteサービスには影響ありません。
flow-lite の再起動 Flow Lite を利用する処理に一時的な影響があります。
BiblioやArcFact(Squad)などのサービス自体には影響しません。

10. 導入完了確認チェックリスト

以下を確認してください。

  • Flow Lite が起動していること
  • Flow Lite のライセンスファイル /opt/flow-lite/archaea.lic が配置されていること
  • Biblio が起動していること
  • Biblio のDBマイグレーションが完了していること
  • https://<host>/biblio/ で Krugle Biblio にアクセスできること
  • docker ps で関連コンテナが起動していること

⚠️ **GitHub.com Fallback** ⚠️