Skip to content

Commit a28a50d

Browse files
authored
Update README.md
1 parent 2dbddc9 commit a28a50d

File tree

1 file changed

+103
-0
lines changed

1 file changed

+103
-0
lines changed

README.md

Lines changed: 103 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,105 @@
11
# XrayKeyParser
2+
23
Keys parser for xray core.
4+
Supports shadowsocks(outline) and most of vless keys - tls, reality, tcp, websocket, grpc
5+
6+
### Always backup your worked shadowsocks config.json
7+
8+
This app is extract xray keys from web pages and telegramm channels
9+
To run it type in terminal "path_to_app" "path_to_config_file"
10+
Example for linux
11+
```
12+
/bin/xrkeyparser-nix64 /etc/xrkeyparser/config.json
13+
```
14+
### Parameters explanation
15+
```
16+
"xrconfigfile":"/etc/xray/config.json",
17+
```
18+
Path to xray-core config file
19+
```
20+
"xrpath":"/bin/systemctl",
21+
"xrrestartcommand":[
22+
"restart",
23+
"xray.service"
24+
],
25+
```
26+
Block of parameters for restarting xray-core. If xray-core is not running as a service, this section may look like this.
27+
```
28+
"xrpath":"/bin/xray",
29+
"xrrestartcommand":[
30+
"run",
31+
"-c",
32+
"/etc/xray/config.json"
33+
],
34+
```
35+
36+
If xray-core is running as a service, this section may look like this.
37+
```
38+
"xrpath":"/bin/systemctl",
39+
"xrrestartcommand":[
40+
"restart",
41+
"xray.service"
42+
],
43+
```
44+
45+
```
46+
"outputfile":"/etc/xrkeyparser/parsingresult.json",
47+
```
48+
Results of parsing is save to this file.
49+
50+
```
51+
"ssconfigsectionpath":[
52+
"outbounds"
53+
],
54+
```
55+
Section path for shadowsocks outbound connections in xray config file, where servers will be added.
56+
57+
```
58+
"ssserverseditpos":1,
59+
```
60+
Position from which shadowsocks outbound connections will be edited.
61+
62+
```
63+
"sstag":"outss"
64+
```
65+
Tag for shadowsocks outbounds connection
66+
67+
```
68+
"vlessconfigsectionpath":[
69+
"outbounds"
70+
],
71+
"vlessserverseditpos":1,
72+
"vlesstag":"outvless"
73+
```
74+
Same parametrs for vless outbound connections
75+
```
76+
"links":[
77+
{
78+
"url":"https://t.me/some_channel_with_keys",
79+
"mask":[
80+
"ss://"
81+
],
82+
"configcount":3,
83+
"parsetoptobot":false
84+
},
85+
{
86+
"url":"https://www.some_site_with_keys.com/",
87+
"mask":[
88+
"ss://"
89+
],
90+
"configcount":1,
91+
"parsetoptobot":true
92+
}
93+
]
94+
```
95+
Links for parsing. In this section
96+
```
97+
"configcount"
98+
```
99+
how many configs do you want to extract from this page
100+
```
101+
"parsetoptobot"
102+
```
103+
if true parsing will done from top to bottom.
104+
- Use "true" for pages where new information placing at the top, like sites
105+
- Use "false" for pages where new information placing at the

0 commit comments

Comments
 (0)