From e107f8d476c6ca3704dc422062ea746777155367 Mon Sep 17 00:00:00 2001 From: yusing Date: Fri, 25 Apr 2025 10:49:05 +0800 Subject: [PATCH] doc: checkout README from main --- README.md | 44 ++++++++++++++++++++++---------------------- README_CHT.md | 23 ++++++++++++++--------- 2 files changed, 36 insertions(+), 31 deletions(-) diff --git a/README.md b/README.md index 9bf84fc..f87d1d0 100755 --- a/README.md +++ b/README.md @@ -5,6 +5,7 @@ [![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) +![Demo](https://img.shields.io/website?url=https%3A%2F%2Fgodoxy.demo.6uo.me&label=Demo&link=https%3A%2F%2Fgodoxy.demo.6uo.me) [![Discord](https://dcbadge.limes.pink/api/server/umReR62nRd?style=flat)](https://discord.gg/umReR62nRd) A lightweight, simple, and [performant](https://github.com/yusing/godoxy/wiki/Benchmarks) reverse proxy with WebUI. @@ -13,10 +14,6 @@ For full documentation, check out **[Wiki](https://github.com/yusing/godoxy/wiki **EN** | 中文 - - @@ -27,6 +24,7 @@ For full documentation, check out **[Wiki](https://github.com/yusing/godoxy/wiki - [GoDoxy](#godoxy) - [Table of content](#table-of-content) + - [Running demo](#running-demo) - [Key Features](#key-features) - [Prerequisites](#prerequisites) - [How does GoDoxy work](#how-does-godoxy-work) @@ -38,25 +36,29 @@ For full documentation, check out **[Wiki](https://github.com/yusing/godoxy/wiki - [Folder structrue](#folder-structrue) - [Build it yourself](#build-it-yourself) +## Running demo + + + +[![Deployed on Zeabur](https://zeabur.com/deployed-on-zeabur-dark.svg)](https://zeabur.com/referral?referralCode=yusing&utm_source=yusing&utm_campaign=oss) + ## Key Features - Easy to use - Effortless configuration - Simple multi-node setup with GoDoxy agents or Docker Socket Proxies - Error messages is clear and detailed, easy troubleshooting -- Auto SSL with Let's Encrypt (See [Supported DNS-01 Challenge Providers](https://github.com/yusing/go-proxy/wiki/Supported-DNS%E2%80%9001-Providers)) -- Auto hot-reload on container state / config file changes -- Container aware: create routes dynamically from running docker containers +- **Auto SSL** with Let's Encrypt (See [Supported DNS-01 Challenge Providers](https://github.com/yusing/go-proxy/wiki/Supported-DNS%E2%80%9001-Providers)) +- **Auto hot-reload** on container state / config file changes +- **Container aware**: create routes dynamically from running docker containers - **idlesleeper**: stop and wake containers based on traffic _(optional, see [screenshots](#idlesleeper))_ - HTTP reserve proxy and TCP/UDP port forwarding -- OpenID Connect integration: SSO and secure your apps easily +- **OpenID Connect integration**: SSO and secure your apps easily - [HTTP middleware](https://github.com/yusing/go-proxy/wiki/Middlewares) and [Custom error pages support](https://github.com/yusing/go-proxy/wiki/Middlewares#custom-error-pages) - **Web UI with App dashboard, config editor, _uptime and system metrics_, _docker logs viewer_** -- Supports linux/amd64 and linux/arm64 +- Supports **linux/amd64** and **linux/arm64** - Written in **[Go](https://go.dev)** -[🔼Back to top](#table-of-content) - ## Prerequisites Setup Wildcard DNS Record(s) for machine running `GoDoxy`, e.g. @@ -71,13 +73,17 @@ Setup Wildcard DNS Record(s) for machine running `GoDoxy`, e.g. 3. Create a route if applicable (a route is like a "Virtual Host" in NPM) 4. Watch for container / config changes and update automatically -GoDoxy uses the label `proxy.aliases` as the subdomain(s), if unset it defaults to the `container_name` field in docker compose. - -For example, with the label `proxy.aliases: qbt` you can access your app via `qbt.domain.com`. +> [!NOTE] +> GoDoxy uses the label `proxy.aliases` as the subdomain(s), if unset it defaults to the `container_name` field in docker compose. +> +> For example, with the label `proxy.aliases: qbt` you can access your app via `qbt.domain.com`. ## Setup -**NOTE:** GoDoxy is designed to be (and only works when) running in `host` network mode, do not change it. To change listening ports, modify `.env`. +> [!NOTE] +> GoDoxy is designed to be running in `host` network mode, do not change it. +> +> To change listening ports, modify `.env`. 1. Prepare a new directory for docker compose and config files. @@ -87,11 +93,7 @@ For example, with the label `proxy.aliases: qbt` you can access your app via `qb /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 - -4. You may now do some extra configuration on WebUI `https://godoxy.yourdomain.com` - -[🔼Back to top](#table-of-content) +3. You may now do some extra configuration on WebUI `https://godoxy.yourdomain.com` ## Screenshots @@ -124,8 +126,6 @@ For example, with the label `proxy.aliases: qbt` you can access your app via `qb -[🔼Back to top](#table-of-content) - ## Manual Setup 1. Make `config` directory then grab `config.example.yml` into `config/config.yml` diff --git a/README_CHT.md b/README_CHT.md index cfe8f6f..68bf81f 100644 --- a/README_CHT.md +++ b/README_CHT.md @@ -5,16 +5,13 @@ [![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/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_go-proxy) -[![](https://dcbadge.limes.pink/api/server/umReR62nRd?style=flat)](https://discord.gg/umReR62nRd) +![Demo](https://img.shields.io/website?url=https%3A%2F%2Fgodoxy.demo.6uo.me&label=Demo&link=https%3A%2F%2Fgodoxy.demo.6uo.me) +[![Discord](https://dcbadge.limes.pink/api/server/umReR62nRd?style=flat)](https://discord.gg/umReR62nRd) 輕量、易用、 [高效能](https://github.com/yusing/godoxy/wiki/Benchmarks)，且帶有主頁和配置面板的反向代理 完整文檔請查閱 **[Wiki](https://github.com/yusing/godoxy/wiki)**（暫未有中文翻譯） - - EN | **中文** @@ -27,6 +24,7 @@ - [GoDoxy](#godoxy) - [目錄](#目錄) + - [運行示例](#運行示例) - [主要特點](#主要特點) - [前置需求](#前置需求) - [安裝](#安裝) @@ -37,6 +35,12 @@ - [監控](#監控) - [自行編譯](#自行編譯) +## 運行示例 + + + +[![Deployed on Zeabur](https://zeabur.com/deployed-on-zeabur-dark.svg)](https://zeabur.com/referral?referralCode=yusing&utm_source=yusing&utm_campaign=oss) + ## 主要特點 - 容易使用 @@ -65,7 +69,10 @@ ## 安裝 -**注意：** GoDoxy 設計為（且僅在）`host` 網路模式下運作，請勿更改。如需更改監聽埠，請修改 `.env`。 +> [!NOTE] +> GoDoxy 僅在 `host` 網路模式下運作，請勿更改。 +> +> 如需更改監聽埠，請修改 `.env`。 1. 準備一個新目錄用於 docker compose 和配置文件。 @@ -75,9 +82,7 @@ /bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/yusing/godoxy/main/scripts/setup.sh)" ``` -3. 啟動容器 `docker compose up -d` 並等待就緒 - -4. 現在可以在 WebUI `https://godoxy.yourdomain.com` 進行額外配置 +3. 現在可以在 WebUI `https://godoxy.yourdomain.com` 進行額外配置 [🔼回到頂部](#目錄)