# 操作ガイド

### 概要

本ドキュメントでは、`miniprem.sh`スクリプトを使用したMiniPremサービスの制御方法について説明します。

\*\*本スクリプトは Ubuntu 24.04 環境、または該当サーバーへ SSH で接続したターミナル上で実行することを前提としています。\*\*コマンドは、物理端末やリモート（SSH）接続したターミナルで操作してください。

### 操作できる条件

* MiniPremのインストールが完了していること
* `miniprem.sh`スクリプトに実行権限があること

### コマンド一覧

**基本構文**

```bash
./miniprem.sh [コマンド] [オプション]
```

**利用可能なコマンド**

| コマンド      | 説明                          | 使用例                     |
| --------- | --------------------------- | ----------------------- |
| `start`   | MiniPremサービスを起動します          | `./miniprem.sh start`   |
| `stop`    | MiniPremサービスを停止します          | `./miniprem.sh stop`    |
| `restart` | MiniPremサービスを再起動します         | `./miniprem.sh restart` |
| `status`  | サービスの稼働状況を確認します             | `./miniprem.sh status`  |
| `logs`    | サービスのログをリアルタイムで表示します        | `./miniprem.sh logs`    |
| `setup`   | Flowise chatflowの初期設定を実行します | `./miniprem.sh setup`   |

**オプション**

| オプション          | 説明             |
| -------------- | -------------- |
| `-h`, `--help` | ヘルプメッセージを表示します |

### 詳細な使用方法

**サービスの起動**

```bash
./miniprem.sh start
```

このコマンドは以下の処理を実行します：

* インストールタイプ（default/custom）に応じた適切なDocker Composeファイルを選択
* 必要なDockerコンテナを起動
* サービスの起動状況をログに出力

**サービスの停止**

実行中のすべてのMiniPremサービスを安全に停止します。

```bash
./miniprem.sh stop
```

**サービスの再起動**

サービスを一度停止してから再起動します。設定変更後などに使用します。

```bash
./miniprem.sh restart
```

**ステータス確認**

```bash
./miniprem.sh status
```

出力例：

```
+=================================================================+
| MiniPrem Services Status                                          |
+=================================================================+

NAME                      IMAGE                                                   COMMAND                  SERVICE                   CREATED             STATUS                 PORTS
renny                     facemeproduction/renny:0.540-40978                      "/opt/renny/entrypoi…"   renny                     7 hours ago         Up 7 hours (healthy)   

```

**ログの確認**

```bash
./miniprem.sh logs
```

すべてのサービスのログをリアルタイムで表示します。`Ctrl+C`で終了できます。

**Flowise Chatflowのセットアップ**

```bash
./miniprem.sh setup
```

このコマンドは以下の処理を実行します：

1. Flowiseサービスの稼働確認
2. サービスが停止している場合は自動的に起動
3. Flowiseが完全に起動するまで待機（最大5分）
4. Chatflowの初期設定スクリプトを実行

### 動作検証

1. **コンテナの状態確認**

MiniPrem関連のコンテナが正常に起動していることを確認します。

```bash
docker ps
```

2. **サービスの動作確認**

すべてのサービスが「Up」状態であることを確認します。

```bash
./miniprem.sh status
```

**3. 動作テスト**

実行中のセッション内で、デジタルヒューマンに対して発話指示を送信し、以下の機能が正常に動作することを確認します：

* レンダリング - デジタルヒューマンが表示されるか
* 音声合成 - TTSで音声が生成されるか
* アニメーションやリップシンクしているか
* 会話AI（オーケストレーションサービス）との接続ができて、会話ができるか

### 技術仕様

**インストールタイプ**

MiniPremは2つのインストールタイプをサポートしています：

* **default**: 基本的な構成（`docker/docker-compose.default.yml`を使用）
* **custom**: カスタマイズされた構成（`docker/docker-compose.yml`を使用）

インストールタイプは`.miniprem_install_type`ファイルに保存されます。

主要な環境変数は`docker/docker-compose.env` ファイルに保存されます。

**ディレクトリ構造**

```
miniprem/
├── miniprem.sh          # メイン制御スクリプト
├── scripts/
│   ├── logging.sh       # ログ出力関数
│   └── docker.sh        # Docker操作関数
├── docker/
│   ├── docker-compose.yml
│   ├── docker-compose.default.yml
│   ├── docker-compose.env
│   └── setup-chatflow-post-deployment.sh
└── .miniprem_install_type

```

### 注意事項

* スクリプトは必ずプロジェクトのルートディレクトリから実行してください
* サービスの起動・停止には適切な権限が必要です
* ログファイルは定期的に確認し、必要に応じてローテーションを行ってください


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://docs.digitalhumans.jp/dev/miniprem/miniprem-usage.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.