TyleoDvDelaware3217/GoDoxy
1
0
Fork 0
mirror of https://github.com/yusing/godoxy.git synced 2025-05-19 20:32:35 +02:00
Code Issues Projects Releases Packages Wiki Activity Actions
Easy to use reverse proxy with docker integration
243 commits 7 branches 89 tags 207 MiB
Find a file
yusing 03cad9f315 added package version api, dependencies upgrade
2024-10-06 09:23:41 +08:00
.github/workflows added package version api, dependencies upgrade 2024-10-06 09:23:41 +08:00
.vscode fixed event name missing 2024-10-04 06:51:26 +08:00
cmd added package version api, dependencies upgrade 2024-10-06 09:23:41 +08:00
examples added some docker compose examples; fixed defaults to wrong host; updated watcher behavior to retry connection every 3 secs until success or until cancelled 2024-09-22 04:00:08 +08:00
internal added package version api, dependencies upgrade 2024-10-06 09:23:41 +08:00
pkg added package version api, dependencies upgrade 2024-10-06 09:23:41 +08:00
schema updated schema for homepage fields 2024-10-04 01:00:06 +08:00
screenshots readme updates, docs moved to wiki 2024-10-04 11:27:11 +08:00
scripts added package version api, dependencies upgrade 2024-10-06 09:23:41 +08:00
.gitignore restructured the project to comply community guideline, for others check release note 2024-09-28 09:51:34 +08:00
.gitlab-ci.yml added package version api, dependencies upgrade 2024-10-06 09:23:41 +08:00
.gitmodules refactor file names, readme updates, removed frontend submodule as it is being built independently 2024-09-25 11:22:25 +08:00
compose.example.yml fixed dashboard stats update 2024-10-04 18:52:31 +08:00
config.example.yml added explicit only mode for docker provider, updated dependencies 2024-09-29 11:24:41 +08:00
Dockerfile added package version api, dependencies upgrade 2024-10-06 09:23:41 +08:00
go.mod added package version api, dependencies upgrade 2024-10-06 09:23:41 +08:00
go.sum added package version api, dependencies upgrade 2024-10-06 09:23:41 +08:00
LICENSE added license 2024-04-01 04:08:48 +00:00
Makefile added package version api, dependencies upgrade 2024-10-06 09:23:41 +08:00
providers.example.yml readme updates, docs moved to wiki 2024-10-04 11:27:11 +08:00
README.md readme updates, docs moved to wiki 2024-10-04 11:27:11 +08:00
README_CHT.md readme updates, docs moved to wiki 2024-10-04 11:27:11 +08:00

README.md

go-proxy

Quality Gate Status Lines of Code Security Rating Maintainability Rating Vulnerabilities

繁體中文文檔請看此

A lightweight, easy-to-use, and performant reverse proxy with a Web UI and dashboard.

Screenshot

Join our Discord for help and discussions

Table of content

Key Features

  • Easy to use
    • Effortless configuration
    • Simple multi-node setup
    • Error messages is clear and detailed, easy troubleshooting
  • Auto SSL cert management (See Supported DNS-01 Challenge 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)
  • HTTP(s) reserve proxy
  • HTTP middleware support
  • Custom error pages support
  • TCP and UDP port forwarding
  • Web UI with App dashboard
  • Supports linux/amd64, linux/arm64
  • Written in Go

🔼Back to top

Getting Started

Setup

  1. Pull docker image

    docker pull ghcr.io/yusing/go-proxy:latest

  2. Create new directory, cd into it, then run setup

    docker run --rm -v .:/setup ghcr.io/yusing/go-proxy /app/go-proxy setup

  3. Setup DNS Records point to machine which runs go-proxy, e.g.

    • A Record: *.y.z -> 10.0.10.1
    • AAAA Record: *.y.z -> ::ffff:a00:a01

  4. Setup docker-socket-proxy other docker nodes (if any) (see Multi docker nodes setup) and then them inside config.yml

  5. Done. You may now do some extra configuration

    • With text editor (e.g. Visual Studio Code)
    • With Web UI via http://localhost:3000 or https://gp.y.z
    • For more info, See Wiki

🔼Back to top |

Use JSON Schema in VSCode

Copy .vscode/settings.example.json to .vscode/settings.json and modify it to fit your needs

🔼Back to top

Screenshots

idlesleeper

idlesleeper

🔼Back to top

Build it yourself

  1. Clone the repository git clone https://github.com/yusing/go-proxy --depth=1

  2. Install / Upgrade go (>=1.22) and make if not already

  3. Clear cache if you have built this before (go < 1.22) with go clean -cache

  4. get dependencies with make get

  5. build binary with make build

🔼Back to top