メインコンテンツまでスキップ

設定の構成

設定は「秘密情報」と「公開設定」に分かれています。

ファイル置くもの
.env秘密情報・API キー・トークン・マシン固有の絶対パス
config/config.yml秘密でないアプリ設定・Vault 内の相対パス・バックアップ対象・機能の既定値

config/config.example.yml と .env.example をコピーして編集します。

cp config/config.example.yml config/config.yml
cp .env.example .env

.env の主な項目​

必須​

  • OBSIDIAN_AI_HUB_API_TOKEN — Web UI / API の Bearer トークン。空だとサーバーは起動しません。

Vault のパスは .env には置きません。config/config.yml の vaults に絶対パスを直接記載します(下記)。

環境・保存先​

  • LOCAL_MODEL_DIR — ローカル埋め込みモデルのダウンロードキャッシュ。
  • AI_LOG_PATH — AI ログ出力先。
  • OBSIDIAN_AI_HUB_HOST / OBSIDIAN_AI_HUB_PORT — 待ち受けアドレス / ポート。
  • HEALTHCARE_SQLITE_PATH / HEALTHCARE_EXPORT_DIR — ヘルスケア DB / エクスポート先。
  • VAULT_INDEX_SQLITE_PATH / VAULT_INDEX_CHROMA_PATH — Vault インデックス保存先。
  • IMAGE_GENERATION_OUTPUT_DIR — 生成画像の保存先(config.yml の image_generation.output_dir を上書き。既定は Vault 外)。

画像生成(任意)​

IMAGE_GENERATION_INPUT_DIR(画像編集の相対パス入力の基準。既定は Vault)、 IMAGE_GENERATION_MODEL、IMAGE_GENERATION_DEFAULT_SIZE、IMAGE_GENERATION_DEFAULT_QUALITY、 IMAGE_GENERATION_MAX_COUNT、IMAGE_GENERATION_MAX_INPUT_BYTES、 IMAGE_GENERATION_LOCK_LLM_QUALITY、IMAGE_GENERATION_LLM_QUALITY。 設定すると YAML より優先されます(画像生成)。

資格情報​

  • Gmail: GMAIL_CLIENT_SECRET_PATH(既定 ~/.config/obsidian-ai-hub/gmail/client_secret.json)、GMAIL_TOKEN_PATH(既定 ~/.config/obsidian-ai-hub/gmail/token.json)
  • LLM: OPENAI_API_KEY、GEMINI_API_KEY、OPENCODE_API_KEY
  • 検索 / 調査: TAVILY_API_KEY、HUGGINGFACE_API_KEY
  • Open WebUI: OPEN_WEB_UI_API_KEY、OPEN_WEB_UI_BASE_URL
  • LINE: LINE_MESSAGING_TOKEN、LINE_CHANNEL_SECRET、LINE_ALLOWED_USER_IDS、LINE_TARGET_ID
  • Apple: APPLE_CALENDAR_NAME
  • OBSIDIAN_AI_HUB_WEB_URL — LINE 通知などに載せる公開ベース URL

コーディング(任意)​

CODING_ORCHESTRATOR_PROVIDER、CODING_ORCHESTRATOR_MODEL、CODING_OPENCODE_CLI_PATH、 CODING_OPENCODE_MODEL、CODING_OPENCODE_MODELS。設定すると YAML より優先されます。

読み上げ(任意)​

TTS_ENABLED、TTS_PROVIDER、TTS_BASE_URL、TTS_MODEL、TTS_VOICE、TTS_ENGINE、 TTS_KOKORO_MODEL、TTS_KOKORO_VOICE、TTS_CACHE_DIR、TTS_CACHE_MAX_BYTES、 TTS_MAX_CHARS。設定すると YAML より優先されます (AIエージェント)。

接続先は YAML の tts.provider で選びます。provider がない既存の設定は mlx_audio(ローカルの MLX)として扱われます。TTS_API_KEY だけは YAML に 書かず、.env に置きます。

リモートの OpenAI 互換プロバイダ(HTTPS 必須。正規化した本文が接続先へ送られます):

tts:
enabled: true
provider: openai_compatible
base_url: https://tts.example.com/v1 # /v1 まで。アプリが /audio/speech を付ける
model: gpt-4o-mini-tts
voice: alloy
# .env
TTS_API_KEY=...

ローカルの認証なし OpenAI 互換サーバー(loopback の HTTP は許可。キー不要):

tts:
enabled: true
provider: openai_compatible
base_url: http://127.0.0.1:8080/v1
model: kokoro
voice: jf_alpha

非 loopback の HTTP や、https://user:pass@host/... のような資格情報入りの URL は 読み上げ時に拒否されます(設定不正として 503)。

音声入力(任意)​

エージェント会話の入力欄マイクは、この設定で動きます (AIエージェント)。 環境変数 STT_ENABLED、STT_PROVIDER、STT_MODEL、STT_LANGUAGE、 STT_LOCAL_DEVICE、STT_IDLE_UNLOAD_SECONDS、STT_MAX_UPLOAD_BYTES、 STT_MAX_DURATION_SECONDS、STT_REQUEST_TIMEOUT_SECONDS、STT_BASE_URL は YAML より優先されます。STT_API_KEY だけは YAML に書かず、.env に置きます。

既定(provider がない場合も同じ)は Web サーバープロセス内のローカル Whisper です。 録音は文字起こし後に削除され、保存されません。

stt:
enabled: true
provider: local_whisper # local_whisper | openai_compatible
model: medium
language: ja
local_device: mps # mps | cpu
idle_unload_seconds: 900 # 未使用で解放するまで
max_upload_bytes: 26214400 # 25 MiB
max_duration_seconds: 300 # 5分
request_timeout_seconds: 300
  • 初回の録音時にモデルを読み込みます。しばらく使わないとメモリから解放されます。
  • local_device: mps で失敗した場合、CPU へ自動で切り替えずエラーになります。 必要なら local_device: cpu を明示してください。
  • 検証には ffprobe(ffmpeg)が必要です。無い場合は 503 になります。

リモートの OpenAI 互換プロバイダ(HTTPS 必須。録音が接続先へ送られます):

stt:
enabled: true
provider: openai_compatible
base_url: https://stt.example.com/v1 # /v1 まで。アプリが /audio/transcriptions を付ける
model: whisper-1
language: ja
# .env
STT_API_KEY=...

非 loopback の HTTP、リダイレクト、資格情報入りの URL は拒否されます。リモートを 選んだ場合だけ音声が外部へ送られ、ローカルの Whisper へは自動で切り替わりません。

config/config.yml の構成​

config/config.example.yml に定義されている主なトップレベルキー:

キー内容
ai_log_pathAI ログのパス
vaultsVault Registry(Vault ID → パス・表示名・role・ai_access)。main は必須かつ唯一の role: primary。各ルートは既存ディレクトリで重複・入れ子不可
primary_vaultmain 専用の既存業務フォルダ名(inbox / daily / template / knowledge / research / activity / webclip / people / dashboard)。blog / ai に同じ構造は要求しない。dashboard のみ旧来の vault.dashboard で上書きできる
filesファイル名(日次ノート、週次テンプレート、リサーチ候補テーマリストなど)
backup.sync_folders--backup の rsync 対象(source / destination / 任意の excludes)
backup.rsync_executable--backup で使う rsync の実行ファイル絶対パス(未設定時は rsync)
location_map場所文字列 → 表示名の変換
regularly_date_events / regularly_weekday_events定期的な予定の定義(時刻付きも可)
llm用途ごとの LLM プロバイダ・モデル・プロンプト上書き(LLM プロバイダ)
agent_skills.rootAgent Skills のルート
researchリサーチの既定出力スタイル・文脈・ディープリサーチ設定
vault_indexVault 検索インデックスの collection / 保存先 / 埋め込みモデル。保存先は Vault ごとの基準ディレクトリとして使い、実体は <基準>/<vault_id>/ 配下に分離される
retrieval汎用 Retrieval 検索(長期記憶)の Chroma 保存先 / collection(埋め込みモデルは vault_index.embedder_model を流用)
review_draft週次レビュー下書きでの Coach Goal / Focus 上限数(max_goals: 既定 5、max_focuses_per_goal: 既定 3、最新順)
codingコーディングのオーケストレーターと OpenCode ACP 設定(コーディング設定)
image_generation画像生成の保存先・モデル・既定サイズ/品質(画像生成)
youtube文字起こし言語・Whisper モデル・要約チャンク文字数

memory と healthcare は任意の追加セクションです。

vaults:
main:
path: /Users/you/Documents/Obsidian
display_name: Personal
role: primary
ai_access: read # AI の検索・読取りは可、汎用書込みは不可
blog:
path: /Users/you/Documents/Blog
display_name: Blog
ai_access: write # 通常 Agent が無承認で書込み可
ai:
path: /Users/you/Documents/AI-Workspace
display_name: AI Workspace
ai_access: write

ai_access は none(AI の検索・読取りも不可)/ read / write のいずれかです。 main への汎用 AI 書込みは常に拒否されます(対象を primary に固定した日次・Inbox 等の内部フローは除く)。 設定が不正だと Web は起動せず、make status-web に理由が表示されます(トラブルシューティング)。

memory:
context_max_tokens: 800
agent_context_max_tokens: 400
agent_retrieval_threshold: 0.45
agent_retrieval_top_k: 5
extractor:
provider: ollama
model: glm-4.7:cloud
agent_conversation:
enabled: true # Webチャット会話を週次メモリ抽出のソースに含める
max_messages: 300 # 1週あたりに渡すメッセージ数
max_total_chars: 60000 # 1週あたりの合計文字数
max_user_chars: 4000 # ユーザー発話1件の上限(0で無制限)
max_assistant_chars: 2000 # エージェント返答1件の上限(文脈用・0で無制限)
purposes:
review-draft:
kinds: [preference, decision_policy]
budget: 400 # ユーザースコープの文脈上限
format: fenced # または "evidence"
include_person: false

healthcare:
sqlite_path: /Users/you/.config/obsidian-ai-hub/healthcare.sqlite3
export_dir: /Users/you/.config/obsidian-ai-hub/healthcare/apple_health_export

tts:
enabled: true
provider: mlx_audio # mlx_audio | openai_compatible
base_url: http://127.0.0.1:8768
engine: kokoro # kokoro | irodori
kokoro_model: mlx-community/Kokoro-82M-bf16
kokoro_voice: jf_alpha # 日本語 voice pack
cache_dir: /Users/you/.config/obsidian-ai-hub/tts-cache
cache_max_bytes: 1073741824 # 1 GiB、古い順に削除

stt:
enabled: true
provider: local_whisper # local_whisper | openai_compatible
model: medium
language: ja
local_device: mps # mps | cpu
idle_unload_seconds: 900
max_upload_bytes: 26214400 # 25 MiB
max_duration_seconds: 300 # 5分
request_timeout_seconds: 300

OpenAI 互換プロバイダの設定例は 読み上げ(任意) と 音声入力(任意) を参照してください。

日次・週次・月次の構造化要約には長期記憶を注入しません。既存の memory.purposes.summarize-day / summarize-week / summarize-month の設定は要約生成では参照されないため、削除できます。

プロンプトの上書き​

同梱のプロンプトは直接編集せず、コピー先を llm.<name>.prompt_path に向けます。 詳細は LLM プロバイダ を参照してください。

テスト環境の設定​

ENV=test のときは config/config.test.yml が使われ、本番の .env は読み込まれません。 書き込み先は一時ディレクトリへリダイレクトされます(CLI の基本 を参照)。

次に読む​