xmengnet/mihomo
1
1
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Chore: update README.md

Browse source
This commit is contained in:
gVisor bot 2019-12-08 12:34:05 +08:00
parent ecc943997d
commit 865fb297f3
1 changed files with 143 additions and 138 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

99
README.md
View file

@ -6,6 +6,9 @@
<h4 align="center">A rule-based tunnel in Go.</h4> <h4 align="center">A rule-based tunnel in Go.</h4>
<p align="center"> <p align="center">
<a href="https://github.com/Dreamacro/clash/actions">
<img src="https://img.shields.io/github/workflow/status/Dreamacro/clash/Go?style=flat-square" alt="Github Actions">
</a>
<a href="https://goreportcard.com/report/github.com/Dreamacro/clash"> <a href="https://goreportcard.com/report/github.com/Dreamacro/clash">
<img src="https://goreportcard.com/badge/github.com/Dreamacro/clash?style=flat-square"> <img src="https://goreportcard.com/badge/github.com/Dreamacro/clash?style=flat-square">
</a> </a>
@ -17,7 +20,6 @@
## Features ## Features
- Local HTTP/HTTPS/SOCKS server - Local HTTP/HTTPS/SOCKS server
- Surge-like configuration format
- GeoIP rule support - GeoIP rule support
- Supports Vmess, Shadowsocks, Snell and SOCKS5 protocol - Supports Vmess, Shadowsocks, Snell and SOCKS5 protocol
- Supports Netfilter TCP redirecting - Supports Netfilter TCP redirecting
@ -70,7 +72,7 @@ $ clash -d .
``` ```
<details> <details>
<summary>This is an example configuration file</summary> <summary>This is an example configuration file (click to expand)</summary>
```yml ```yml
# port of HTTP # port of HTTP
@ -140,15 +142,14 @@ experimental:
# - 240.0.0.0/4 # - 240.0.0.0/4
Proxy: Proxy:
# shadowsocks
# shadowsocks # The supported ciphers(encrypt methods):
# The supported ciphers(encrypt methods): # aes-128-gcm aes-192-gcm aes-256-gcm
# aes-128-gcm aes-192-gcm aes-256-gcm # aes-128-cfb aes-192-cfb aes-256-cfb
# aes-128-cfb aes-192-cfb aes-256-cfb # aes-128-ctr aes-192-ctr aes-256-ctr
# aes-128-ctr aes-192-ctr aes-256-ctr # rc4-md5 chacha20 chacha20-ietf xchacha20
# rc4-md5 chacha20 chacha20-ietf xchacha20 # chacha20-ietf-poly1305 xchacha20-ietf-poly1305
# chacha20-ietf-poly1305 xchacha20-ietf-poly1305 - name: "ss1"
- name: "ss1"
type: ss type: ss
server: server server: server
port: 443 port: 443
@ -156,8 +157,8 @@ Proxy:
password: "password" password: "password"
# udp: true # udp: true
# old obfs configuration format remove after prerelease # old obfs configuration format remove after prerelease
- name: "ss2" - name: "ss2"
type: ss type: ss
server: server server: server
port: 443 port: 443
@ -168,7 +169,7 @@ Proxy:
mode: tls # or http mode: tls # or http
# host: bing.com # host: bing.com
- name: "ss3" - name: "ss3"
type: ss type: ss
server: server server: server
port: 443 port: 443
@ -185,9 +186,9 @@ Proxy:
# headers: # headers:
# custom: value # custom: value
# vmess # vmess
# cipher support auto/aes-128-gcm/chacha20-poly1305/none # cipher support auto/aes-128-gcm/chacha20-poly1305/none
- name: "vmess" - name: "vmess"
type: vmess type: vmess
server: server server: server
port: 443 port: 443
@ -202,8 +203,8 @@ Proxy:
# ws-headers: # ws-headers:
# Host: v2ray.com # Host: v2ray.com
# socks5 # socks5
- name: "socks" - name: "socks"
type: socks5 type: socks5
server: server server: server
port: 443 port: 443
@ -213,8 +214,8 @@ Proxy:
# skip-cert-verify: true # skip-cert-verify: true
# udp: true # udp: true
# http # http
- name: "http" - name: "http"
type: http type: http
server: server server: server
port: 443 port: 443
@ -223,8 +224,8 @@ Proxy:
# tls: true # https # tls: true # https
# skip-cert-verify: true # skip-cert-verify: true
# snell # snell
- name: "snell" - name: "snell"
type: snell type: snell
server: server server: server
port: 44046 port: 44046
@ -234,8 +235,8 @@ Proxy:
# host: bing.com # host: bing.com
Proxy Group: Proxy Group:
# url-test select which proxy will be used by benchmarking speed to a URL. # url-test select which proxy will be used by benchmarking speed to a URL.
- name: "auto" - name: "auto"
type: url-test type: url-test
proxies: proxies:
- ss1 - ss1
@ -244,8 +245,8 @@ Proxy Group:
url: 'http://www.gstatic.com/generate_204' url: 'http://www.gstatic.com/generate_204'
interval: 300 interval: 300
# fallback select an available policy by priority. The availability is tested by accessing an URL, just like an auto url-test group. # fallback select an available policy by priority. The availability is tested by accessing an URL, just like an auto url-test group.
- name: "fallback-auto" - name: "fallback-auto"
type: fallback type: fallback
proxies: proxies:
- ss1 - ss1
@ -254,8 +255,8 @@ Proxy Group:
url: 'http://www.gstatic.com/generate_204' url: 'http://www.gstatic.com/generate_204'
interval: 300 interval: 300
# load-balance: The request of the same eTLD will be dial on the same proxy. # load-balance: The request of the same eTLD will be dial on the same proxy.
- name: "load-balance" - name: "load-balance"
type: load-balance type: load-balance
proxies: proxies:
- ss1 - ss1
@ -264,9 +265,9 @@ Proxy Group:
url: 'http://www.gstatic.com/generate_204' url: 'http://www.gstatic.com/generate_204'
interval: 300 interval: 300
# select is used for selecting proxy or proxy group # select is used for selecting proxy or proxy group
# you can use RESTful API to switch proxy, is recommended for use in GUI. # you can use RESTful API to switch proxy, is recommended for use in GUI.
- name: Proxy - name: Proxy
type: select type: select
proxies: proxies:
- ss1 - ss1
@ -275,23 +276,26 @@ Proxy Group:
- auto - auto
Rule: Rule:
- DOMAIN-SUFFIX,google.com,auto - DOMAIN-SUFFIX,google.com,auto
- DOMAIN-KEYWORD,google,auto - DOMAIN-KEYWORD,google,auto
- DOMAIN,google.com,auto - DOMAIN,google.com,auto
- DOMAIN-SUFFIX,ad.com,REJECT - DOMAIN-SUFFIX,ad.com,REJECT
# rename SOURCE-IP-CIDR and would remove after prerelease # rename SOURCE-IP-CIDR and would remove after prerelease
- SRC-IP-CIDR,192.168.1.201/32,DIRECT - SRC-IP-CIDR,192.168.1.201/32,DIRECT
# optional param "no-resolve" for IP rules (GEOIP IP-CIDR) # optional param "no-resolve" for IP rules (GEOIP IP-CIDR)
- IP-CIDR,127.0.0.0/8,DIRECT - IP-CIDR,127.0.0.0/8,DIRECT
- GEOIP,CN,DIRECT - GEOIP,CN,DIRECT
- DST-PORT,80,DIRECT - DST-PORT,80,DIRECT
- SRC-PORT,7777,DIRECT - SRC-PORT,7777,DIRECT
# FINAL would remove after prerelease # FINAL would remove after prerelease
# you also can use `FINAL,Proxy` or `FINAL,,Proxy` now # you also can use `FINAL,Proxy` or `FINAL,,Proxy` now
- MATCH,auto - MATCH,auto
``` ```
</details> </details>
## Advanced
[Provider](https://github.com/Dreamacro/clash/wiki/Provider)
## Documentations ## Documentations
https://clash.gitbook.io/ https://clash.gitbook.io/
@ -310,4 +314,5 @@ https://clash.gitbook.io/
- [x] Complementing the necessary rule operators - [x] Complementing the necessary rule operators
- [x] Redir proxy - [x] Redir proxy
- [x] UDP support - [x] UDP support
- [ ] Connection manager - [x] Connection manager
- [ ] Event API