From beb46e2cdb3e6bfeb976f44a677991bde9ecd1fb Mon Sep 17 00:00:00 2001 From: yusing Date: Thu, 6 Feb 2025 00:56:11 +0800 Subject: [PATCH] readme and docker compose example amendment --- README.md | 39 ++++++++++++++++++++------------------- README_CHT.md | 40 ++++++++++++++++++++-------------------- compose.example.yml | 10 +++++----- 3 files changed, 45 insertions(+), 44 deletions(-) diff --git a/README.md b/README.md index 1238e7a..9f71aba 100755 --- a/README.md +++ b/README.md @@ -1,19 +1,25 @@ +
+ # 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) -[![Security Rating](https://sonarcloud.io/api/project_badges/measure?project=yusing_go-proxy&metric=security_rating)](https://sonarcloud.io/summary/new_code?id=yusing_go-proxy) +[![](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. + +For full documentation, check out **[Wiki](https://github.com/yusing/go-proxy/wiki)** + +**EN** | 中文 + + -[繁體中文文檔請看此](README_CHT.md) + -A lightweight, easy-to-use, and [performant](https://github.com/yusing/go-proxy/wiki/Benchmarks) reverse proxy with a Web UI and dashboard. - -![Screenshot](https://github.com/user-attachments/assets/4bb371f4-6e4c-425c-89b2-b9e962bdd46f) - -_Join our [Discord](https://discord.gg/umReR62nRd) for help and discussions_ +
## Table of content @@ -22,9 +28,8 @@ _Join our [Discord](https://discord.gg/umReR62nRd) for help and discussions_ - [GoDoxy](#godoxy) - [Table of content](#table-of-content) - [Key Features](#key-features) - - [Getting Started](#getting-started) - - [Prerequisites](#prerequisites) - - [Setup](#setup) + - [Prerequisites](#prerequisites) + - [Setup](#setup) - [Manual Setup](#manual-setup) - [Folder structrue](#folder-structrue) - [Use JSON Schema in VSCode](#use-json-schema-in-vscode) @@ -53,18 +58,14 @@ _Join our [Discord](https://discord.gg/umReR62nRd) for help and discussions_ [🔼Back to top](#table-of-content) -## Getting Started - -For full documentation, **[See Wiki](https://github.com/yusing/go-proxy/wiki)** - -### Prerequisites +## Prerequisites Setup DNS Records point to machine which runs `GoDoxy`, e.g. - A Record: `*.y.z` -> `10.0.10.1` - AAAA Record: `*.y.z` -> `::ffff:a00:a01` -### Setup +## Setup 1. Pull the latest docker images @@ -98,7 +99,7 @@ Setup DNS Records point to machine which runs `GoDoxy`, e.g. 5. Start the container `docker compose up -d` -6. You may now do some extra configuration on WebUI `https://gp.y.z` +6. You may now do some extra configuration on WebUI `https://godoxy.domain.com` [🔼Back to top](#table-of-content) diff --git a/README_CHT.md b/README_CHT.md index 0edccd5..00568ba 100644 --- a/README_CHT.md +++ b/README_CHT.md @@ -1,19 +1,25 @@ +
+ # 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) -[![Security Rating](https://sonarcloud.io/api/project_badges/measure?project=yusing_go-proxy&metric=security_rating)](https://sonarcloud.io/summary/new_code?id=yusing_go-proxy) +[![](https://dcbadge.limes.pink/api/server/umReR62nRd?style=flat)](https://discord.gg/umReR62nRd) + +輕量、易用、 [高效能](https://github.com/yusing/go-proxy/wiki/Benchmarks)，且帶有主頁和配置面板的反向代理 + +完整文檔請查閱 **[Wiki](https://github.com/yusing/go-proxy/wiki)**（暫未有中文翻譯） + + -[English Documentation](README.md) +EN | **中文** -一個輕量級、易於使用且[高效能](https://github.com/yusing/go-proxy/wiki/Benchmarks)的反向代理，具有網頁介面和儀表板。 + -![截圖](screenshots/webui.png) - -_加入我們的 [Discord](https://discord.gg/umReR62nRd) 獲取幫助和討論_ +
## 目錄 @@ -22,9 +28,8 @@ _加入我們的 [Discord](https://discord.gg/umReR62nRd) 獲取幫助和討論_ - [GoDoxy](#godoxy) - [目錄](#目錄) - [主要特點](#主要特點) - - [入門指南](#入門指南) - - [前置需求](#前置需求) - - [安裝](#安裝) + - [前置需求](#前置需求) + - [安裝](#安裝) - [手動安裝](#手動安裝) - [資料夾結構](#資料夾結構) - [在 VSCode 中使用 JSON Schema](#在-vscode-中使用-json-schema) @@ -43,6 +48,7 @@ _加入我們的 [Discord](https://discord.gg/umReR62nRd) 獲取幫助和討論_ - 容器狀態/配置文件變更時自動熱重載 - **閒置休眠**：在閒置時停止容器，有流量時喚醒（_可選，參見[截圖](#閒置休眠)_） - HTTP(s) 反向代理 +- OpenID Connect 支持 - [HTTP 中介軟體支援](https://github.com/yusing/go-proxy/wiki/Middlewares) - [自訂錯誤頁面支援](https://github.com/yusing/go-proxy/wiki/Middlewares#custom-error-pages) - TCP 和 UDP 埠轉發 @@ -52,18 +58,14 @@ _加入我們的 [Discord](https://discord.gg/umReR62nRd) 獲取幫助和討論_ [🔼回到頂部](#目錄) -## 入門指南 - -完整文檔請參見 **[Wiki](https://github.com/yusing/go-proxy/wiki)** - -### 前置需求 +## 前置需求 設置 DNS 記錄指向運行 `GoDoxy` 的機器，例如： - A 記錄：`*.y.z` -> `10.0.10.1` - AAAA 記錄：`*.y.z` -> `::ffff:a00:a01` -### 安裝 +## 安裝 1. 拉取最新的 Docker 映像 @@ -97,9 +99,7 @@ _加入我們的 [Discord](https://discord.gg/umReR62nRd) 獲取幫助和討論_ 5. 啟動容器 `docker compose up -d` -6. 現在您可以進行額外的配置 - - 使用文字編輯器（如 Visual Studio Code） - - 通過網頁介面 `https://gp.y.z` +6. 大功告成!可前往WebUI `https://gp.domain.com` 進行額外的配置 [🔼回到頂部](#目錄) diff --git a/compose.example.yml b/compose.example.yml index fd82f65..2f3ac17 100755 --- a/compose.example.yml +++ b/compose.example.yml @@ -10,11 +10,11 @@ services: - app # modify below to fit your needs labels: - proxy.aliases: gp - proxy.#1.port: 3000 - # proxy.#1.middlewares.cidr_whitelist.status: 403 - # proxy.#1.middlewares.cidr_whitelist.message: IP not allowed - # proxy.#1.middlewares.cidr_whitelist.allow: | + proxy.aliases: godoxy + proxy.godoxy.port: 3000 + # proxy.godoxy.middlewares.cidr_whitelist.status: 403 + # proxy.godoxy.middlewares.cidr_whitelist.message: IP not allowed + # proxy.godoxy.middlewares.cidr_whitelist.allow: | # - 127.0.0.1 # - 10.0.0.0/8 # - 192.168.0.0/16