mirror of
https://github.com/yusing/godoxy.git
synced 2025-05-21 04:52:35 +02:00
371 lines
9.4 KiB
Markdown
371 lines
9.4 KiB
Markdown
# Docker container guide
|
|
|
|
## Table of content
|
|
|
|
<!-- TOC -->
|
|
|
|
- [Table of content](#table-of-content)
|
|
- [Setup](#setup)
|
|
- [Labels](#labels)
|
|
- [Labels (docker specific)](#labels-docker-specific)
|
|
- [Troubleshooting](#troubleshooting)
|
|
- [Docker compose examples](#docker-compose-examples)
|
|
- [Local docker provider in bridge network](#local-docker-provider-in-bridge-network)
|
|
- [Remote docker provider](#remote-docker-provider)
|
|
- [Explaination](#explaination)
|
|
- [Remote setup](#remote-setup)
|
|
- [Proxy setup](#proxy-setup)
|
|
- [Local docker provider in host network](#local-docker-provider-in-host-network)
|
|
- [Proxy setup](#proxy-setup)
|
|
- [Services URLs for above examples](#services-urls-for-above-examples)
|
|
<!-- /TOC -->
|
|
|
|
## Setup
|
|
|
|
1. Install `wget` if not already
|
|
|
|
2. Run setup script
|
|
|
|
`bash <(wget -qO- https://6uo.me/go-proxy-setup-docker)`
|
|
|
|
What it does:
|
|
|
|
- Create required directories
|
|
- Setup `config.yml` and `compose.yml`
|
|
|
|
3. Verify folder structure and then `cd go-proxy`
|
|
|
|
```plain
|
|
go-proxy
|
|
├── certs
|
|
├── compose.yml
|
|
└── config
|
|
├── config.yml
|
|
└── providers.yml
|
|
```
|
|
|
|
4. Enable HTTPs _(optional)_
|
|
|
|
- To use autocert feature
|
|
|
|
- completing `autocert` section in `config/config.yml`
|
|
- mount `certs/` to `/app/certs` to store obtained certs
|
|
|
|
- To use existing certificate
|
|
|
|
mount your wildcard (`*.y.z`) SSL cert
|
|
|
|
- cert / chain / fullchain -> `/app/certs/cert.crt`
|
|
- private key -> `/app/certs/priv.key`
|
|
|
|
5. Modify `compose.yml` fit your needs
|
|
|
|
Add networks to make sure it is in the same network with other containers, or make sure `proxy.<alias>.host` is reachable
|
|
|
|
6. Run `docker compose up -d` to start the container
|
|
|
|
7. Start editing config files in `http://<ip>:8080`
|
|
|
|
[🔼Back to top](#table-of-content)
|
|
|
|
## Labels
|
|
|
|
- `proxy.aliases`: comma separated aliases for subdomain matching
|
|
|
|
- default: container name
|
|
|
|
- `proxy.*.<field>`: wildcard label for all aliases
|
|
|
|
Below labels has a **`proxy.<alias>.`** prefix (i.e. `proxy.nginx.scheme: http`)
|
|
|
|
- `scheme`: proxy protocol
|
|
- default: `http`
|
|
- allowed: `http`, `https`, `tcp`, `udp`
|
|
- `host`: proxy host
|
|
- default: `container_name`
|
|
- `port`: proxy port
|
|
- default: first expose port (declared in `Dockerfile` or `docker-compose.yml`)
|
|
- `http(s)`: number in range og `0 - 65535`
|
|
- `tcp/udp`: `[<listeningPort>:]<targetPort>`
|
|
- `listeningPort`: number, when it is omitted (not suggested), a free port starting from 20000 will be used.
|
|
- `targetPort`: number, or predefined names (see [constants.go:14](src/go-proxy/constants.go#L14))
|
|
- `no_tls_verify`: whether skip tls verify when scheme is https
|
|
- default: `false`
|
|
- `path`: proxy path _(http(s) proxy only)_
|
|
- default: empty
|
|
- `path_mode`: mode for path handling
|
|
|
|
- default: empty
|
|
- allowed: empty, `forward`, `sub`
|
|
|
|
- `empty`: remove path prefix from URL when proxying
|
|
1. apps.y.z/webdav -> webdav:80
|
|
2. apps.y.z./webdav/path/to/file -> webdav:80/path/to/file
|
|
- `forward`: path remain unchanged
|
|
1. apps.y.z/webdav -> webdav:80/webdav
|
|
2. apps.y.z./webdav/path/to/file -> webdav:80/webdav/path/to/file
|
|
- `sub`: **(experimental)** remove path prefix from URL and also append path to HTML link attributes (`src`, `href` and `action`) and Javascript `fetch(url)` by response body substitution
|
|
e.g. apps.y.z/app1 -> webdav:80, `href="/app1/path/to/file"` -> `href="/path/to/file"`
|
|
|
|
- `set_headers`: a list of header to set, (key:value, one by line)
|
|
|
|
Duplicated keys will be treated as multiple-value headers
|
|
|
|
```yaml
|
|
labels:
|
|
- |
|
|
proxy.app.set_headers=
|
|
X-Custom-Header1: value1
|
|
X-Custom-Header1: value2
|
|
X-Custom-Header2: value2
|
|
```
|
|
|
|
- `hide_headers`: comma seperated list of headers to hide
|
|
|
|
[🔼Back to top](#table-of-content)
|
|
|
|
## Labels (docker specific)
|
|
|
|
Below labels has a **`proxy.<alias>.`** prefix (i.e. `proxy.app.headers.hide: X-Powered-By,X-Custom-Header`)
|
|
|
|
- `headers.set.<header>`: value of header to set
|
|
|
|
- `headers.hide`: comma seperated list of headers to hide
|
|
|
|
- `load_balance`: enable load balance
|
|
- allowed: `1`, `true`
|
|
|
|
[🔼Back to top](#table-of-content)
|
|
|
|
## Troubleshooting
|
|
|
|
- Firewall issues
|
|
|
|
If you are using `ufw` with vpn that drop all inbound traffic except vpn, run below:
|
|
|
|
`sudo ufw allow from 172.16.0.0/16 to 100.64.0.0/10`
|
|
|
|
Explaination:
|
|
|
|
Docker network is usually `172.16.0.0/16`
|
|
|
|
Tailscale is used as an example, `100.64.0.0/10` will be the CIDR
|
|
|
|
You can also list CIDRs of all docker bridge networks by:
|
|
|
|
`docker network inspect $(docker network ls | awk '$3 == "bridge" { print $1}') | jq -r '.[] | .Name + " " + .IPAM.Config[0].Subnet' -`
|
|
|
|
[🔼Back to top](#table-of-content)
|
|
|
|
## Docker compose examples
|
|
|
|
### Local docker provider in bridge network
|
|
|
|
```yaml
|
|
volumes:
|
|
adg-work:
|
|
adg-conf:
|
|
mc-data:
|
|
palworld:
|
|
nginx:
|
|
services:
|
|
adg:
|
|
image: adguard/adguardhome
|
|
restart: unless-stopped
|
|
labels:
|
|
- proxy.aliases=adg,adg-dns,adg-setup
|
|
- proxy.adg.port=80
|
|
- proxy.adg-setup.port=3000
|
|
- proxy.adg-dns.scheme=udp
|
|
- proxy.adg-dns.port=20000:dns
|
|
volumes:
|
|
- adg-work:/opt/adguardhome/work
|
|
- adg-conf:/opt/adguardhome/conf
|
|
mc:
|
|
image: itzg/minecraft-server
|
|
tty: true
|
|
stdin_open: true
|
|
container_name: mc
|
|
restart: unless-stopped
|
|
labels:
|
|
- proxy.mc.scheme=tcp
|
|
- proxy.mc.port=20001:25565
|
|
environment:
|
|
- EULA=TRUE
|
|
volumes:
|
|
- mc-data:/data
|
|
palworld:
|
|
image: thijsvanloef/palworld-server-docker:latest
|
|
restart: unless-stopped
|
|
container_name: pal
|
|
stop_grace_period: 30s
|
|
labels:
|
|
- proxy.aliases=pal1,pal2
|
|
- proxy.*.scheme=udp
|
|
- proxy.pal1.port=20002:8211
|
|
- proxy.pal2.port=20003:27015
|
|
environment: ...
|
|
volumes:
|
|
- palworld:/palworld
|
|
nginx:
|
|
image: nginx
|
|
container_name: nginx
|
|
volumes:
|
|
- nginx:/usr/share/nginx/html
|
|
go-proxy:
|
|
image: ghcr.io/yusing/go-proxy
|
|
container_name: go-proxy
|
|
restart: always
|
|
ports:
|
|
- 80:80 # http
|
|
- 443:443 # optional, https
|
|
- 8080:8080 # http panel
|
|
- 8443:8443 # optional, https panel
|
|
|
|
- 53:20000/udp # adguardhome
|
|
- 25565:20001/tcp # minecraft
|
|
- 8211:20002/udp # palworld
|
|
- 27015:20003/udp # palworld
|
|
volumes:
|
|
- ./config:/app/config
|
|
- /var/run/docker.sock:/var/run/docker.sock:ro
|
|
labels:
|
|
- proxy.aliases=gp
|
|
- proxy.gp.port=8080
|
|
```
|
|
|
|
[🔼Back to top](#table-of-content)
|
|
|
|
### Remote docker provider
|
|
|
|
#### Explaination
|
|
|
|
- Expose container ports to random port in remote host
|
|
- Use container port with an asterisk sign **(\*)** before to find remote port automatically
|
|
|
|
#### Remote setup
|
|
|
|
```yaml
|
|
volumes:
|
|
adg-work:
|
|
adg-conf:
|
|
mc-data:
|
|
palworld:
|
|
nginx:
|
|
services:
|
|
adg:
|
|
image: adguard/adguardhome
|
|
restart: unless-stopped
|
|
ports: # map container ports
|
|
- 80
|
|
- 3000
|
|
- 53/udp
|
|
- 53/tcp
|
|
labels:
|
|
- proxy.aliases=adg,adg-dns,adg-setup
|
|
# add an asterisk (*) before to find host port automatically
|
|
- proxy.adg.port=*80
|
|
- proxy.adg-setup.port=*3000
|
|
- proxy.adg-dns.scheme=udp
|
|
- proxy.adg-dns.port=*53
|
|
volumes:
|
|
- adg-work:/opt/adguardhome/work
|
|
- adg-conf:/opt/adguardhome/conf
|
|
mc:
|
|
image: itzg/minecraft-server
|
|
tty: true
|
|
stdin_open: true
|
|
container_name: mc
|
|
restart: unless-stopped
|
|
ports:
|
|
- 25565
|
|
labels:
|
|
- proxy.mc.scheme=tcp
|
|
- proxy.mc.port=*25565
|
|
environment:
|
|
- EULA=TRUE
|
|
volumes:
|
|
- mc-data:/data
|
|
palworld:
|
|
image: thijsvanloef/palworld-server-docker:latest
|
|
restart: unless-stopped
|
|
container_name: pal
|
|
stop_grace_period: 30s
|
|
ports:
|
|
- 8211/udp
|
|
- 27015/udp
|
|
labels:
|
|
- proxy.aliases=pal1,pal2
|
|
- proxy.*.scheme=udp
|
|
- proxy.pal1.port=*8211
|
|
- proxy.pal2.port=*27015
|
|
environment: ...
|
|
volumes:
|
|
- palworld:/palworld
|
|
nginx:
|
|
image: nginx
|
|
container_name: nginx
|
|
# for single port container, host port will be found automatically
|
|
ports:
|
|
- 80
|
|
volumes:
|
|
- nginx:/usr/share/nginx/html
|
|
```
|
|
|
|
[🔼Back to top](#table-of-content)
|
|
|
|
#### Proxy setup
|
|
|
|
```yaml
|
|
go-proxy:
|
|
image: ghcr.io/yusing/go-proxy
|
|
container_name: go-proxy
|
|
restart: always
|
|
network_mode: host
|
|
volumes:
|
|
- ./config:/app/config
|
|
- /var/run/docker.sock:/var/run/docker.sock:ro
|
|
labels:
|
|
- proxy.aliases=gp
|
|
- proxy.gp.port=8080
|
|
```
|
|
|
|
[🔼Back to top](#table-of-content)
|
|
|
|
### Local docker provider in host network
|
|
|
|
Mostly as remote docker setup, see [remote setup](#remote-setup)
|
|
|
|
With `GOPROXY_HOST_NETWORK=1` to treat it as remote docker provider
|
|
|
|
#### Proxy setup
|
|
|
|
```yaml
|
|
go-proxy:
|
|
image: ghcr.io/yusing/go-proxy
|
|
container_name: go-proxy
|
|
restart: always
|
|
network_mode: host
|
|
environment: # this part is needed for local docker in host mode
|
|
- GOPROXY_HOST_NETWORK=1
|
|
volumes:
|
|
- ./config:/app/config
|
|
- /var/run/docker.sock:/var/run/docker.sock:ro
|
|
labels:
|
|
- proxy.aliases=gp
|
|
- proxy.gp.port=8080
|
|
```
|
|
|
|
[🔼Back to top](#table-of-content)
|
|
|
|
### Services URLs for above examples
|
|
|
|
- `gp.yourdomain.com`: go-proxy web panel
|
|
- `adg-setup.yourdomain.com`: adguard setup (first time setup)
|
|
- `adg.yourdomain.com`: adguard dashboard
|
|
- `nginx.yourdomain.com`: nginx
|
|
- `yourdomain.com:53`: adguard dns
|
|
- `yourdomain.com:25565`: minecraft server
|
|
- `yourdomain.com:8211`: palworld server
|
|
|
|
[🔼Back to top](#table-of-content)
|