README.md

GoDoxy

繁體中文文檔請看此

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

Join our Discord for help and discussions

Table of content

• GoDoxy
  • Table of content
  • Key Features
  • Getting Started
    • Prerequisites
    • Setup
    • Manual Setup
    • Folder structrue
    • Use JSON Schema in VSCode
  • 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

Getting Started

For full documentation, See Wiki

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

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 WebUI login (skip if you use OIDC)

   • set random JWT secret

     sed -i "s|API_JWT_SECRET=.*|API_JWT_SECRET=$(openssl rand -base64 32)|g" .env

   • change username and password for WebUI authentication

     USERNAME=admin
     PASSWORD=some-password
     sed -i "s|API_USERNAME=.*|API_USERNAME=${USERNAME}|g" .env
     sed -i "s|API_PASSWORD=.*|API_PASSWORD=${PASSWORD}|g" .env

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

5. Start the container docker compose up -d

6. You may now do some extra configuration on WebUI https://gp.y.z

🔼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

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

🔼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