Windows環境でのユーザーガイド¶
このドキュメントでは、開発者でない人がWindows環境で広聴AI（kouchou-ai）を使うための手順を説明します。 ソフトウェア開発に必要な要素を取り除いて最小限にしたものです。
前提条件¶
セットアップ手順¶
1. Docker Desktopのインストール¶
- Docker Desktop for Windowsをダウンロードしてインストールします。
- インストール後、コンピューターを再起動してください（Dockerコマンドのパスを正しく設定するために必要です）。
- 再起動後、Docker Desktopを明示的に起動します（自動起動の設定をしていない場合は毎回必要です）。
- タスクバーのDockerアイコンが実行中（緑色）になっていることを確認します。
2. 広聴AIのダウンロード¶
- 広聴AI安定版リリースから最新の安定版をダウンロードします。
- ダウンロードしたzipファイルを任意の場所に展開します。
3. APIキーの準備¶
- OpenAI APIにアクセスし、OpenAI APIキーを取得します（OpenAIモデルを使用する場合）。
- Google AI Studioにアクセスし、Gemini APIキーを取得します（Geminiモデルを使用する場合）。
- APIキーをコピーして、メモ帳などに一時的に保存しておくと便利です。
- 重要: APIキーは正確にコピーしてください。入力ミスがあると、後の処理でエラーが発生します。
4. セットアップの実行¶
- 展開したフォルダ内の
setup_win.batファイルをダブルクリックします。 - プロンプトが表示されたら、OpenAI APIキーとGemini APIキーを入力します（どちらか一方でも可）。
- 注意: Ctrl+Vでの貼り付けができない場合は、右クリックして「貼り付け」を選択してください。
- セットアップが自動的に進行し、APIキーの有効性確認後にDockerコンテナが起動します。
5. アプリケーションへのアクセス¶
セットアップが完了すると、以下のURLでアプリケーションにアクセスできます：
- レポート閲覧画面: http://localhost:3000
- 管理画面: http://localhost:4000
6. アプリケーションのアクセス・運用と再起動の手順¶
セットアップ後は、次回以降の起動や停止を以下のように行ってください。
通常の起動・停止¶
-
アプリケーションの起動:
フォルダ内のstart_win.batをダブルクリックします（または Docker デスクトップから操作） -
アプリケーションの停止:
stop_win.batをダブルクリックします（または Docker デスクトップから操作）
APIキーを変更したい場合¶
OpenAI APIキーやGemini APIキーを再設定したい場合は、再度 setup_win.bat を実行してください。
- 既存のアプリケーションが起動中の場合は
stop_win.batで停止してください。 setup_win.batを実行し、新しい APIキーを入力します。- 自動的に再ビルドと起動が行われます。
※
setup_win.batの再実行では、既存の.envファイルが上書きされます。
トラブルシューティング¶
Docker Desktopが起動していない場合¶
エラーメッセージ「Docker Desktopが実行されていません」が表示された場合は、Docker Desktopを起動してから再度setup_win.batを実行してください。Docker Desktopは自動起動設定をしていない限り、毎回手動で起動する必要があります。
Dockerコマンドが認識されない場合¶
Dockerをインストールした直後は、コマンドのパスが通っていない場合があります。コンピューターを再起動してから再度試してください。
APIキーの入力に関する問題¶
- 貼り付けができない場合: コマンドプロンプトではCtrl+Vが機能しないことがあります。右クリックして「貼り付け」を選択するか、Alt+Spaceキーを押してから「編集」→「貼り付け」を選択してください。 APIキーが正しく動作しない場合: APIキーが正確にコピーされているか確認してください。OpenAI APIキーは「sk-」で始まります。Gemini APIキーは「AIza」で始まります。入力ミスがあると、後の処理でエラーが発生します。
WSL2の有効化が必要な場合¶
Docker Desktopの初回起動時にWSL2の有効化を求められた場合は、指示に従ってWSL2を有効化してください。詳細はMicrosoft公式ドキュメントを参照してください。
メモリ不足エラーが発生する場合¶
Docker Desktopの設定からリソース割り当て（メモリ、CPU）を増やしてください。推奨設定：
- メモリ: 4GB以上
- CPU: 2コア以上