Skip to content

Commit b851cc0

Browse files
authored
Update README.md
1 parent d2f42cc commit b851cc0

File tree

1 file changed

+40
-0
lines changed

1 file changed

+40
-0
lines changed

README.md

Lines changed: 40 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,42 @@
11
# SsKeyParser
22
Parser for shadowsocks keys on web pages
3+
4+
This app is extract shadowsocks keys from web pages and telegramm channels
5+
To run it type in terminal "path_to_app path_to_config_file"
6+
Example for linux
7+
```
8+
/bin/sskeyparser-nix64 /etc/sskeyparser/config.json
9+
```
10+
### Parameters explanation
11+
```
12+
"ssconfigfile":"/etc/shadowsocks/config.json",
13+
```
14+
Path to shadowsocks config file
15+
```
16+
"sspath":"/bin/systemctl",
17+
"ssrestartcommand":[
18+
"restart",
19+
"sslocal.service"
20+
],
21+
```
22+
Parameter block for restarting shadowsocks. If shadowsocks is not running as a service, this section may look like this.
23+
```
24+
"sspath":"/bin/shadowsocks/sslocal",
25+
"ssrestartcommand":[
26+
"-c",
27+
"/etc/shadowsocks/config.json"
28+
],
29+
```
30+
31+
```
32+
"ssconfigsectionpath":[
33+
"servers"
34+
],
35+
```
36+
Section name in shadowsocks config file, where servers will be added. Your shadowsocks config file must contain this section even it has no servers configurations
37+
Exampl of shadowsocks config.json
38+
```
39+
{
40+
"local_adress"
41+
}
42+
```

0 commit comments

Comments
 (0)