TyleoDvDelaware3217/GoDoxy
1
0
Fork 0
mirror of https://github.com/yusing/godoxy.git synced 2025-05-20 20:52:33 +02:00
Code Issues Projects Releases Packages Wiki Activity Actions

readme fixes

Browse source
This commit is contained in:
yusing 2024-03-18 21:01:37 +00:00
parent 8a640ec484
commit 50eb5e9eb1
1 changed files with 6 additions and 6 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

12
README.md
View file

@ -52,8 +52,8 @@ In the examples domain `x.y.z` is used, replace them with your domain
1. (Optional) Prepare your certificates in `certs/` to enable https. See [Getting SSL Certs](#getting-ssl-certs) 1. (Optional) Prepare your certificates in `certs/` to enable https. See [Getting SSL Certs](#getting-ssl-certs)
- cert / chain / fullchain: ./certs/cert.crt - cert / chain / fullchain: `./certs/cert.crt`
- private key: ./certs/priv.key - private key: `./certs/priv.key`
2. run the binary `bin/go-proxy` 2. run the binary `bin/go-proxy`
@ -68,8 +68,8 @@ In the examples domain `x.y.z` is used, replace them with your domain
3. (Optional) Mount your SSL certs to enable https. See [Getting SSL Certs](#getting-ssl-certs) 3. (Optional) Mount your SSL certs to enable https. See [Getting SSL Certs](#getting-ssl-certs)
- cert / chain / fullchain -> /app/certs/cert.crt - cert / chain / fullchain -> `/app/certs/cert.crt`
- private key -> /app/certs/priv.key - private key -> `/app/certs/priv.key`
4. Start `go-proxy` with `docker compose up -d` or `make up`. 4. Start `go-proxy` with `docker compose up -d` or `make up`.
@ -296,7 +296,7 @@ Local benchmark (client running wrk and `go-proxy` server are under same proxmox
## Memory usage ## Memory usage
It takes ~ 0.1-0.4MB for each HTTP Proxy, and <2MB for each TCP/UDP Proxy It takes ~30 MB for 50 proxy entries
## Build it yourself ## Build it yourself
@ -310,6 +310,6 @@ It takes ~ 0.1-0.4MB for each HTTP Proxy, and <2MB for each TCP/UDP Proxy
## Getting SSL certs ## Getting SSL certs
I personally use `nginx-proxy-manager` to get SSL certs with auto renewal by Cloudflare DNS challenge. You may symlink the certs from `nginx-proxy-manager` to somewhere else, and mount them to `go-proxy`'s `/certs` I personally use `nginx-proxy-manager` to get SSL certs with auto renewal by Cloudflare DNS challenge. You may symlink the certs from `nginx-proxy-manager` to `certs/` folder relative to project root. (For docker) mount them to `go-proxy`'s `/app/certs`
[panel port]: 8443 [panel port]: 8443