mirror of
https://github.com/yusing/godoxy.git
synced 2025-05-20 04:42:33 +02:00
144 lines
5.2 KiB
Markdown
Executable file
144 lines
5.2 KiB
Markdown
Executable file
<div align="center">
|
|
|
|
# GoDoxy
|
|
|
|
[](https://sonarcloud.io/summary/new_code?id=yusing_go-proxy)
|
|
|
|
[](https://sonarcloud.io/summary/new_code?id=yusing_go-proxy)
|
|
[](https://discord.gg/umReR62nRd)
|
|
|
|
A lightweight, simple, and [performant](https://github.com/yusing/go-proxy/wiki/Benchmarks) reverse proxy with WebUI.
|
|
|
|
For full documentation, check out **[Wiki](https://github.com/yusing/go-proxy/wiki)**
|
|
|
|
**EN** | <a href="README_CHT.md">中文</a>
|
|
|
|
**Currently working on [feat/godoxy-agent](https://github.com/yusing/go-proxy/tree/feat/godoxy-agent).<br/>Fork this instead of default branch.**
|
|
|
|
<!-- [](https://sonarcloud.io/summary/new_code?id=yusing_go-proxy)
|
|
[](https://sonarcloud.io/summary/new_code?id=yusing_go-proxy)
|
|
[](https://sonarcloud.io/summary/new_code?id=yusing_go-proxy) -->
|
|
|
|
<img src="https://github.com/user-attachments/assets/4bb371f4-6e4c-425c-89b2-b9e962bdd46f" style="max-width: 650">
|
|
|
|
</div>
|
|
|
|
## Table of content
|
|
|
|
<!-- TOC -->
|
|
|
|
- [GoDoxy](#godoxy)
|
|
- [Table of content](#table-of-content)
|
|
- [Key Features](#key-features)
|
|
- [Prerequisites](#prerequisites)
|
|
- [Setup](#setup)
|
|
- [Manual Setup](#manual-setup)
|
|
- [Folder structrue](#folder-structrue)
|
|
- [Screenshots](#screenshots)
|
|
- [idlesleeper](#idlesleeper)
|
|
- [Build it yourself](#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](https://github.com/yusing/go-proxy/wiki/Supported-DNS%E2%80%9001-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](#idlesleeper))_
|
|
- HTTP(s) reserve proxy
|
|
- OpenID Connect support
|
|
- [HTTP middleware support](https://github.com/yusing/go-proxy/wiki/Middlewares)
|
|
- [Custom error pages support](https://github.com/yusing/go-proxy/wiki/Middlewares#custom-error-pages)
|
|
- TCP and UDP port forwarding
|
|
- **Web UI with App dashboard and config editor**
|
|
- Supports linux/amd64, linux/arm64
|
|
- Written in **[Go](https://go.dev)**
|
|
|
|
[🔼Back to top](#table-of-content)
|
|
|
|
## 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
|
|
|
|
**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
|
|
|
|
```shell
|
|
docker pull ghcr.io/yusing/go-proxy:latest
|
|
```
|
|
|
|
2. Create new directory, `cd` into it, then run setup, or [set up manually](#manual-setup)
|
|
|
|
```shell
|
|
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](https://github.com/yusing/go-proxy/wiki/Configurations#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](#table-of-content)
|
|
|
|
### 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
|
|
|
|
```shell
|
|
├── 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](#table-of-content)
|
|
|
|
## Build it yourself
|
|
|
|
1. Clone the repository `git clone https://github.com/yusing/go-proxy --depth=1`
|
|
|
|
2. Install / Upgrade [go (>=1.22)](https://go.dev/doc/install) 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](#table-of-content)
|