bughz/glider
1
0
Fork 0
mirror of https://github.com/nadoo/glider.git synced 2025-11-04 07:42:38 +08:00
Code Issues Actions Packages Projects Releases Wiki Activity

doc: update README file

Browse Source
This commit is contained in:
nadoo 2017-09-03 01:05:56 +08:00
parent 3167df5bb6
commit 3e970bfdaa
2 changed files with 23 additions and 21 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

42
README.md
View File

@ -1,7 +1,7 @@
# [glider](https://github.com/nadoo/glider) # [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 ----------------->| |Forwarder ----------------->|
Listener --> | | Internet Listener --> | | Internet
@ -9,33 +9,36 @@ we can set up local listeners as proxy, and forward requests to internet via for
``` ```
## Features ## Features
Listen(local server): Listen(local proxy server):
- Socks5 proxy - Socks5 proxy
- Http proxy - Http proxy
- SS proxy - SS proxy
- Linux transparent proxy(iptables redirect) - Linux transparent proxy(iptables redirect)
- TCP tunnel - TCP tunnel
- DNS forwarding server(udp2tcp) - DNS Tunnel(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
Forward(upstream proxy): Forward(upstream proxy server):
- Socks5 proxy - Socks5 proxy
- Http proxy - Http proxy
- SS 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: General:
- Http and socks5 on the same port - Http and socks5 on the same port
- Forward chain - Forward chain
- HA or RR strategy for multiple forwarders - HA or RR strategy for multiple forwarders
- Periodical proxy checking - Periodical proxy checking
- Rule proxy based on destinations: [Config Examples](config/examples) - 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: TODO:
- [ ] UDP Tunnel - [ ] UDP Tunnel
@ -159,13 +162,12 @@ Examples:
``` ```
## Advance Usage ## Advance Usage
- [config file & rule file](config) - [ConfigFile](config)
- [glider.conf.example](config/glider.conf.example) - [glider.conf.example](config/glider.conf.example)
- [office.rule.example](config/rules.d/office.rule.example) - [office.rule.example](config/rules.d/office.rule.example)
- [examples](config/examples) - [Examples](config/examples)
- Transparent Proxy: - [Transparent proxy with dnsmasq](config/examples/8.transparent_proxy_with_dnsmasq)
- [with dnsmasq](config/examples/8.transparent_proxy_with_dnsmasq) - [Transparent proxy without dnsmasq](config/examples/9.transparent_proxy_without_dnsmasq)
- [without dnsmasq](config/examples/9.transparent_proxy_without_dnsmasq)
## Service ## Service
- systemd: [https://github.com/nadoo/glider/blob/master/systemd/](https://github.com/nadoo/glider/blob/master/systemd/) - systemd: [https://github.com/nadoo/glider/blob/master/systemd/](https://github.com/nadoo/glider/blob/master/systemd/)

2
config/glider.conf.example
View File

@ -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. # We can set up local listeners as proxy, and forward requests to internet via forwarders.
# #