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

Krugle COMBO (Biblio + Squad) インストール手順書

1. 概要

本手順書では、以下の4つのパッケージを使用して、Flow Lite、Krugle Biblio、ArcFact、および Combo Gateway を導入する手順を説明します。

区分 製品 / コンポーネント パッケージ例 導入先
A Flow Lite GPU flow-lite-gpu-*.tar.gz GPUホスト
B Krugle Biblio biblio-*.tar.gz Biblio / ArcFactホスト
C ArcFact krugle-squad-*.tar.gz Biblio / ArcFactホスト
D Combo Gateway combo-*.tar.gz Biblio / ArcFactホスト

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

A → B → C → D

Krugle Biblio、ArcFact、Combo Gateway は同一ホスト上に導入します。
Flow Lite は同一ホストに導入することも、別のGPUサーバーに導入することも可能です。


2. 前提条件

2.1 インストーラーパッケージのダウンロード

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

2.2 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 の導入

この手順書では、Flow LiteをKrugle BiblioとSquad(ArcFact)と同一の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 のみライセンス登録が必要です。

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

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

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

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

/opt/flow-lite/archaea.lic

注意:

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

3.5 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. C: Krugle Squad (ArcFact) の導入

Krugle Squad (ArcFact) を導入します。

5.1 パッケージの展開

tar -xzf krugle-squad-*.tar.gz
cd krugle-squad

5.2 インストーラーの実行

sudo ./install.sh

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

  • LLM APIキー
  • LLM API URL
  • 利用するLLMモデル名
  • Flow Lite URL [同一ホスト上の場合は http://flow-lite:8000]

5.3 HTTPS証明書の配置

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

sudo cp server.crt server.key /opt/arcfact/ssl/

5.4 エージェント言語の日本語化

環境変数.envを編集して、エージェントがプロンプトで使用する言語を日本語化します。

sudo vi /opt/arcfact/.env
PROMPT_LANGUAGE=jp ##デフォルトはenになっている箇所をjpに変更してください

5.5 注意事項

この時点では ArcFact を起動しないでください。

Combo Gateway の導入手順で Krugle Squad (ArcFact) が正しく起動されます。
ここで ArcFact を起動すると、Biblio と競合する可能性があります。


6. D: Combo Gateway の導入

Combo Gateway は、Krugle Biblio と Squad(ArcFact) を1つのWebアドレス配下にまとめるためのゲートウェイです。

6.1 パッケージの展開

tar -xzf combo-*.tar.gz
cd combo

6.2 インストーラーの実行

sudo ./install.sh

6.3 HTTPS証明書の配置

Combo Gateway が利用する証明書を配置します。

cp server.crt combo/ssl/server.crt
cp server.key combo/ssl/server.key

6.4 combo-gateway サービスの起動

sudo systemctl start combo-gateway

Combo Gateway の導入により、Biblio と Squad(ArcFact) が同一アドレス配下で利用できるようになります。


7. アクセス確認

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

7.1 Krugle Squad(ArcFact) へのアクセス

https://<host>/
  • 初回のログインには今すぐ登録から招待コード を使用したアカウント登録が必要です。
  • 招待コードは/opt/arcfact/.env 中のINVITATION_CODEで設定してください。(default:ano94great)   

7.2 Krugle Biblio へのアクセス

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

8. 日常運用・メンテナンス

8.1 サービス名一覧

区分 コンポーネント systemdサービス名
A Flow Lite flow-lite
B Krugle Biblio biblio
C ArcFact arcfact
D Combo Gateway combo-gateway

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

例:ArcFact を再起動する場合

sudo systemctl restart arcfact

例: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
sudo systemctl restart arcfact
sudo systemctl restart combo-gateway

8.3 稼働中コンテナの確認

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

docker ps

8.4 コンテナログの確認

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

docker logs -f manufact-api

8.5 設定変更後の再起動

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

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

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

9. 運用上の注意事項

9.1 起動・停止は systemctl を使用する

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

sudo systemctl restart arcfact

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

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

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

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

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

10. 自動起動について

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

flow-lite
biblio
arcfact
combo-gateway

11. 再起動時の影響範囲

操作 影響
arcfact の再起動 ArcFact のみ再起動されます。比較的安全で、他サービスへの影響は限定的です。
biblio の再起動 一時的に ArcFact から Biblio への接続に影響する可能性があります。ArcFact は再接続します。
combo-gateway の再起動 Webアクセス先に一瞬影響しますが、通常は短時間で復旧します。
flow-lite の再起動 Flow Lite を利用する処理に一時的な影響があります。

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

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

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

13. 導入手順の要約

# A: Flow Lite
tar -xzf flow-lite-gpu-*.tar.gz
cd flow-lite-gpu
sudo ./install.sh
sudo systemctl start flow-lite
cd /opt/flow-lite
sudo ./fingerprint.sh > fingerprint.txt
# ライセンス発行後、/opt/flow-lite/archaea.lic に配置
sudo systemctl restart flow-lite

# B: Krugle Biblio
tar -xzf biblio-*.tar.gz
cd biblio
sudo ./install.sh
sudo cp server.crt server.key /opt/biblio/webui/ssl/
sudo systemctl start biblio
sudo /opt/biblio/db-migrate.sh

# C: ArcFact
tar -xzf krugle-squad-*.tar.gz
cd krugle-squad
sudo ./install.sh
# ここでは起動しない

# D: Combo Gateway
tar -xzf combo-*.tar.gz
cd combo
cp your.crt combo/ssl/server.crt
cp your.key combo/ssl/server.key
sudo ./install.sh

以上で、Combo構成の導入は完了です。

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