misindentation

This commit is contained in:
yusing 2024-03-18 04:58:21 +00:00
parent 45bd377b22
commit 3a81064fba

View file

@ -1,6 +1,6 @@
# go-proxy # go-proxy
A simple auto docker reverse proxy for home use. **Written in *Go*** A simple auto docker reverse proxy for home use. **Written in _Go_**
In the examples domain `x.y.z` is used, replace them with your domain In the examples domain `x.y.z` is used, replace them with your domain
@ -40,23 +40,34 @@ In the examples domain `x.y.z` is used, replace them with your domain
## How to use (docker) ## How to use (docker)
1. Download and extract the latest release (or clone the repository if you want to try out experimental features) 1. Download and extract the latest release (or clone the repository if you want to try out experimental features)
2. Copy `config.example.yml` to `config.yml` and modify the content to fit your needs 2. Copy `config.example.yml` to `config.yml` and modify the content to fit your needs
3. Do the same for `providers.example.yml` 3. Do the same for `providers.example.yml`
4. See [Binary](#binary) or [docker](#docker) 4. See [Binary](#binary) or [docker](#docker)
### Binary ### Binary
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`
3. enjoy 3. enjoy
### Docker ### Docker
1. Copy content from [compose.example.yml](compose.example.yml) and create your own `compose.yml` 1. Copy content from [compose.example.yml](compose.example.yml) and create your own `compose.yml`
2. Add networks to make sure it is in the same network with other containers, or make sure `proxy.<alias>.host` is reachable 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 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
@ -64,6 +75,7 @@ In the examples domain `x.y.z` is used, replace them with your domain
5. (Optional) If you are using ufw with vpn that drop all inbound traffic except vpn, run below to allow docker containers to connect to `go-proxy` 5. (Optional) If you are using ufw with vpn that drop all inbound traffic except vpn, run below to allow docker containers to connect to `go-proxy`
In case the network of your container is in subnet `172.16.0.0/16` (bridge), In case the network of your container is in subnet `172.16.0.0/16` (bridge),
and vpn network is under `100.64.0.0/10` (i.e. tailscale) and vpn network is under `100.64.0.0/10` (i.e. tailscale)