go-proxy

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

Table of content

Easy to use
- Effortless configuration
- Simple multi-node setup
- Error messages is clear and detailed, easy troubleshooting
Auto SSL cert management (See Supported DNS 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 showcase)
HTTP(s) reserve proxy
HTTP middleware support (experimental)
Custom error pages support
TCP and UDP port forwarding
Web UI for configuration and monitoring (See screenshots)
Supports linux/amd64, linux/arm64, linux/arm/v7, linux/arm/v6 multi-platform
Written in Go

Pull docker image

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

Create new directory, cd into it, then run setup

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

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
Setup docker-socket-proxy other docker nodes (if any) (see example) and then them inside config.yml
Done. You may now do some extra configuration
- With text editor (e.g. Visual Studio Code)
- With Web UI via gp.y.z
- For more info, See docker.md

Argument	Description	Example
empty	start proxy server
`validate`	validate config and exit
`reload`	trigger a force reload of config
`ls-config`	list config and exit	`go-proxy ls-config \| jq`
`ls-route`	list proxy entries and exit	`go-proxy ls-route \| jq`

run with docker exec go-proxy /app/go-proxy <command>

Environment Variable	Description	Default	Values
`GOPROXY_NO_SCHEMA_VALIDATION`	disable schema validation	`false`	boolean
`GOPROXY_DEBUG`	enable debug behaviors	`false`	boolean
`GOPROXY_HTTP_ADDR`	http server listening address	`:80`	`[host]:port`
`GOPROXY_HTTPS_ADDR`	https server listening address (if enabled)	`:443`	`[host]:port`
`GOPROXY_API_ADDR`	api server listening address	`127.0.0.1:8888`	`[host]:port`