Skip to content

Commit bdebe4a

Browse files
committed
warning for misleading "local_address" in servers
1 parent 68d315e commit bdebe4a

File tree

1 file changed

+10
-5
lines changed

1 file changed

+10
-5
lines changed

README.md

Lines changed: 10 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -111,22 +111,24 @@ Read `Cargo.toml` for more details.
111111

112112
Create a ShadowSocks' configuration file. Example
113113

114-
```json
114+
```jsonc
115115
{
116116
"server": "my_server_ip",
117117
"server_port": 8388,
118-
"local_address": "127.0.0.1",
119-
"local_port": 1080,
120118
"password": "mypassword",
121-
"method": "aes-256-gcm"
119+
"method": "aes-256-gcm",
120+
// ONLY FOR `sslocal`
121+
// Delete these lines if you are running `ssserver` or `ssmanager`
122+
"local_address": "127.0.0.1",
123+
"local_port": 1080
122124
}
123125
```
124126

125127
Detailed explanation could be found in [shadowsocks' documentation](https://github.com/shadowsocks/shadowsocks/wiki).
126128

127129
In shadowsocks-rust, we also have an extended configuration file format, which is able to define more than one server. You can also disable individual servers.
128130

129-
```json
131+
```jsonc
130132
{
131133
"servers": [
132134
{
@@ -150,6 +152,8 @@ In shadowsocks-rust, we also have an extended configuration file format, which i
150152
"method": "chacha20-ietf-poly1305"
151153
}
152154
],
155+
// ONLY FOR `sslocal`
156+
// Delete these lines if you are running `ssserver` or `ssmanager`
153157
"local_port": 1080,
154158
"local_address": "127.0.0.1"
155159
}
@@ -291,6 +295,7 @@ Example configuration:
291295
{
292296
// LOCAL: Listen address. This is exactly the same as `locals[0]`
293297
// SERVER: Bind address for remote sockets, mostly used for choosing interface
298+
// Don't set it if you don't know what's this for.
294299
"local_address": "127.0.0.1",
295300
"local_port": 1080,
296301

0 commit comments

Comments
 (0)