bughz/glider
1
0
Fork 0
mirror of https://github.com/nadoo/glider.git synced 2025-11-04 07:42:38 +08:00
Code Issues Actions Packages Projects Releases Wiki Activity

chore: add schemes section to doc

Browse Source
This commit is contained in:
nadoo 2020-12-04 12:49:49 +08:00
parent e6631aaf84
commit 03be29daba
2 changed files with 28 additions and 16 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

34
README.md
View File

@ -149,7 +149,23 @@ glider 0.13.0 usage:
forward strategy, default: rr (default "rr") forward strategy, default: rr (default "rr")
-verbose -verbose
verbose mode verbose mode
```
</details>
run:
```bash
glider -config CONFIGPATH
```
```bash
glider -verbose -listen :8443 -forward SCHEME://HOST:PORT
```
#### Schemes
<details>
<summary>click to see details</summary>
```bash
Available schemes: Available schemes:
listen: mixed ss socks5 http vless trojan trojanc redir redir6 tcp udp tls ws unix kcp listen: mixed ss socks5 http vless trojan trojanc redir redir6 tcp udp tls ws unix kcp
forward: reject ss socks4 socks5 http ssr ssh vless vmess trojan trojanc tcp udp tls ws unix kcp simple-obfs forward: reject ss socks4 socks5 http ssr ssh vless vmess trojan trojanc tcp udp tls ws unix kcp simple-obfs
@ -268,29 +284,16 @@ Forwarder option scheme: FORWARD_URL#OPTIONS
vmess://[security:]uuid@host:port?alterID=num#priority=200 vmess://[security:]uuid@host:port?alterID=num#priority=200
vmess://[security:]uuid@host:port?alterID=num#priority=200&interface=192.168.1.99 vmess://[security:]uuid@host:port?alterID=num#priority=200&interface=192.168.1.99
vmess://[security:]uuid@host:port?alterID=num#priority=200&interface=eth0 vmess://[security:]uuid@host:port?alterID=num#priority=200&interface=eth0
Config file format(see `./glider.conf.example` as an example):
# COMMENT LINE
KEY=VALUE
KEY=VALUE
# KEY equals to command line flag name: listen forward strategy...
``` ```
</details> </details>
run: #### Examples
```bash
glider -config CONFIGPATH
```
```bash
glider -verbose -listen :8443 -forward SCHEME://HOST:PORT
```
### Examples
<details> <details>
<summary>click to see details</summary> <summary>click to see details</summary>
```bash
./glider -config glider.conf ./glider -config glider.conf
-run glider with specified config file. -run glider with specified config file.
@ -327,6 +330,7 @@ glider -verbose -listen :8443 -forward SCHEME://HOST:PORT
Services: Services:
dhcpd: service=dhcpd,INTERFACE,START_IP,END_IP dhcpd: service=dhcpd,INTERFACE,START_IP,END_IP
e.g.,service=dhcpd,eth1,192.168.50.100,192.168.50.199 e.g.,service=dhcpd,eth1,192.168.50.100,192.168.50.199
```
</details> </details>

10
config/README.md
View File

@ -4,7 +4,15 @@ Command:
```bash ```bash
glider -config glider.conf glider -config glider.conf
``` ```
Config file, **just use the command line flag name as the key name**: Config file, **just use the command line flag name as key name**:
```bash
# COMMENT LINE
KEY=VALUE
KEY=VALUE
# KEY equals to command line flag name: listen forward strategy...
```
Example:
```bash ```bash
### glider config file ### glider config file