base on Easy to use reverse proxy with docker integration <div align="center"> # GoDoxy [](https://sonarcloud.io/summary/new_code?id=yusing_godoxy)  [](https://sonarcloud.io/summary/new_code?id=yusing_godoxy)  [](https://discord.gg/umReR62nRd) A lightweight, simple, and [performant](https://github.com/yusing/godoxy/wiki/Benchmarks) reverse proxy with WebUI. <h5> <a href="https://docs.godoxy.dev">Website</a> | <a href="https://docs.godoxy.dev/Home.html">Wiki</a> | <a href="https://discord.gg/umReR62nRd">Discord</a> </h5> <h5>EN | <a href="README_CHT.md">中文</a></h5> <img src="screenshots/webui.jpg" style="max-width: 650"> </div> ## Table of content <!-- TOC --> - [GoDoxy](#godoxy) - [Table of content](#table-of-content) - [Running demo](#running-demo) - [Key Features](#key-features) - [Prerequisites](#prerequisites) - [Setup](#setup) - [How does GoDoxy work](#how-does-godoxy-work) - [Screenshots](#screenshots) - [idlesleeper](#idlesleeper) - [Metrics and Logs](#metrics-and-logs) - [Manual Setup](#manual-setup) - [Folder structrue](#folder-structrue) - [Build it yourself](#build-it-yourself) ## Running demo <https://demo.godoxy.dev> [](https://zeabur.com/referral?referralCode=yusing&utm_source=yusing&utm_campaign=oss) ## Key Features - **Simple** - Effortless configuration with [simple labels](https://github.com/yusing/godoxy/wiki/Docker-labels-and-Route-Files) or WebUI - [Simple multi-node setup](https://github.com/yusing/godoxy/wiki/Configurations#multi-docker-nodes-setup) - Detailed error messages for easy troubleshooting. - **ACL**: connection / request level access control - IP/CIDR - Country **(Maxmind account required)** - Timezone **(Maxmind account required)** - **Access logging** - **Advanced Automation** - Automatic SSL certificate management with Let's Encrypt ([using DNS-01 Challenge](https://github.com/yusing/go-proxy/wiki/Supported-DNS%E2%80%9001-Providers)) - Auto-configuration for Docker containers - Hot-reloading of configurations and container state changes - **Idle-sleep**: stop and wake containers based on traffic _(see [screenshots](#idlesleeper))_ - Docker containers - Proxmox LXCs - **Traffic Management** - HTTP reserve proxy - TCP/UDP port forwarding - **OpenID Connect support**: SSO and secure your apps easily - **Customization** - [HTTP middlewares](https://github.com/yusing/go-proxy/wiki/Middlewares) - [Custom error pages support](https://github.com/yusing/go-proxy/wiki/Middlewares#custom-error-pages) - **Web UI** - App Dashboard - Config Editor - Uptime and System Metrics - Docker Logs Viewer - **Cross-Platform support** - Supports **linux/amd64** and **linux/arm64** - **Efficient and Performant** - Written in **[Go](https://go.dev)** ## Prerequisites Configure Wildcard DNS Record(s) to point to machine running `GoDoxy`, e.g. - A Record: `*.domain.com` -> `10.0.10.1` - AAAA Record (if you use IPv6): `*.domain.com` -> `::ffff:a00:a01` ## Setup > [!NOTE] > GoDoxy is designed to be running in `host` network mode, do not change it. > > To change listening ports, modify `.env`. 1. Prepare a new directory for docker compose and config files. 2. Run setup script inside the directory, or [set up manually](#manual-setup) ```shell /bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/yusing/godoxy/main/scripts/setup.sh)" ``` 3. You may now do some extra configuration on WebUI `https://godoxy.yourdomain.com` ## How does GoDoxy work 1. List all the containers 2. Read container name, labels and port configurations for each of them 3. Create a route if applicable (a route is like a "Virtual Host" in NPM) 4. Watch for container / config changes and update automatically > [!NOTE] > GoDoxy uses the label `proxy.aliases` as the subdomain(s), if unset it defaults to the `container_name` field in docker compose. > > For example, with the label `proxy.aliases: qbt` you can access your app via `qbt.domain.com`. ## Screenshots ### idlesleeper  ### Metrics and Logs <div align="center"> <table> <tr> <td align="center"><img src="screenshots/uptime.png" alt="Uptime Monitor" width="250"/></td> <td align="center"><img src="screenshots/docker-logs.jpg" alt="Docker Logs" width="250"/></td> <td align="center"><img src="screenshots/docker.jpg" alt="Server Overview" width="250"/></td> </tr> <tr> <td align="center"><b>Uptime Monitor</b></td> <td align="center"><b>Docker Logs</b></td> <td align="center"><b>Server Overview</b></td> </tr> <tr> <td align="center"><img src="screenshots/system-monitor.jpg" alt="System Monitor" width="250"/></td> <td align="center"><img src="screenshots/system-info-graphs.jpg" alt="Graphs" width="250"/></td> </tr> <tr> <td align="center"><b>System Monitor</b></td> <td align="center"><b>Graphs</b></td> </tr> </table> </div> ## Manual Setup 1. Make `config` directory then grab `config.example.yml` into `config/config.yml` `mkdir -p config && wget https://raw.githubusercontent.com/yusing/godoxy/main/config.example.yml -O config/config.yml` 2. Grab `.env.example` into `.env` `wget https://raw.githubusercontent.com/yusing/godoxy/main/.env.example -O .env` 3. Grab `compose.example.yml` into `compose.yml` `wget https://raw.githubusercontent.com/yusing/godoxy/main/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 ├── data │ ├── metrics # metrics data │ │ ├── uptime.json │ │ └── system_info.json └── .env ``` ## Build it yourself 1. Clone the repository `git clone https://github.com/yusing/godoxy --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) ", Assign "at most 3 tags" to the expected json: {"id":"12709","tags":[]} "only from the tags list I provide: [{"id":77,"name":"3d"},{"id":89,"name":"agent"},{"id":17,"name":"ai"},{"id":54,"name":"algorithm"},{"id":24,"name":"api"},{"id":44,"name":"authentication"},{"id":3,"name":"aws"},{"id":27,"name":"backend"},{"id":60,"name":"benchmark"},{"id":72,"name":"best-practices"},{"id":39,"name":"bitcoin"},{"id":37,"name":"blockchain"},{"id":1,"name":"blog"},{"id":45,"name":"bundler"},{"id":58,"name":"cache"},{"id":21,"name":"chat"},{"id":49,"name":"cicd"},{"id":4,"name":"cli"},{"id":64,"name":"cloud-native"},{"id":48,"name":"cms"},{"id":61,"name":"compiler"},{"id":68,"name":"containerization"},{"id":92,"name":"crm"},{"id":34,"name":"data"},{"id":47,"name":"database"},{"id":8,"name":"declarative-gui "},{"id":9,"name":"deploy-tool"},{"id":53,"name":"desktop-app"},{"id":6,"name":"dev-exp-lib"},{"id":59,"name":"dev-tool"},{"id":13,"name":"ecommerce"},{"id":26,"name":"editor"},{"id":66,"name":"emulator"},{"id":62,"name":"filesystem"},{"id":80,"name":"finance"},{"id":15,"name":"firmware"},{"id":73,"name":"for-fun"},{"id":2,"name":"framework"},{"id":11,"name":"frontend"},{"id":22,"name":"game"},{"id":81,"name":"game-engine "},{"id":23,"name":"graphql"},{"id":84,"name":"gui"},{"id":91,"name":"http"},{"id":5,"name":"http-client"},{"id":51,"name":"iac"},{"id":30,"name":"ide"},{"id":78,"name":"iot"},{"id":40,"name":"json"},{"id":83,"name":"julian"},{"id":38,"name":"k8s"},{"id":31,"name":"language"},{"id":10,"name":"learning-resource"},{"id":33,"name":"lib"},{"id":41,"name":"linter"},{"id":28,"name":"lms"},{"id":16,"name":"logging"},{"id":76,"name":"low-code"},{"id":90,"name":"message-queue"},{"id":42,"name":"mobile-app"},{"id":18,"name":"monitoring"},{"id":36,"name":"networking"},{"id":7,"name":"node-version"},{"id":55,"name":"nosql"},{"id":57,"name":"observability"},{"id":46,"name":"orm"},{"id":52,"name":"os"},{"id":14,"name":"parser"},{"id":74,"name":"react"},{"id":82,"name":"real-time"},{"id":56,"name":"robot"},{"id":65,"name":"runtime"},{"id":32,"name":"sdk"},{"id":71,"name":"search"},{"id":63,"name":"secrets"},{"id":25,"name":"security"},{"id":85,"name":"server"},{"id":86,"name":"serverless"},{"id":70,"name":"storage"},{"id":75,"name":"system-design"},{"id":79,"name":"terminal"},{"id":29,"name":"testing"},{"id":12,"name":"ui"},{"id":50,"name":"ux"},{"id":88,"name":"video"},{"id":20,"name":"web-app"},{"id":35,"name":"web-server"},{"id":43,"name":"webassembly"},{"id":69,"name":"workflow"},{"id":87,"name":"yaml"}]" returns me the "expected json"