diff --git a/README.md b/README.md index 413ff064..0e327dd4 100755 --- a/README.md +++ b/README.md @@ -2,20 +2,20 @@ # GoDoxy -[![Quality Gate Status](https://sonarcloud.io/api/project_badges/measure?project=yusing_go-proxy&metric=alert_status)](https://sonarcloud.io/summary/new_code?id=yusing_go-proxy) -![GitHub last commit](https://img.shields.io/github/last-commit/yusing/go-proxy) -[![Lines of Code](https://sonarcloud.io/api/project_badges/measure?project=yusing_go-proxy&metric=ncloc)](https://sonarcloud.io/summary/new_code?id=yusing_go-proxy) +[![Quality Gate Status](https://sonarcloud.io/api/project_badges/measure?project=yusing_go-proxy&metric=alert_status)](https://sonarcloud.io/summary/new_code?id=yusing_godoxy) +![GitHub last commit](https://img.shields.io/github/last-commit/yusing/godoxy) +[![Lines of Code](https://sonarcloud.io/api/project_badges/measure?project=yusing_go-proxy&metric=ncloc)](https://sonarcloud.io/summary/new_code?id=yusing_godoxy) [![](https://dcbadge.limes.pink/api/server/umReR62nRd?style=flat)](https://discord.gg/umReR62nRd) -A lightweight, simple, and [performant](https://github.com/yusing/go-proxy/wiki/Benchmarks) reverse proxy with WebUI. +A lightweight, simple, and [performant](https://github.com/yusing/godoxy/wiki/Benchmarks) reverse proxy with WebUI. -For full documentation, check out **[Wiki](https://github.com/yusing/go-proxy/wiki)** +For full documentation, check out **[Wiki](https://github.com/yusing/godoxy/wiki)** **EN** | 中文 - + @@ -42,14 +42,14 @@ For full documentation, check out **[Wiki](https://github.com/yusing/go-proxy/wi - Effortless configuration - Simple multi-node setup - Error messages is clear and detailed, easy troubleshooting -- Auto SSL cert management (See [Supported DNS-01 Challenge Providers](https://github.com/yusing/go-proxy/wiki/Supported-DNS%E2%80%9001-Providers)) +- Auto SSL cert management (See [Supported DNS-01 Challenge Providers](https://github.com/yusing/godoxy/wiki/Supported-DNS%E2%80%9001-Providers)) - Auto configuration for docker containers - Auto hot-reload on container state / config file changes - **idlesleeper**: stop containers on idle, wake it up on traffic _(optional, see [screenshots](#idlesleeper))_ - HTTP(s) reserve proxy - OpenID Connect support -- [HTTP middleware support](https://github.com/yusing/go-proxy/wiki/Middlewares) -- [Custom error pages support](https://github.com/yusing/go-proxy/wiki/Middlewares#custom-error-pages) +- [HTTP middleware support](https://github.com/yusing/godoxy/wiki/Middlewares) +- [Custom error pages support](https://github.com/yusing/godoxy/wiki/Middlewares#custom-error-pages) - TCP and UDP port forwarding - **Web UI with App dashboard and config editor** - Supports linux/amd64, linux/arm64 @@ -73,7 +73,7 @@ Setup DNS Records point to machine which runs `GoDoxy`, e.g. 2. Run setup script inside the directory, or [set up manually](#manual-setup) ```shell - /bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/yusing/go-proxy/main/scripts/setup.sh)" + /bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/yusing/godoxy/main/scripts/setup.sh)" ``` 3. Start the container `docker compose up -d` and wait for it to be ready @@ -86,15 +86,15 @@ Setup DNS Records point to machine which runs `GoDoxy`, e.g. 1. Make `config` directory then grab `config.example.yml` into `config/config.yml` - `mkdir -p config && wget https://raw.githubusercontent.com/yusing/go-proxy/main/config.example.yml -O config/config.yml` + `mkdir -p config && wget https://raw.githubusercontent.com/yusing/godoxy/main/config.example.yml -O config/config.yml` 2. Grab `.env.example` into `.env` - `wget https://raw.githubusercontent.com/yusing/go-proxy/main/.env.example -O .env` + `wget https://raw.githubusercontent.com/yusing/godoxy/main/.env.example -O .env` 3. Grab `compose.example.yml` into `compose.yml` - `wget https://raw.githubusercontent.com/yusing/go-proxy/main/compose.example.yml -O compose.yml` + `wget https://raw.githubusercontent.com/yusing/godoxy/main/compose.example.yml -O compose.yml` ### Folder structrue @@ -135,7 +135,7 @@ Setup DNS Records point to machine which runs `GoDoxy`, e.g. ## Build it yourself -1. Clone the repository `git clone https://github.com/yusing/go-proxy --depth=1` +1. Clone the repository `git clone https://github.com/yusing/godoxy --depth=1` 2. Install / Upgrade [go (>=1.22)](https://go.dev/doc/install) and `make` if not already diff --git a/README_CHT.md b/README_CHT.md index 189c3365..92a63c5a 100644 --- a/README_CHT.md +++ b/README_CHT.md @@ -2,18 +2,18 @@ # GoDoxy -[![Quality Gate Status](https://sonarcloud.io/api/project_badges/measure?project=yusing_go-proxy&metric=alert_status)](https://sonarcloud.io/summary/new_code?id=yusing_go-proxy) -![GitHub last commit](https://img.shields.io/github/last-commit/yusing/go-proxy) -[![Lines of Code](https://sonarcloud.io/api/project_badges/measure?project=yusing_go-proxy&metric=ncloc)](https://sonarcloud.io/summary/new_code?id=yusing_go-proxy) +[![Quality Gate Status](https://sonarcloud.io/api/project_badges/measure?project=yusing_go-proxy&metric=alert_status)](https://sonarcloud.io/summary/new_code?id=yusing_godoxy) +![GitHub last commit](https://img.shields.io/github/last-commit/yusing/godoxy) +[![Lines of Code](https://sonarcloud.io/api/project_badges/measure?project=yusing_go-proxy&metric=ncloc)](https://sonarcloud.io/summary/new_code?id=yusing_godoxy) [![](https://dcbadge.limes.pink/api/server/umReR62nRd?style=flat)](https://discord.gg/umReR62nRd) -輕量、易用、 [高效能](https://github.com/yusing/go-proxy/wiki/Benchmarks)，且帶有主頁和配置面板的反向代理 +輕量、易用、 [高效能](https://github.com/yusing/godoxy/wiki/Benchmarks)，且帶有主頁和配置面板的反向代理 -完整文檔請查閱 **[Wiki](https://github.com/yusing/go-proxy/wiki)**（暫未有中文翻譯） +完整文檔請查閱 **[Wiki](https://github.com/yusing/godoxy/wiki)**（暫未有中文翻譯） - + EN | **中文** @@ -42,14 +42,14 @@ - 輕鬆配置 - 簡單的多節點設置 - 錯誤訊息清晰詳細，易於排除故障 -- 自動 SSL 憑證管理（參見 [支援的 DNS-01 驗證提供商](https://github.com/yusing/go-proxy/wiki/Supported-DNS%E2%80%9001-Providers)） +- 自動 SSL 憑證管理（參見 [支援的 DNS-01 驗證提供商](https://github.com/yusing/godoxy/wiki/Supported-DNS%E2%80%9001-Providers)） - 自動配置 Docker 容器 - 容器狀態/配置文件變更時自動熱重載 - **閒置休眠**：在閒置時停止容器，有流量時喚醒（_可選，參見[截圖](#閒置休眠)_） - HTTP(s) 反向代理 - OpenID Connect 支持 -- [HTTP 中介軟體支援](https://github.com/yusing/go-proxy/wiki/Middlewares) -- [自訂錯誤頁面支援](https://github.com/yusing/go-proxy/wiki/Middlewares#custom-error-pages) +- [HTTP 中介軟體支援](https://github.com/yusing/godoxy/wiki/Middlewares) +- [自訂錯誤頁面支援](https://github.com/yusing/godoxy/wiki/Middlewares#custom-error-pages) - TCP 和 UDP 埠轉發 - **網頁介面，具有應用儀表板和配置編輯器** - 支援 linux/amd64、linux/arm64 @@ -73,7 +73,7 @@ 2. 在目錄內運行安裝腳本，或[手動安裝](#手動安裝) ```shell - /bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/yusing/go-proxy/main/scripts/setup.sh)" + /bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/yusing/godoxy/main/scripts/setup.sh)" ``` 3. 啟動容器 `docker compose up -d` 並等待就緒 @@ -86,15 +86,15 @@ 1. 建立 `config` 目錄，然後將 `config.example.yml` 下載到 `config/config.yml` - `mkdir -p config && wget https://raw.githubusercontent.com/yusing/go-proxy/main/config.example.yml -O 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/go-proxy/main/.env.example -O .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/go-proxy/main/compose.example.yml -O compose.yml` + `wget https://raw.githubusercontent.com/yusing/godoxy/main/compose.example.yml -O compose.yml` ### 資料夾結構 @@ -127,7 +127,7 @@ ## 自行編譯 -1. 克隆儲存庫 `git clone https://github.com/yusing/go-proxy --depth=1` +1. 克隆儲存庫 `git clone https://github.com/yusing/godoxy --depth=1` 2. 如果尚未安裝，請安裝/升級 [go (>=1.22)](https://go.dev/doc/install) 和 `make` diff --git a/config.example.yml b/config.example.yml index 462413fe..275d853e 100644 --- a/config.example.yml +++ b/config.example.yml @@ -15,7 +15,7 @@ # options: # auth_token: c1234565789-abcdefghijklmnopqrst # your zone API token -# 3. other providers, see https://github.com/yusing/go-proxy/wiki/Supported-DNS%E2%80%9001-Providers#supported-dns-01-providers +# 3. other providers, see https://github.com/yusing/godoxy/wiki/Supported-DNS%E2%80%9001-Providers#supported-dns-01-providers entrypoint: # Below define an example of middleware config @@ -73,7 +73,7 @@ providers: # url: https://discord.com/api/webhooks/... # template: discord # this means use payload template from internal/notif/templates/discord.json -# Check https://github.com/yusing/go-proxy/wiki/Certificates-and-domain-matching#domain-matching +# Check https://github.com/yusing/godoxy/wiki/Certificates-and-domain-matching#domain-matching # for explaination of `match_domains` # # match_domains: diff --git a/package.json b/package.json index 5806bdef..45c4789e 100644 --- a/package.json +++ b/package.json @@ -5,7 +5,7 @@ "license": "MIT", "repository": { "type": "git", - "url": "https://github.com/yusing/go-proxy" + "url": "https://github.com/yusing/godoxy" }, "files": [ "schemas/", diff --git a/scripts/install-agent.sh b/scripts/install-agent.sh index 8396efa5..6b6d05ba 100644 --- a/scripts/install-agent.sh +++ b/scripts/install-agent.sh @@ -55,7 +55,7 @@ else echo "Unsupported architecture: $arch, expect x86_64 or aarch64" exit 1 fi -repo="yusing/go-proxy" +repo="yusing/godoxy" install_path="/usr/local/bin" name="godoxy-agent" bin_path="${install_path}/${name}" diff --git a/scripts/setup.sh b/scripts/setup.sh index 04e56199..ff675f01 100755 --- a/scripts/setup.sh +++ b/scripts/setup.sh @@ -39,7 +39,7 @@ echo "Using ${DOWNLOAD_TOOL} for downloads" # } # Environment variables with defaults -REPO="yusing/go-proxy" +REPO="yusing/godoxy" BRANCH=${BRANCH:-"main"} REPO_URL="https://github.com/$REPO" WIKI_URL="${REPO_URL}/wiki"