Skip to content
此頁面由 AI 翻譯,內容可能有疏漏。歡迎到 GitHub 協助改進。

設定與執行參數 ​

命令列參數 ​

參數說明
-c設定目錄,也可以用環境變數 GATELY_CONFIG_DIR 指定
-listen覆寫管理介面監聽位址,例如 :16680
-apply宣告式設定目錄,也可以用環境變數 GATELY_APPLY_DIR 指定,見下文
-version輸出版本資訊
環境變數說明
GATELY_INITIAL_PASSWORD首次啟動時的管理員初始密碼(至少 8 位),未設定時為預設密碼 gately.cn;帳號已存在時不起作用

設定目錄 ​

所有設定都儲存在設定目錄中,每個模組一個 <name>.json 純文字檔案,原子寫入,檔案權限 0600。因此:

  • 可以直接用文字編輯器檢視;
  • 可以把目錄納入 git,用 diff 稽核每次變更並隨時回復;
  • 備份只需複製目錄。

注意

ssl.json 中含有憑證私鑰,納入版本庫前請確認儲存庫為私有,或把該檔案加入忽略清單。

宣告式設定 ​

指定 -apply <目錄> 後,每次啟動會把該目錄下的 <名稱>.json 覆寫到設定目錄,內容相同的檔案不會重寫。適合把設定放在 git 儲存庫、Kubernetes ConfigMap 或部署指令碼中統一下發。

  • 寫入前驗證是否為合法 JSON,任一檔案無效則拒絕啟動;
  • account.json 與 tokens.json 不允許覆寫,帳號與權杖只能在管理介面管理;
  • 被覆寫的舊內容會保存在 設定歷史 中,可隨時還原。

外部程式目錄 ​

Tailscale、frp、cloudflared 這三個模組託管官方的外部程式,依以下順序尋找可執行檔:

  1. 模組設定中填寫的路徑;
  2. PATH;
  3. 設定目錄下的 bin/ 子目錄。

Docker 部署時把執行檔放進掛載的設定目錄即可,例如 ./gately-data/bin/frpc。Tailscale 需要同時提供 tailscale 與 tailscaled。詳見 Tailscale / frp / cloudflared。

執行日誌 ​

系統日誌與各模組的執行日誌預設寫入設定目錄下的 logs/,重新啟動或升級後仍可在「系統日誌」與各模組頁面查看:

  • 每個來源一個 JSON Lines 檔案:logs/<模組 ID>.log,系統日誌為 logs/gately.log;啟動時依「日誌保留筆數」從檔案還原最近的日誌;
  • 有新日誌時最多延遲 1 秒批次寫入;單一檔案超過上限(預設 2 MB)後輪替為 .1,只保留這一份歷史,每個來源最多占用兩倍上限;
  • 「設定 → 網路與執行 → 執行參數」中可以關閉「日誌落盤」或調整「日誌檔上限」,立即生效;關閉後日誌只保存在記憶體,重新啟動後清空;
  • 在頁面上清空某個模組的日誌會同時刪除對應檔案;
  • 設定備份不包含 logs/ 與操作稽核日誌 audit.log。

備份與還原 ​

「設定」中提供設定備份與還原,並承擔從 Lucky 匯入設定的入口。

以 Apache-2.0 授權條款開源發布。