From 1ed7fbff6580f7e1269ecf8ed72dcc6cc14a2463 Mon Sep 17 00:00:00 2001 From: nadoo <287492+nadoo@users.noreply.github.com> Date: Fri, 2 Oct 2020 19:31:03 +0800 Subject: [PATCH] doc: updates for new features --- README.md | 69 +++++++++++++++++++------------------- config.go | 2 +- config/glider.conf.example | 5 +++ 3 files changed, 41 insertions(+), 35 deletions(-) diff --git a/README.md b/README.md index f7ec473..d442910 100644 --- a/README.md +++ b/README.md @@ -54,7 +54,7 @@ we can set up local listeners as proxy servers, and forward requests to internet |ssh | | |√| |client only |trojan | | |√|√|client only |vmess | | |√| |client only -|vless | | |√| |client only +|vless | | |√|√|client only |redir |√| | | |linux only |redir6 |√| | | |linux only(ipv6) |tls |√| |√| |transport client & server @@ -303,7 +303,7 @@ Examples: Services: 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 ``` @@ -328,6 +328,39 @@ glider -config CONFIGPATH -listen :8080 -verbose - [transparent proxy with dnsmasq](config/examples/8.transparent_proxy_with_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 + +
You can customize and build glider if you want a smaller binary (click to see details) + + +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" + ``` + +
+ ## Proxy & Protocol Chains
In glider, you can easily chain several proxy servers or protocols together (click to see details) @@ -363,38 +396,6 @@ glider -config CONFIGPATH -listen :8080 -verbose
-## 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 - [ipset](https://github.com/nadoo/ipset): netlink ipset package for Go. diff --git a/config.go b/config.go index a29171f..a66e10b 100644 --- a/config.go +++ b/config.go @@ -316,6 +316,6 @@ func usage() { fmt.Fprintf(w, "Services:\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") } diff --git a/config/glider.conf.example b/config/glider.conf.example index 16e7de0..fff5acc 100644 --- a/config/glider.conf.example +++ b/config/glider.conf.example @@ -215,6 +215,11 @@ dnsminttl=0 dnsrecord=www.example.com/1.2.3.4 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 # ------------------ # Specify the outbound ip/interface.