GoDoxy/README_CHT.md

GoDoxy

輕量、易用、 高效能，且帶有主頁和配置面板的反向代理

網站 | 文檔 | Discord

EN | 中文

目錄

• GoDoxy
  • 目錄
  • 運行示例
  • 主要特點
  • 前置需求
  • 安裝
    • 手動安裝
    • 資料夾結構
  • 截圖
    • 閒置休眠
    • 監控
  • 自行編譯

運行示例

https://demo.godoxy.dev

主要特點

• 簡單易用
  • 透過 Docker標籤或 WebUI 輕鬆設定
  • 簡單的多節點設置
  • 詳細的錯誤訊息，便於故障排除
• 存取控制 (ACL)：連線/請求層級存取控制
  • IP/CIDR
  • 國家 (需要 Maxmind 帳戶)
  • 時區 (需要 Maxmind 帳戶)
  • 存取日誌記錄
• 自動化
  • 使用 Let's Encrypt 自動管理 SSL 憑證 (使用 DNS-01 驗證)
  • Docker 容器自動配置
  • 設定檔與容器狀態變更時自動熱重載
• 閒置休眠：根據流量停止和喚醒容器 (參見截圖)
  • Docker 容器
  • Proxmox LXC 容器
• 流量管理
  • HTTP 反向代理
  • TCP/UDP 連接埠轉送
  • OpenID Connect 支援：輕鬆實現單點登入 (SSO) 並保護您的應用程式
• 客製化
  • HTTP 中介軟體
  • 支援自訂錯誤頁面
• 網頁使用者介面 (Web UI)
  • 應用程式一覽
  • 設定編輯器
  • 執行時間與系統指標
  • Docker 日誌檢視器
• 跨平台支援
  • 支援 linux/amd64 與 linux/arm64
• 高效能
  • 以 Go 語言編寫

🔼 回到頂部

前置需求

設置 DNS 記錄指向運行 GoDoxy 的機器，例如：

• A 記錄：*.y.z -> 10.0.10.1
• AAAA 記錄：*.y.z -> ::ffff:a00:a01

安裝

Note

GoDoxy 僅在 host 網路模式下運作，請勿更改。

如需更改監聽埠，請修改 .env。

1. 準備一個新目錄用於 docker compose 和配置文件。

2. 在目錄內運行安裝腳本，或手動安裝

   /bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/yusing/godoxy/main/scripts/setup.sh)"
   

3. 現在可以在 WebUI https://godoxy.yourdomain.com 進行額外配置

🔼 回到頂部

手動安裝

1. 建立 config 目錄，然後將 config.example.yml 下載到 config/config.yml

   mkdir -p config && wget https://raw.githubusercontent.com/yusing/godoxy/main/config.example.yml -O config/config.yml

2. 將 .env.example 下載到 .env

   wget https://raw.githubusercontent.com/yusing/godoxy/main/.env.example -O .env

3. 將 compose.example.yml 下載到 compose.yml

   wget https://raw.githubusercontent.com/yusing/godoxy/main/compose.example.yml -O compose.yml

資料夾結構

├── certs
│   ├── cert.crt
│   └── priv.key
├── compose.yml
├── config
│   ├── config.yml
│   ├── middlewares
│   │   ├── middleware1.yml
│   │   ├── middleware2.yml
│   ├── provider1.yml
│   └── provider2.yml
├── data
│   ├── metrics # metrics data
│   │   ├── uptime.json
│   │   └── system_info.json
└── .env

截圖

閒置休眠

🔼 回到頂部

監控

運行時間監控	Docker 日誌	伺服器概覽
系統監控	圖表

自行編譯

1. 克隆儲存庫 git clone https://github.com/yusing/godoxy --depth=1

2. 如果尚未安裝，請安裝/升級 go (>=1.22) 和 make

3. 如果之前編譯過（go < 1.22），請使用 go clean -cache 清除快取

4. 使用 make get 獲取依賴

5. 使用 make build 編譯二進制檔案

🔼 回到頂部