Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
shiroedev2024 authored Apr 29, 2024
1 parent 687687f commit 631254a
Showing 1 changed file with 17 additions and 15 deletions.
32 changes: 17 additions & 15 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,13 +1,13 @@
![releases](https://github.com/eycorsican/leaf/workflows/releases/badge.svg)
![ci](https://github.com/eycorsican/leaf/workflows/ci/badge.svg)
![releases](https://github.com/shiroedev2024/leaf/workflows/releases/badge.svg)
![ci](https://github.com/shiroedev2024/leaf/workflows/ci/badge.svg)

# Leaf

A versatile and efficient proxy framework with nice features suitable for various use cases.

### This repository features

* Support local dns server.
* Support local DNS server.
* Support Vmess aead.
* Support for Vless (Not yet implemented)
* Support DoH.
Expand All @@ -23,7 +23,7 @@ A versatile and efficient proxy framework with nice features suitable for variou
[General]
loglevel = info

# Can set servers port, currently using local dns server port.
# Can set servers port, currently using local DNS server port.
# You can use other servers like 1.1.1.1:53
dns-server = 127.0.0.1:5323
routing-domain-resolve = true
Expand All @@ -35,39 +35,41 @@ socks-port = 1080
http-interface = 127.0.0.1
http-port = 8080

# Following is the listen details for local udp dns server.
# Following are the listen details for the local UDP DNS server.
dns-interface = 127.0.0.1
dns-port = 5323

# tun option only support tun = fd or tun = auto
# auto only works in linux, mac and windows
# auto only works in Linux, Mac, and Windows
tun = auto

[Env]
# Here need to set BYPASS_ADDRS env variable to add bypassing routes.
# In future we will implement a monitor that automatically doing this.
# Here, we need to set BYPASS_ADDRS env variable to add bypassing routes.
# In the future we will implement a monitor that automatically does this.
# NOTE: All items inside [Env] are automatically exported to env variables.
# You export following variables in the shell too.
# You export the following variables in the shell too.
BYPASS_ADDRS=188.114.98.0,188.114.99.0
ENABLE_IPV6=true
PREFER_IPV6=true

# Here can set API listen details.
# Here can set API listen address details.
# Then you can use http://127.0.0.1:9090/api/v1/runtime/stat/html to see current connections.
# Or http://127.0.0.1:9090/api/v1/runtime/usage/json to see total usage
API_LISTEN=127.0.0.1:9090

# Here you can set REMOTE DNS servers for local DNS client.
# Here you can set REMOTE DNS servers for local DNS clients.
# If you need to connect to DNS servers directly so add IPs to BYPASS_ADDRS env variable.
# Currently supporting doh (DNS over HTTPS), dot (DNS over TLS) and tcp
# Currently supporting doh (DNS over HTTPS), dot (DNS over TLS) and TCP
# By default a round-robin scheduling balancing is used for remote servers.
# We will make new balancing methods in the future.
[Dns]
CF1 = doh, 188.114.98.0, 443, domain=cloudflare-dns.com, path=/dns-query, post=true, fragment=true, fragment-packets=0-1, fragment-length=6-19, fragment-interval=8-12
CF2 = doh, 188.114.99.0, 443, domain=cloudflare-dns.com, path=/dns-query, post=true, fragment=true, fragment-packets=0-1, fragment-length=6-19, fragment-interval=8-12

# Here and also in above section meaning [Dns] you can enable TLS fragmentation.
# Here and in the above section meaning [Dns] you can enable TLS fragmentation.
# By setting the fragment option to true.
# This will fragment the tls hello handshake (0-1 meaning first packet or tls hello handshake packet)
# Into smaller packets (fragment-length=min,max in bytes) and send them by delay (fragment-interval=min,max in millis)
# This will fragment the TLS hello handshake (0-1 meaning first packet or TLS hello handshake packet)
# Into smaller packets (fragment-length=min,max in bytes) and send them by delay (fragment-interval=min,max in Millis)
[Proxy]
GB1 = trojan, 188.114.98.0, 443, password=test, tls=true, fragment=true, fragment-packets=0-1, fragment-length=6-19, fragment-interval=8-12, sni=new.myfakefirstdomaincard.top, ws=true, ws-host=new.myfakefirstdomaincard.top, ws-path=/chat, amux=true, amux-max=16, amux-con=4
GB2 = trojan, 188.114.99.0, 443, password=test, tls=true, fragment=true, fragment-packets=0-1, fragment-length=6-19, fragment-interval=8-12, sni=new.myfakefirstdomaincard.top, ws=true, ws-host=new.myfakefirstdomaincard.top, ws-path=/chat, amux=true, amux-max=16, amux-con=4
Expand Down

0 comments on commit 631254a

Please sign in to comment.