From e34b787ea56d2a50dab0a07b242295af29549dd5 Mon Sep 17 00:00:00 2001 From: nadoo <287492+nadoo@users.noreply.github.com> Date: Sun, 3 Sep 2017 01:05:56 +0800 Subject: [PATCH] doc: update README file --- README.md | 42 ++++++++++++++++++++------------------ config/glider.conf.example | 2 +- 2 files changed, 23 insertions(+), 21 deletions(-) diff --git a/README.md b/README.md index 7fe6f9b..535449d 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,7 @@ # [glider](https://github.com/nadoo/glider) -glider is a forward proxy with multiple protocols support. +glider is a forward proxy with multiple protocols support, and also a dns forwarding server with ipset management features(like dnsmasq). -we can set up local listeners as proxy, and forward requests to internet via forwarders. +we can set up local listeners as proxy servers, and forward requests to internet via forwarders. ``` |Forwarder ----------------->| Listener --> | | Internet @@ -9,33 +9,36 @@ we can set up local listeners as proxy, and forward requests to internet via for ``` ## Features -Listen(local server): +Listen(local proxy server): - Socks5 proxy - Http proxy - SS proxy - Linux transparent proxy(iptables redirect) - TCP tunnel -- DNS forwarding server(udp2tcp) - - Listen on UDP and forward dns requests to remote dns server in TCP via forwarders - - Specify different upstream dns server based on destinations(in rule file) - - Tunnel mode: forward to a specified upstream dns server - - Add resolved IPs to proxy rules - - Add resolved IPs to ipset +- DNS Tunnel(udp2tcp) -Forward(upstream proxy): +Forward(upstream proxy server): - Socks5 proxy - Http proxy - SS proxy +DNS Forwarding Server(udp2tcp) +- Listen on UDP and forward dns requests to remote dns server in TCP via forwarders +- Specify different upstream dns server based on destinations(in rule file) +- Tunnel mode: forward to a fixed upstream dns server +- Add resolved IPs to proxy rules +- Add resolved IPs to ipset + +Ipset Management +- Add ip/cidrs from rule files on startup +- Add resolved ips for domains from rule files by dns forwarding server + General: - Http and socks5 on the same port - Forward chain - HA or RR strategy for multiple forwarders - Periodical proxy checking - Rule proxy based on destinations: [Config Examples](config/examples) -- Ipset management - - Add ip/cidrs from rule files on startup - - Add resolved ips for domains from rule files by dns forwarding server TODO: - [ ] UDP Tunnel @@ -159,13 +162,12 @@ Examples: ``` ## Advance Usage -- [config file & rule file](config) -- [glider.conf.example](config/glider.conf.example) -- [office.rule.example](config/rules.d/office.rule.example) -- [examples](config/examples) -- Transparent Proxy: - - [with dnsmasq](config/examples/8.transparent_proxy_with_dnsmasq) - - [without dnsmasq](config/examples/9.transparent_proxy_without_dnsmasq) +- [ConfigFile](config) + - [glider.conf.example](config/glider.conf.example) + - [office.rule.example](config/rules.d/office.rule.example) +- [Examples](config/examples) + - [Transparent proxy with dnsmasq](config/examples/8.transparent_proxy_with_dnsmasq) + - [Transparent proxy without dnsmasq](config/examples/9.transparent_proxy_without_dnsmasq) ## Service - systemd: [https://github.com/nadoo/glider/blob/master/systemd/](https://github.com/nadoo/glider/blob/master/systemd/) diff --git a/config/glider.conf.example b/config/glider.conf.example index a5f1721..e0c15f6 100644 --- a/config/glider.conf.example +++ b/config/glider.conf.example @@ -3,7 +3,7 @@ # / /`_ | | | | | | \ | |_ | |_) # \_\_/ |_|__ |_| |_|_/ |_|__ |_| \ # -# Glider is a forward proxy with multiple protocols support. +# Glider is a forward proxy with multiple protocols support, and also a dns forwarding server with ipset management features(like dnsmasq). # # We can set up local listeners as proxy, and forward requests to internet via forwarders. #