Linux環境でのユーザーガイド¶
このドキュメントでは、開発者でない人がLinux環境で広聴AI(kouchou-ai)を使うための手順を説明します。 ソフトウェア開発に必要な要素を取り除いて最小限にしたものです。
前提条件¶
セットアップ手順¶
1. Dockerのインストール¶
- 以下のコマンドを実行して、Dockerをインストールします:
セットアップスクリプトは
sudo apt-get update sudo apt-get install -y docker.io docker-compose-v2 sudo systemctl enable docker sudo systemctl start docker sudo usermod -aG docker $USERdocker compose(Docker Compose v2)を使います。docker-composeパッケージ(旧来の v1)では動かないので、docker-compose-v2を入れてください。Docker 公式の手順でdocker-ceとdocker-compose-pluginを入れても構いません。 - 一度ログアウトして再ログインし、Docker権限を反映させます。
- 以下のコマンドでDockerとDocker Composeが正常に動作していることを確認します:
docker compose versionでバージョンが表示されず、unknown commandなどのエラーになる場合は、Docker Compose v2 が入っていません。手順 1 のdocker-compose-v2のインストールを確認してください。
2. 広聴AIのダウンロード¶
- 広聴AI安定版リリースから最新の安定版をダウンロードします。
- ダウンロードしたzipファイルを任意の場所に展開します:
3. APIキーの準備¶
- OpenAI APIにアクセスし、OpenAI APIキーを取得します(OpenAIモデルを使用する場合)。
- Google AI Studioにアクセスし、Gemini APIキーを取得します(Geminiモデルを使用する場合)。
- 各サービスの利用には課金が発生する場合があります。OpenAI API は従量課金で、ChatGPT Plus とは別の契約で、事前に OpenAI Platform で支払い方法を登録し、残高(クレジット)を用意しておく必要があります(新しく始めるアカウントは前払い方式で、クレジットの購入が必要です)。課金の仕組みと、残高不足・レート制限(429 エラー)の見分け方はAPIの課金と429エラーを参照してください。
4. セットアップの実行¶
- ターミナルを開きます。
- 展開したフォルダに移動します:
cd 展開したフォルダのパス - セットアップスクリプトに実行権限を付与します:
chmod +x setup_linux.sh - 以下のコマンドを実行してセットアップを開始します:
./setup_linux.sh - プロンプトが表示されたら、OpenAI APIキーとGemini APIキーを入力します(どちらか一方でも可)。
- セットアップが自動的に進行し、Dockerコンテナが起動します。
5. アプリケーションへのアクセス¶
セットアップが完了すると、以下のURLでアプリケーションにアクセスできます:
- レポート閲覧画面: http://localhost:3000
- 管理画面: http://localhost:4000
6. アプリケーションのアクセス・運用と再起動の手順¶
セットアップ後は、次回以降の起動や停止を以下のように行ってください。
通常の起動・停止¶
-
アプリケーションの起動:
./start_linux.shを実行します -
アプリケーションの停止:
./stop_linux.shを実行します
APIキーを変更したい場合¶
OpenAI APIキーやGemini APIキーを再設定したい場合は、再度 ./setup_linux.sh を実行してください。
- 既存のアプリケーションが起動中の場合は
./stop_linux.shで停止してください。 ./setup_linux.shを実行し、新しい APIキーを入力します。- 自動的に再ビルドと起動が行われます。
※
setup_linux.shの再実行では、既存の.envファイルが上書きされます。
トラブルシューティング¶
Dockerの権限エラーが発生する場合¶
「permission denied」などのエラーが表示される場合は、以下のコマンドを実行して、現在のユーザーがdockerグループに正しく追加されていることを確認してください:
その後、ログアウトして再ログインしてください。メモリ不足エラーが発生する場合¶
システムリソースが不足している場合は、スワップ領域を増やすことで改善する可能性があります:
永続的にスワップを有効にするには、/etc/fstabに追加してください。