GoDoxy

A lightweight, simple, and performant reverse proxy with WebUI.

For full documentation, check out Wiki

EN | 中文

Table of content

• GoDoxy
  • Table of content
  • Key Features
  • Prerequisites
  • Setup
    • Manual Setup
    • Folder structrue
  • Screenshots
    • idlesleeper
  • Build it yourself

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
• OpenID Connect support
• HTTP middleware support
• Custom error pages support
• TCP and UDP port forwarding
• Web UI with App dashboard and config editor
• Supports linux/amd64, linux/arm64
• Written in Go

🔼Back to top

Prerequisites

1. 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

2. Create shell alias:

   # for main server
   alias godoxy="docker exec godoxy /app/godoxy"
   
   # for agent server
   alias godoxy-agent="docker exec godoxy-agent /app/godoxy-agent"
   

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.

1. Pull the latest docker images

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

2. Create new directory, cd into it, then run setup, or set up manually

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

3. (Optional) setup docker-socket-proxy other docker nodes (see Multi docker nodes setup) then add them inside config.yml

4. Start the container docker compose up -d

5. You may now do some extra configuration on WebUI https://godoxy.domain.com

🔼Back to top

Manual Setup

1. Make config directory then grab config.example.yml into config/config.yml

   mkdir -p config && wget https://raw.githubusercontent.com/yusing/go-proxy/v0.9/config.example.yml -O config/config.yml

2. Grab .env.example into .env

   wget https://raw.githubusercontent.com/yusing/go-proxy/v0.9/.env.example -O .env

3. Grab compose.example.yml into compose.yml

   wget https://raw.githubusercontent.com/yusing/go-proxy/v0.9/compose.example.yml -O compose.yml

Folder structrue

├── certs
│   ├── cert.crt
│   └── priv.key
├── compose.yml
├── config
│   ├── config.yml
│   ├── middlewares
│   │   ├── middleware1.yml
│   │   ├── middleware2.yml
│   ├── provider1.yml
│   └── provider2.yml
└── .env

Screenshots

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