starred/godoxy
1
0
Fork 0
mirror of https://github.com/yusing/godoxy.git synced 2026-04-24 01:38:50 +02:00
Code Issues 18 Packages Projects Releases 10 Wiki Activity

readme and dockerfile fix for v0.3 update

Browse Source
This commit is contained in:
yusing
2024-03-23 03:29:35 +00:00
parent 43ecd80687
commit 094f75ef46
4 changed files with 40 additions and 18 deletions
Download Patch File Download Diff File Expand all files Collapse all files

35
README.md
View File

@@ -40,6 +40,7 @@ In the examples domain `x.y.z` is used, replace them with your domain
- HTTP round robin load balance support (same subdomain and path across different hosts)
- Auto hot-reload on container start / die / stop or config changes.
- Simple panel to see all reverse proxies and health (visit port [panel port] of go-proxy `https://*.y.z:[panel port]`)
- you can customize it by modifying [templates/panel.html](templates/panel.html)
![panel screenshot](screenshots/panel.png)
@@ -56,10 +57,16 @@ In the examples domain `x.y.z` is used, replace them with your domain
### Binary
1. (Optional) Prepare your wildcard (`*.y.z`) SSL cert in `certs/` to enable https. See [Getting SSL Certs](#getting-ssl-certs)
1. (Optional) enabled HTTPS
- cert / chain / fullchain: `./certs/cert.crt`
- private key: `./certs/priv.key`
- Use autocert feature by completing `autocert` in `config.yml`
- Use existing certificate
Prepare your wildcard (`*.y.z`) SSL cert in `certs/`
- cert / chain / fullchain: `./certs/cert.crt`
- private key: `./certs/priv.key`
2. run the binary `bin/go-proxy`
@@ -71,10 +78,25 @@ In the examples domain `x.y.z` is used, replace them with your domain
2. Add networks to make sure it is in the same network with other containers, or make sure `proxy.<alias>.host` is reachable
3. (Optional) Mount your wildcard (`*.y.z`) SSL cert to enable https. See [Getting SSL Certs](#getting-ssl-certs)
3. (Optional) enable HTTPS
- cert / chain / fullchain -> `/app/certs/cert.crt`
- private key -> `/app/certs/priv.key`
- Use autocert feature
1. mount `./certs` to `/app/certs`
```yaml
go-proxy:
...
volumes:
- ./certs:/app/certs
```
2. complete `autocert` in `config.yml`
- Use existing certificate
Mount your wildcard (`*.y.z`) SSL cert to enable https. See [Getting SSL Certs](#getting-ssl-certs)
- cert / chain / fullchain -> `/app/certs/cert.crt`
- private key -> `/app/certs/priv.key`
4. Start `go-proxy` with `docker compose up -d` or `make up`.
@@ -151,6 +173,7 @@ See [providers.example.yml](providers.example.yml)
### Supported cert providers
- Cloudflare
```yaml
autocert:
...