File tree 9 files changed +87
-14
lines changed
9 files changed +87
-14
lines changed Original file line number Diff line number Diff line change 1
- # watfaq.github.io
1
+ # docs. watfaq.com/clash
2
2
3
3
## Development
4
4
Original file line number Diff line number Diff line change
1
+ ## Simplified usage
2
+
3
+ - HTTP Proxy
4
+
5
+ ``` yaml
6
+ # port of HTTP proxy server
7
+ port : 7890
8
+ ` ` `
9
+
10
+ - SOCKS Proxy
11
+
12
+ ` ` ` yaml
13
+ socks-port : 7891
14
+ ` ` `
15
+
16
+ !!! Tip
17
+ Top-level HTTP/SOCKS/Mixed/Tproxy will be converted into inbounds add included in ` listeners`
18
+
19
+ | Type | Mapped inbound name |
20
+ | ---------- | -------------------- |
21
+ | `HTTP` | `HTTP-IN` |
22
+ | `SOCKS` | `SOCKS-IN` |
23
+ | `Mixed` | `MIXED-IN` |
24
+ | `Tproxy` | `TPROXY-IN` |
25
+
26
+ # # Supported Inbound Types
27
+
28
+ - http
29
+ - socks
30
+ - mixed
31
+ - tproxy
32
+ - tunnel
33
+
34
+
35
+ # # Common Options
36
+
37
+ ` ` ` yaml
38
+ listeners:
39
+ - name: in-http
40
+ type: http #(3)
41
+ port: 15201
42
+ listen: 127.0.0.1 #(4)
43
+ proxy: out-tuic #(1)
44
+ ...... #(2)
45
+ ` ` `
46
+
47
+ 1. Optional, outbound name. Any traffic through this inbound will directly go to `proxy`
48
+ 2. There could be more fields in real inbound
49
+ 3. [Allowed Values](./#supported-inbound-types)
50
+ 4. [Type : BindAddress](../../config/types/#bindaddress) <br> Address of inbound server
Original file line number Diff line number Diff line change
1
+ ## BindAddress
Original file line number Diff line number Diff line change @@ -21,8 +21,12 @@ theme:
21
21
- navigation.tabs
22
22
- navigation.sections
23
23
- content.action.edit
24
+ # markdown_extensions Code blocks
24
25
- content.code.copy
25
- - content.code.select
26
+ - content.code.annotate
27
+
28
+ # markdown_extensions.pymdownx.tabbed
29
+ - content.tabs.link
26
30
palette :
27
31
- media : " (prefers-color-scheme)"
28
32
toggle :
@@ -42,29 +46,47 @@ theme:
42
46
toggle :
43
47
icon : material/toggle-switch-off
44
48
name : Switch to system preference
45
- # https://facelessuser .github.io/pymdown-extensions /
49
+ # https://squidfunk .github.io/mkdocs-material/reference /
46
50
markdown_extensions :
51
+ # Admonitions
52
+ - admonition
53
+ - pymdownx.details
47
54
- pymdownx.superfences
48
- - pymdownx.tabbed :
49
- alternate_style : true
55
+ # Code blocks
50
56
- pymdownx.highlight :
51
57
anchor_linenums : true
52
- - pymdownx.critic
53
- - admonition
54
- - pymdownx.details
58
+ line_spans : __span
59
+ pygments_lang_class : true
55
60
- pymdownx.inlinehilite
56
- - pymdownx.keys
57
61
- pymdownx.snippets
62
+ # Content tabs
63
+ - pymdownx.tabbed :
64
+ alternate_style : true
65
+ # Foramtting
66
+ - pymdownx.critic
67
+ - pymdownx.keys
68
+ - pymdownx.keys
69
+ - pymdownx.mark
70
+ - pymdownx.tilde
71
+ # Lists
72
+ - def_list
73
+ - pymdownx.tasklist :
74
+ custom_checkbox : true
58
75
59
76
nav :
60
77
- Welcome : index.md
61
78
- Quick start :
62
- - quick-start/index.md
63
- - CLI : quick-start/cli.md
64
- - GUI : quick-start/gui.md
79
+ - quick-start/index.md
80
+ - CLI : quick-start/cli.md
81
+ - GUI : quick-start/gui.md
65
82
- Configuration :
66
- - config/index.md
67
- - Full Example : config/full.md
83
+ - config/index.md
84
+ - Full Example : config/full.md
85
+ - Inbounds :
86
+ - config/inbounds/index.md
87
+ - HTTP : config/inbounds/http.md
88
+ - SOCKS : config/inbounds/socks.md
89
+ - Tunnel : config/inbounds/tunnel.md
68
90
69
91
plugins :
70
92
# - search
You can’t perform that action at this time.
0 commit comments