環境變數參考手冊 (Reference)
Time Compass 使用 .env 檔案管理所有 API 憑證與運作模式。
1. 核心憑證 (Core Auth)
| 變數名稱 | 說明 | 必填 |
GOOGLE_CLIENT_SECRETS_FILE | credentials.json 的絕對路徑 | 是 |
NTUST_ACCOUNT | 臺科大 Moodle 帳號 (學號) | 是 |
NTUST_PASSWORD | 臺科大 Moodle 密碼 | 是 |
2. 展示與開發模式 (Dev Mode)
| 變數名稱 | 說明 | 預設值 |
MCP_DEV_MODE | 是否進入零憑證展示模式 (1 開啟, 0 關閉) | 0 |
DEV_MODE_DATA_PATH | Mock 資料路徑(目前程式碼未啟用,固定讀 assets/fixtures/snapshots) | (保留) |
3. 進階設定
| 變數名稱 | 說明 |
GOOGLE_CLIENT_SECRETS_DICT | (可選) 憑證 JSON 內容字串,若設定則優先於檔案。 |
PYTHONUTF8 | 建議設為 1 以避免 Windows 編碼問題。 |
4. 變數加載邏輯
- 優先讀取作業系統環境變數。
- 其次讀取根目錄下的
.env 檔案。 - 如果
GOOGLE_CLIENT_SECRETS_FILE 指向的路徑不存在且 GOOGLE_CLIENT_SECRETS_DICT 為空,系統啟動時會拋出 ConfigurationError。
[!IMPORTANT] 請勿將 .env 或 token.json 提交到 Git 倉庫。本專案已包含 .gitignore 保護這些隱私檔案。
5. 延伸閱讀
- LiteLLM Proxy 與 Gradio 配置指南:
docs/reference/litellm-proxy-guide.md