コンテンツにスキップ

⚙️ 設定ガイド (config.json)

iceradar-webui の各種設定項目、設定ファイル(config.json)、およびブラウザ UI からの設定変更仕様について解説します。


1. 設定ファイル (config.json) の保存場所

IceRadar Web UI は、設定を config.json に一本化 して管理します。OS 標準のユーザー設定ディレクトリ(XDG 規格)に保存されます:

OS / インストール形態 設定ファイル (config.json) の保存先
Linux (.deb パッケージ) ~/.config/iceradar-webui/config.json
macOS (.zip) ~/.config/iceradar-webui/config.json
(または ~/Library/Application Support/iceradar-webui/config.json)
Windows (.zip) %APPDATA%\iceradar-webui\config.json

2. Web UI からの設定変更(推奨)

Web UI 右上の 「⚙️ 設定」 ボタンをクリックすると、以下の項目をブラウザから直接安全に編集・保存できます:

  1. 認証設定(アクセスパスワード):
    Web UI にログインパスワードを設定し、不正な観測操作を防ぎます。パスワードを空にして保存すると認証が無効になります。
  2. AI 機能設定(登録式プロバイダ管理):
    AI 相談機能で利用する複数のプロバイダ(Gemini agy CLI, OpenAI Codex CLI, OpenAI API, カスタムLLM等)を登録・管理・アクティブ選択できます。セキュリティのため登録済み API キーは ******** とマスク表示されます。

💡 自動永続化:
Web UI で「保存」ボタンを押すと、即座に上記の config.json に書き込まれ、サーバー再起動後も確実に保持されます。


3. 設定ファイル (config.json) のフォーマット

手動で設定ファイルを編集・作成する場合のフォーマットです:

{
  "authPassword": "your_secure_password",
  "activeProviderId": "provider-1",
  "aiProviders": [
    {
      "id": "provider-1",
      "name": "Gemini agy CLI",
      "type": "agy",
      "cliPath": "agy",
      "cliModel": ""
    },
    {
      "id": "provider-2",
      "name": "OpenAI Codex CLI",
      "type": "codex",
      "cliPath": "codex",
      "cliModel": ""
    },
    {
      "id": "provider-3",
      "name": "OpenAI API Key",
      "type": "openai",
      "apiKey": "sk-proj-...",
      "model": "gpt-4o-mini",
      "baseURL": "https://api.openai.com/v1"
    }
  ],
  "port": "3334",
  "updateURL": "https://iceradar.noiceware.com/downloads/"
}
キー名 デフォルト値 説明
authPassword "" (空) Web UI のログインパスワード。空の場合は認証無効。
activeProviderId "provider-1" デフォルトで使用するアクティブなプロバイダ ID。
aiProviders [...] 登録された AI プロバイダプロファイルのリスト。
port "3334" Web UI サーバーのポート番号。
updateURL https://iceradar.noiceware.com/downloads/ アップデート配信元 URL。

4. 環境変数による一時オーバーライド(管理者・Docker向け)

コンテナ環境や CI/CD などで一時的に設定を上書きしたい場合、以下の OS 環境変数を指定して起動することができます(config.json の値より優先されます):

  • AUTH_PASSWORD: ログインパスワード
  • OPENAI_API_KEY: OpenAI API キー(互換用)
  • PORT または WEBUI_PORT: 起動ポート番号
  • UPDATE_URL: アップデート配信元 URL