1
1
# relaybaton
2
+
2
3
A pluggable transport to circumvent Internet censorship with Encrypted SNI.
3
4
4
5
[ ![ License: MIT] ( https://img.shields.io/badge/License-MIT-yellow.svg )] ( https://opensource.org/licenses/MIT )
5
- [ ![ GoDoc] ( https://godoc.org/github.com/iyouport-org/relaybaton?status.svg )] ( https://godoc.org /github.com/iyouport-org/relaybaton )
6
+ [ ![ GoDoc] ( https://godoc.org/github.com/iyouport-org/relaybaton?status.svg )] ( https://pkg.go.dev /github.com/iyouport-org/relaybaton )
6
7
[ ![ Go Report Card] ( https://goreportcard.com/badge/github.com/iyouport-org/relaybaton )] ( https://goreportcard.com/report/github.com/iyouport-org/relaybaton )
7
8
8
9
## Getting Started
@@ -19,7 +20,7 @@ go get github.com/iyouport-org/relaybaton
19
20
20
21
#### CLI
21
22
22
- ``` CGO_ENABLED=1 `` ` should be set in cross-compiling
23
+ ` CGO_ENABLED=1 ` should be set in cross-compiling
23
24
24
25
``` bash
25
26
make
@@ -44,13 +45,15 @@ For supporting ESNI features and hiding the IP address of the server from interc
44
45
Cloudflare CDN will provide TLS encryption with ESNI extension.
45
46
46
47
### Server
47
- ``` sudo ``` is required for listening on port 80
48
+
49
+ ` sudo ` is required for listening on port 80
48
50
49
51
``` bash
50
52
sudo relaybation server --config /path/to/server/config.toml
51
53
```
52
54
53
55
### Client
56
+
54
57
``` bash
55
58
relaybation client --config /path/to/client/config.toml
56
59
```
@@ -65,15 +68,15 @@ A local proxy server will listen on the local ports which given in the configura
65
68
[client ]
66
69
port = 1080
67
70
http_port = 1088
68
- transparent_port = 1090
71
+ redir_port = 1090
69
72
server = " example.com"
70
73
username = " username"
71
74
password = " password"
72
75
proxy_all = true
73
76
74
77
[server ]
75
78
port = 80
76
- pretend = " https://www.kernel.org "
79
+ admin_password = " password "
77
80
78
81
[db ]
79
82
type = " sqlite3"
@@ -96,40 +99,40 @@ level = "trace"
96
99
97
100
### Description of the fields
98
101
99
- | Field | TOML Type | Go Type | Description |
100
- | :--------------------- : | :-------: | :-----------------------------------------------: | :--------------------- ---------------------------------: |
101
- | client.port | Integer | uint16 | SOCKS5 port that client listen to |
102
- | client.http_port | Integer | uint16 | HTTP port that client listen to |
103
- | client.transparent_port | Integer | uint16 | Redirect port that client listen to |
104
- | client.server | String | string | domain name of the server |
105
- | client.username | String | string | username of the client |
106
- | client.password | String | string | password of the client |
107
- | client.proxy_all | Boolean | bool | if proxy all traffic |
108
- | server.port | Integer | uint16 | port that server listen to |
109
- | server.pretend | String | url.URL | domain name of the website that the server pretend to be |
110
- | db.type | String | github.com/iyouport-org/relaybaton config.dbType | type of the database |
111
- | db.username | String | string | username for database connection |
112
- | db.password | String | string | password for database connection |
113
- | db.host | String | string | hostname for database connection |
114
- | db.port | Integer | uint16 | port for database connection |
115
- | db.database | String | string | name of database |
116
- | dns.type | String | github.com/iyouport-org/relaybaton config.DNSType | type of DNS resolver |
117
- | dns.server | String | string | server name of the DNS server |
118
- | dns.addr | String | net.Addr | IP address of the DNS server |
119
- | log.file | String | os.File | filename of log file |
120
- | log.level | String | github.com/sirupsen/logrus logrus.Level | minimum log level to write |
102
+ | Field | TOML Type | Go Type | Description |
103
+ | :-------------------: | :-------: | :-----------------------------------------------: | :---------------------------------: |
104
+ | client.port | Integer | uint16 | SOCKS5 port that client listen to |
105
+ | client.http_port | Integer | uint16 | HTTP port that client listen to |
106
+ | client.redir_port | Integer | uint16 | Redirect port that client listen to |
107
+ | client.server | String | string | domain name of the server |
108
+ | client.username | String | string | username of the client |
109
+ | client.password | String | string | password of the client |
110
+ | client.proxy_all | Boolean | bool | if proxy all traffic |
111
+ | server.port | Integer | uint16 | port that server listen to |
112
+ | server.admin_password | String | string | password of account "admin" |
113
+ | db.type | String | github.com/iyouport-org/relaybaton config.dbType | type of the database |
114
+ | db.username | String | string | username for database connection |
115
+ | db.password | String | string | password for database connection |
116
+ | db.host | String | string | hostname for database connection |
117
+ | db.port | Integer | uint16 | port for database connection |
118
+ | db.database | String | string | name of database |
119
+ | dns.type | String | github.com/iyouport-org/relaybaton config.DNSType | type of DNS resolver |
120
+ | dns.server | String | string | server name of the DNS server |
121
+ | dns.addr | String | net.Addr | IP address of the DNS server |
122
+ | log.file | String | os.File | filename of log file |
123
+ | log.level | String | github.com/sirupsen/logrus logrus.Level | minimum log level to write |
121
124
122
125
## Built With
123
126
124
- * [ github.com/cloudflare/tls-tris] ( https://github.com/cloudflare/tls-tris/tree/pwu/esni ) - crypto/tls, now with 100% more 1.3.
127
+ - [ github.com/cloudflare/tls-tris] ( https://github.com/cloudflare/tls-tris/tree/pwu/esni ) - crypto/tls, now with 100% more 1.3.
125
128
126
129
## Versioning
127
130
128
- We use [ SemVer] ( http://semver.org/ ) for versioning. For the versions available, see the [ tags on this repository] ( https://github.com/iyouport-org/relaybaton/tags ) .
131
+ We use [ SemVer] ( http://semver.org/ ) for versioning. For the versions available, see the [ tags on this repository] ( https://github.com/iyouport-org/relaybaton/tags ) .
129
132
130
133
## Authors
131
134
132
- - [ onoketa] ( (https://github.com/onoketa) )
135
+ - [ onoketa] ( < (https://github.com/onoketa) > )
133
136
134
137
See also the list of [ contributors] ( https://github.com/iyouport-org/relaybaton/contributors ) who participated in this project.
135
138
@@ -139,4 +142,4 @@ This project is licensed under the **MIT License** - see the [LICENSE](LICENSE)
139
142
140
143
## Acknowledgments
141
144
142
- * Cloudflare
145
+ - Cloudflare
0 commit comments