mirror of
https://github.com/nadoo/glider.git
synced 2025-02-23 17:35:40 +08:00
doc: update documents
This commit is contained in:
parent
cc63a59f1e
commit
5cfb20562a
118
README.md
118
README.md
@ -40,7 +40,7 @@ we can set up local listeners as proxy servers, and forward requests to internet
|
|||||||
- Services:
|
- Services:
|
||||||
- dhcpd: a simple dhcp server that can detect existing dhcp server and avoid conflicts
|
- dhcpd: a simple dhcp server that can detect existing dhcp server and avoid conflicts
|
||||||
|
|
||||||
## Protocols
|
## Supported Protocols
|
||||||
|
|
||||||
<details>
|
<details>
|
||||||
<summary>click to see details</summary>
|
<summary>click to see details</summary>
|
||||||
@ -78,22 +78,14 @@ we can set up local listeners as proxy servers, and forward requests to internet
|
|||||||
|
|
||||||
## Install
|
## Install
|
||||||
|
|
||||||
Download:
|
- Binary: [https://github.com/nadoo/glider/releases](https://github.com/nadoo/glider/releases)
|
||||||
- [https://github.com/nadoo/glider/releases](https://github.com/nadoo/glider/releases)
|
- Docker: `docker pull nadoo/glider`
|
||||||
|
- ArchLinux: `sudo pacman -S glider`
|
||||||
Docker:
|
|
||||||
```bash
|
|
||||||
docker pull nadoo/glider
|
|
||||||
#docker pull ghcr.io/nadoo/glider
|
|
||||||
```
|
|
||||||
|
|
||||||
ArchLinux:
|
|
||||||
```bash
|
|
||||||
sudo pacman -S glider
|
|
||||||
```
|
|
||||||
|
|
||||||
## Usage
|
## Usage
|
||||||
|
|
||||||
|
#### Show help
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
glider -h
|
glider -h
|
||||||
```
|
```
|
||||||
@ -102,6 +94,7 @@ glider -h
|
|||||||
|
|
||||||
```bash
|
```bash
|
||||||
Usage: glider [-listen URL]... [-forward URL]... [OPTION]...
|
Usage: glider [-listen URL]... [-forward URL]... [OPTION]...
|
||||||
|
|
||||||
e.g. glider -config /etc/glider/glider.conf
|
e.g. glider -config /etc/glider/glider.conf
|
||||||
glider -listen :8443 -forward socks5://serverA:1080 -forward socks5://serverB:1080 -verbose
|
glider -listen :8443 -forward socks5://serverA:1080 -forward socks5://serverB:1080 -verbose
|
||||||
|
|
||||||
@ -180,7 +173,7 @@ OPTION:
|
|||||||
|
|
||||||
URL:
|
URL:
|
||||||
proxy: SCHEME://[USER:PASS@][HOST]:PORT
|
proxy: SCHEME://[USER:PASS@][HOST]:PORT
|
||||||
chain: proxy,proxy,[proxy]...
|
chain: proxy,proxy[,proxy]...
|
||||||
|
|
||||||
e.g. -listen socks5://:1080
|
e.g. -listen socks5://:1080
|
||||||
-listen tls://:443?cert=crtFilePath&key=keyFilePath,http:// (protocol chain)
|
-listen tls://:443?cert=crtFilePath&key=keyFilePath,http:// (protocol chain)
|
||||||
@ -190,8 +183,8 @@ URL:
|
|||||||
-forward socks5://serverA:1080,socks5://serverB:1080 (proxy chain)
|
-forward socks5://serverA:1080,socks5://serverB:1080 (proxy chain)
|
||||||
|
|
||||||
SCHEME:
|
SCHEME:
|
||||||
listen : sni,mixed,tcp,tls,vless,http,ss,trojan,trojanc,wss,ws,kcp,socks5,pxyproto,smux,udp
|
listen : kcp,socks5,tls,smux,ss,vless,redir,tproxy,mixed,wss,redir6,http,pxyproto,tcp,trojan,trojanc,udp,ws,unix
|
||||||
forward: vmess,wss,simple-obfs,udp,ws,kcp,socks5,ssh,ssr,tls,trojanc,reject,socks4a,smux,socks4,ss,tcp,trojan,vless,direct,http
|
forward: trojanc,udp,vless,vmess,socks4,tcp,tls,trojan,http,kcp,smux,ws,simple-obfs,unix,ss,ssh,ssr,wss,direct,socks5,reject,socks4a
|
||||||
|
|
||||||
Note: use `glider -scheme all` or `glider -scheme SCHEME` to see help info for the scheme.
|
Note: use `glider -scheme all` or `glider -scheme SCHEME` to see help info for the scheme.
|
||||||
|
|
||||||
@ -215,7 +208,8 @@ glider v0.16.0, https://github.com/nadoo/glider
|
|||||||
|
|
||||||
</details>
|
</details>
|
||||||
|
|
||||||
run:
|
#### Run it
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
glider -config CONFIG_PATH
|
glider -config CONFIG_PATH
|
||||||
```
|
```
|
||||||
@ -223,7 +217,7 @@ glider -config CONFIG_PATH
|
|||||||
glider -verbose -listen :8443 -forward SCHEME://HOST:PORT
|
glider -verbose -listen :8443 -forward SCHEME://HOST:PORT
|
||||||
```
|
```
|
||||||
|
|
||||||
#### Schemes
|
#### Show Schemes
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
glider -scheme all
|
glider -scheme all
|
||||||
@ -341,49 +335,6 @@ TLS and Websocket with a specified proxy protocol:
|
|||||||
|
|
||||||
</details>
|
</details>
|
||||||
|
|
||||||
#### Examples
|
|
||||||
|
|
||||||
<details>
|
|
||||||
<summary>click to see details</summary>
|
|
||||||
|
|
||||||
```bash
|
|
||||||
Examples:
|
|
||||||
glider -config glider.conf
|
|
||||||
-run glider with specified config file.
|
|
||||||
|
|
||||||
glider -listen :8443 -verbose
|
|
||||||
-listen on :8443, serve as http/socks5 proxy on the same port, in verbose mode.
|
|
||||||
|
|
||||||
glider -listen ss://AEAD_AES_128_GCM:pass@:8443 -verbose
|
|
||||||
-listen on 0.0.0.0:8443 as a ss server.
|
|
||||||
|
|
||||||
glider -listen tls://:443?cert=crtFilePath&key=keyFilePath,http:// -verbose
|
|
||||||
-listen on :443 as a https(http over tls) proxy server.
|
|
||||||
|
|
||||||
glider -listen http://:8080 -forward socks5://127.0.0.1:1080
|
|
||||||
-listen on :8080 as a http proxy server, forward all requests via socks5 server.
|
|
||||||
|
|
||||||
glider -listen socks5://:1080 -forward "tls://abc.com:443,vmess://security:uuid@?alterID=10"
|
|
||||||
-listen on :1080 as a socks5 server, forward all requests via remote tls+vmess server.
|
|
||||||
|
|
||||||
glider -listen socks5://:1080 -forward ss://method:pass@server1:port1 -forward ss://method:pass@server2:port2 -strategy rr
|
|
||||||
-listen on :1080 as socks5 server, forward requests via server1 and server2 in round robin mode.
|
|
||||||
|
|
||||||
glider -listen tcp://:80 -forward tcp://2.2.2.2:80
|
|
||||||
-tcp tunnel: listen on :80 and forward all requests to 2.2.2.2:80.
|
|
||||||
|
|
||||||
glider -listen udp://:53 -forward ss://method:pass@1.1.1.1:8443,udp://8.8.8.8:53
|
|
||||||
-listen on :53 and forward all udp requests to 8.8.8.8:53 via remote ss server.
|
|
||||||
|
|
||||||
glider -listen socks5://:1080 -listen http://:8080 -forward ss://method:pass@1.1.1.1:8443
|
|
||||||
-listen on :1080 as socks5 server, :8080 as http proxy server, forward all requests via remote ss server.
|
|
||||||
|
|
||||||
glider -verbose -listen -dns=:53 -dnsserver=8.8.8.8:53 -forward ss://method:pass@server:port -dnsrecord=www.example.com/1.2.3.4
|
|
||||||
-listen on :53 as dns server, forward to 8.8.8.8:53 via ss server.
|
|
||||||
```
|
|
||||||
|
|
||||||
</details>
|
|
||||||
|
|
||||||
## Config
|
## Config
|
||||||
|
|
||||||
- [ConfigFile](config)
|
- [ConfigFile](config)
|
||||||
@ -469,6 +420,49 @@ Examples:
|
|||||||
|
|
||||||
</details>
|
</details>
|
||||||
|
|
||||||
|
## Examples
|
||||||
|
|
||||||
|
<details>
|
||||||
|
<summary>click to see details</summary>
|
||||||
|
|
||||||
|
```bash
|
||||||
|
Examples:
|
||||||
|
glider -config glider.conf
|
||||||
|
-run glider with specified config file.
|
||||||
|
|
||||||
|
glider -listen :8443 -verbose
|
||||||
|
-listen on :8443, serve as http/socks5 proxy on the same port, in verbose mode.
|
||||||
|
|
||||||
|
glider -listen ss://AEAD_AES_128_GCM:pass@:8443 -verbose
|
||||||
|
-listen on 0.0.0.0:8443 as a ss server.
|
||||||
|
|
||||||
|
glider -listen tls://:443?cert=crtFilePath&key=keyFilePath,http:// -verbose
|
||||||
|
-listen on :443 as a https(http over tls) proxy server.
|
||||||
|
|
||||||
|
glider -listen http://:8080 -forward socks5://127.0.0.1:1080
|
||||||
|
-listen on :8080 as a http proxy server, forward all requests via socks5 server.
|
||||||
|
|
||||||
|
glider -listen socks5://:1080 -forward "tls://abc.com:443,vmess://security:uuid@?alterID=10"
|
||||||
|
-listen on :1080 as a socks5 server, forward all requests via remote tls+vmess server.
|
||||||
|
|
||||||
|
glider -listen socks5://:1080 -forward ss://method:pass@server1:port1 -forward ss://method:pass@server2:port2 -strategy rr
|
||||||
|
-listen on :1080 as socks5 server, forward requests via server1 and server2 in round robin mode.
|
||||||
|
|
||||||
|
glider -listen tcp://:80 -forward tcp://2.2.2.2:80
|
||||||
|
-tcp tunnel: listen on :80 and forward all requests to 2.2.2.2:80.
|
||||||
|
|
||||||
|
glider -listen udp://:53 -forward ss://method:pass@1.1.1.1:8443,udp://8.8.8.8:53
|
||||||
|
-listen on :53 and forward all udp requests to 8.8.8.8:53 via remote ss server.
|
||||||
|
|
||||||
|
glider -listen socks5://:1080 -listen http://:8080 -forward ss://method:pass@1.1.1.1:8443
|
||||||
|
-listen on :1080 as socks5 server, :8080 as http proxy server, forward all requests via remote ss server.
|
||||||
|
|
||||||
|
glider -verbose -listen -dns=:53 -dnsserver=8.8.8.8:53 -forward ss://method:pass@server:port -dnsrecord=www.example.com/1.2.3.4
|
||||||
|
-listen on :53 as dns server, forward to 8.8.8.8:53 via ss server.
|
||||||
|
```
|
||||||
|
|
||||||
|
</details>
|
||||||
|
|
||||||
## Links
|
## Links
|
||||||
|
|
||||||
- [ipset](https://github.com/nadoo/ipset): netlink ipset package for Go.
|
- [ipset](https://github.com/nadoo/ipset): netlink ipset package for Go.
|
||||||
|
@ -158,6 +158,7 @@ func usage() {
|
|||||||
|
|
||||||
fmt.Fprint(w, `
|
fmt.Fprint(w, `
|
||||||
Usage: glider [-listen URL]... [-forward URL]... [OPTION]...
|
Usage: glider [-listen URL]... [-forward URL]... [OPTION]...
|
||||||
|
|
||||||
e.g. glider -config /etc/glider/glider.conf
|
e.g. glider -config /etc/glider/glider.conf
|
||||||
glider -listen :8443 -forward socks5://serverA:1080 -forward socks5://serverB:1080 -verbose
|
glider -listen :8443 -forward socks5://serverA:1080 -forward socks5://serverB:1080 -verbose
|
||||||
|
|
||||||
@ -169,7 +170,7 @@ Usage: glider [-listen URL]... [-forward URL]... [OPTION]...
|
|||||||
fmt.Fprint(w, `
|
fmt.Fprint(w, `
|
||||||
URL:
|
URL:
|
||||||
proxy: SCHEME://[USER:PASS@][HOST]:PORT
|
proxy: SCHEME://[USER:PASS@][HOST]:PORT
|
||||||
chain: proxy,proxy,[proxy]...
|
chain: proxy,proxy[,proxy]...
|
||||||
|
|
||||||
e.g. -listen socks5://:1080
|
e.g. -listen socks5://:1080
|
||||||
-listen tls://:443?cert=crtFilePath&key=keyFilePath,http:// (protocol chain)
|
-listen tls://:443?cert=crtFilePath&key=keyFilePath,http:// (protocol chain)
|
||||||
|
Loading…
Reference in New Issue
Block a user