doc: updates for new features

This commit is contained in:
nadoo 2020-10-02 19:31:03 +08:00
parent b323a62ce6
commit 1ed7fbff65
3 changed files with 41 additions and 35 deletions

View File

@ -54,7 +54,7 @@ we can set up local listeners as proxy servers, and forward requests to internet
|ssh | | |√| |client only |ssh | | |√| |client only
|trojan | | |√|√|client only |trojan | | |√|√|client only
|vmess | | |√| |client only |vmess | | |√| |client only
|vless | | |√| |client only |vless | | |√||client only
|redir |√| | | |linux only |redir |√| | | |linux only
|redir6 |√| | | |linux only(ipv6) |redir6 |√| | | |linux only(ipv6)
|tls |√| |√| |transport client & server |tls |√| |√| |transport client & server
@ -303,7 +303,7 @@ Examples:
Services: Services:
dhcpd: service=dhcpd,INTERFACE,START_IP,END_IP dhcpd: service=dhcpd,INTERFACE,START_IP,END_IP
e.g.,service=dhcpd,en0,192.168.254.100,192.168.254.199 e.g.,service=dhcpd,en0,192.168.50.100,192.168.50.199
``` ```
</details> </details>
@ -328,6 +328,39 @@ glider -config CONFIGPATH -listen :8080 -verbose
- [transparent proxy with dnsmasq](config/examples/8.transparent_proxy_with_dnsmasq) - [transparent proxy with dnsmasq](config/examples/8.transparent_proxy_with_dnsmasq)
- [transparent proxy without dnsmasq](config/examples/9.transparent_proxy_without_dnsmasq) - [transparent proxy without dnsmasq](config/examples/9.transparent_proxy_without_dnsmasq)
## Service
- dhcpd:
- service=dhcpd,INTERFACE,START_IP,END_IP
- e.g., service=dhcpd,en0,192.168.50.100,192.168.50.199
## Linux Service
- systemd: [https://github.com/nadoo/glider/blob/master/systemd/](https://github.com/nadoo/glider/blob/master/systemd/)
## Customize Build
<details><summary>You can customize and build glider if you want a smaller binary (click to see details)</summary>
1. Clone the source code:
```bash
git clone https://github.com/nadoo/glider
```
2. Customize features:
```bash
open `feature.go` & `feature_linux.go`, comment out the packages you don't need
// _ "github.com/nadoo/glider/proxy/kcp"
```
3. Build it(requires **Go 1.15+** )
```bash
cd glider && go build -v -i -ldflags "-s -w"
```
</details>
## Proxy & Protocol Chains ## Proxy & Protocol Chains
<details><summary>In glider, you can easily chain several proxy servers or protocols together (click to see details)</summary> <details><summary>In glider, you can easily chain several proxy servers or protocols together (click to see details)</summary>
@ -363,38 +396,6 @@ glider -config CONFIGPATH -listen :8080 -verbose
</details> </details>
## Service
**Scheme:** ```service=SERVICE_NAME[,SERVICE_CONFIG]```
- dhcpd:
- service=dhcpd,INTERFACE,START_IP,END_IP
- e.g., service=dhcpd,en0,192.168.254.100,192.168.254.199
## Linux Service
- systemd: [https://github.com/nadoo/glider/blob/master/systemd/](https://github.com/nadoo/glider/blob/master/systemd/)
## Customize Build
You can customize and build glider if you want a smaller binary.
1. Clone the source code:
```bash
git clone https://github.com/nadoo/glider
```
2. Customize features:
```bash
open `feature.go` & `feature_linux.go`, comment out the packages you don't need
// _ "github.com/nadoo/glider/proxy/kcp"
```
3. Build it(requires **Go 1.15+** )
```bash
cd glider && go build
```
## Links ## Links
- [ipset](https://github.com/nadoo/ipset): netlink ipset package for Go. - [ipset](https://github.com/nadoo/ipset): netlink ipset package for Go.

View File

@ -316,6 +316,6 @@ func usage() {
fmt.Fprintf(w, "Services:\n") fmt.Fprintf(w, "Services:\n")
fmt.Fprintf(w, " dhcpd: service=dhcpd,INTERFACE,START_IP,END_IP\n") fmt.Fprintf(w, " dhcpd: service=dhcpd,INTERFACE,START_IP,END_IP\n")
fmt.Fprintf(w, " e.g.,service=dhcpd,en0,192.168.254.100,192.168.254.199\n") fmt.Fprintf(w, " e.g.,service=dhcpd,en0,192.168.50.100,192.168.50.199\n")
fmt.Fprintf(w, "\n") fmt.Fprintf(w, "\n")
} }

View File

@ -215,6 +215,11 @@ dnsminttl=0
dnsrecord=www.example.com/1.2.3.4 dnsrecord=www.example.com/1.2.3.4
dnsrecord=www.example.com/2606:2800:220:1:248:1893:25c8:1946 dnsrecord=www.example.com/2606:2800:220:1:248:1893:25c8:1946
# SERVICES
# service=dhcpd,INTERFACE,START_IP,END_IP
# e.g.:
# service=dhcpd,en0,192.168.50.100,192.168.50.199
# INTERFACE SPECIFIC # INTERFACE SPECIFIC
# ------------------ # ------------------
# Specify the outbound ip/interface. # Specify the outbound ip/interface.