You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+49-31
Original file line number
Diff line number
Diff line change
@@ -5,7 +5,7 @@
5
5
6
6
[ä¸æ–‡è¯´æ˜Ž]
7
7
8
-
####Features
8
+
## Features
9
9
10
10
1. System proxy configuration
11
11
2. PAC mode and global mode
@@ -15,15 +15,15 @@
15
15
6. Supports UDP relay (see Usage)
16
16
7. Supports plugins
17
17
18
-
#### Download
18
+
##Downloads
19
19
20
20
Download the latest release from [release page].
21
21
22
-
####Requirements
22
+
## Requirements
23
23
24
24
Microsoft [.NET Framework 4.7.2] or higher, Microsoft [Visual C++ 2015 Redistributable] (x86) .
25
25
26
-
#### Basic
26
+
##Basics
27
27
28
28
1. Find Shadowsocks icon in the notification tray
29
29
2. You can add multiple servers in servers menu
@@ -33,38 +33,51 @@ proxy addons in your browser, or set them to use system proxy
33
33
system proxy. Set Socks5 or HTTP proxy to 127.0.0.1:1080. You can change this
34
34
port in `Servers -> Edit Servers`
35
35
36
-
####PAC
36
+
## PAC
37
37
38
-
1. You can change PAC rules by editing the PAC file. When you save the PAC file
39
-
with any editor, Shadowsocks will notify browsers about the change automatically
40
-
2. You can also update PAC file from [GeoSite]\(maintained by 3rd party)
41
-
3. You can also use online PAC URL
38
+
- The PAC rules are generated from the geosite database in [v2fly/domain-list-community](https://github.com/v2fly/domain-list-community).
39
+
- Generation modes: whitelist mode and blacklist mode.
40
+
- Domain groups: `geositeDirectGroups` and `geositeProxiedGroups`.
41
+
-`geositeDirectGroups` is initialized with `cn` and `geolocation-!cn@cn`.
42
+
-`geositeProxiedGroups` is initialized with `geolocation-!cn`.
43
+
- To switch between different modes, modify the `geositePreferDirect` property in `gui-config.json`
44
+
- When `geositePreferDirect` is false (default), PAC works in whitelist mode. Exception rules are generated from `geositeDirectGroups`. Unmatched domains goes through the proxy.
45
+
- When `geositePreferDirect` is true, PAC works in blacklist mode. Blocking rules are generated from `geositeProxiedGroups`. Exception rules are generated from `geositeDirectGroups`. Unmatched domains are connected to directly.
46
+
- Starting from 4.3.0.0, shadowsocks-windows defaults to whitelist mode with Chinese domains excluded from connecting via the proxy.
47
+
- The new default values make sure that:
48
+
- When in whitelist mode, Chinese domains, including non-Chinese companies' Chinese CDNs, are connected to directly.
49
+
- When in blacklist mode, only non-Chinese domains goes through the proxy. Chinese domains, as well as non-Chinese companies' Chinese CDNs, are connected to directly.
50
+
51
+
### User-defined rules
52
+
53
+
- To define your own PAC rules, it's recommended to use the `user-rule.txt` file.
54
+
- You can also modify `pac.txt` directly. But your modifications won't persist after updating geosite from the upstream.
42
55
43
56
For Windows10 Store and related applications, please execute the following command under Admin privilege:
44
57
```
45
58
netsh winhttp import proxy source=ie
46
59
```
47
60
48
-
####Server Auto Switching
61
+
## Server Auto Switching
49
62
50
63
1. Load balance: choosing server randomly
51
64
2. High availability: choosing the best server (low latency and packet loss)
52
65
3. Choose By Total Package Loss: ping and choose. Please also enable
53
66
`Availability Statistics` in the menu if you want to use this
54
67
4. Write your own strategy by implement IStrategy interface and send us a pull request!
55
68
56
-
####UDP
69
+
## UDP
57
70
58
71
For UDP, you need to use SocksCap or ProxyCap to force programs you want
59
72
to be proxied to tunnel over Shadowsocks
60
73
61
-
####Multiple Instances
74
+
## Multiple Instances
62
75
63
76
If you want to manage multiple servers using other tools like SwitchyOmega,
64
77
you can start multiple Shadowsocks instances. To avoid configuration conflicts,
65
78
copy Shadowsocks to a new directory and choose a different local port.
66
79
67
-
####Plugins
80
+
## Plugins
68
81
69
82
If you would like to connect to server via a plugin, please set the plugin's
70
83
path (relative or absolute) on Edit Servers form.
@@ -73,65 +86,70 @@ _Note_: Forward Proxy will not be used while a plugin is enabled.
73
86
Details:
74
87
[Working with non SIP003 standard Plugin].
75
88
76
-
####Global hotkeys
89
+
## Global hotkeys
77
90
78
91
Hotkeys could be registered automatically on startup.
79
92
If you are using multiple instances of Shadowsocks,
80
93
you must set different key combination for each instance.
81
94
82
-
#####How to input?
95
+
### How to input?
83
96
84
97
1. Put focus in the corresponding textbox.
85
98
2. Press the key combination that you want to use.
86
99
3. Release all keys when you think it is ready.
87
100
4. Your input appears in the textbox.
88
101
89
-
#####How to change?
102
+
### How to change?
90
103
91
104
1. Put focus in the corresponding textbox.
92
105
2. Press BackSpace key to clear content.
93
106
3. Re-input new key combination.
94
107
95
-
#####How to deactivate?
108
+
### How to deactivate?
96
109
97
110
1. Clear content in the textbox that you want to deactivate,
98
111
if you want to deactivate all, please clear all textboxes.
99
112
2. Press OK button to confirm.
100
113
101
-
#####Meaning of label color
114
+
### Meaning of label color
102
115
103
116
- Green: This key combination is not occupied by other programs and register successfully.
104
117
- Yellow: This key combination is occupied by other programs and you have to change to another one.
105
118
- Transparent without color: The initial status.
106
119
107
-
####Server Configuration
120
+
## Server Configuration
108
121
109
122
Please visit [Servers] for more information.
110
123
111
-
####Experimental
124
+
## Experimental
112
125
113
126
[Experimental Features]
114
127
115
-
####Development
128
+
## Development
116
129
117
-
1.[Visual Studio 2017] & [.NET Framework 4.7.2 Developer Pack] are required.
130
+
1.[Visual Studio 2019] & [.NET Framework 4.7.2 Developer Pack] are required.
118
131
2. It is recommended to share your idea on the Issue Board before you start to work,
0 commit comments