1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
|
.\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.47.13.
.TH GNB 8 "December 2021" "VERSION 1.2.8.1"
.SH NAME
gnb \- gnb command to setup VPN used by opengnb
.SH SYNOPSIS
.B gnb
[\fI\,-i IFNAME\/\fR] \fI\,-c CONFIG_PATH \/\fR[\fI\,OPTION\/\fR]
.SH DESCRIPTION
.TP
GNB version 1.2.8.1 protocol version 1.1.2
.TP
registered packet filter: gnb_pf_dump gnb_pf_route gnb_pf_crypto_xor gnb_pf_crypto_arc4
.SH "Command Summary:"
.TP
\fB\-c\fR, \fB\-\-conf\fR
config path
.TP
\fB\-n\fR, \fB\-\-nodeid\fR
nodeid
.TP
\fB\-P\fR, \fB\-\-public\-index\-service\fR
run as public index service
.TP
\fB\-I\fR, \fB\-\-index\-address\fR
index address
.TP
\fB\-a\fR, \fB\-\-node\-address\fR
node ip address
.TP
\fB\-r\fR, \fB\-\-node\-route\fR
node route
.TP
\fB\-i\fR, \fB\-\-ifname\fR
TUN Device Name, it's gnb_tun in Linux default.
.TP
\fB\-4\fR, \fB\-\-ipv4\-only\fR
Use IPv4 Only
.TP
\fB\-6\fR, \fB\-\-ipv6\-only\fR
Use IPv6 Only
.TP
\fB\-d\fR, \fB\-\-daemon\fR
daemon
.TP
\fB\-q\fR, \fB\-\-quiet\fR
disabled console output
.TP
\fB\-t\fR, \fB\-\-selftest\fR
self test
.TP
\fB\-p\fR, \fB\-\-passcode\fR
a hexadecimal string of 32\-bit unsigned integer, use to strengthen safety default is 0x9d078107
.TP
\fB\-l\fR, \fB\-\-listen\fR
listen address default is '0.0.0.0:9001'
.TP
\fB\-b\fR, \fB\-\-ctl\-block\fR
ctl block mapper file
.TP
\fB\-e\fR, \fB\-\-es\-argv\fR
pass\-through gnb_es argv
.TP
\fB\-V\fR, \fB\-\-verbose\fR
verbose mode
.TP
\fB\-\-node\-woker\-queue\fR
node woker queue length
.TP
\fB\-\-index\-woker\-queue\fR
index woker queue length
.TP
\fB\-\-index\-service\-woker\-queue\fR
index service woker queue length
.TP
\fB\-\-port\-detect\-start\fR
port detect start
.TP
\fB\-\-port\-detect\-end\fR
port detect end
.TP
\fB\-\-port\-detect\-range\fR
port detect range
.TP
\fB\-\-mtu\fR
TUN Device MTU ipv4：532～1500, ipv6: 1280～1500
.TP
\fB\-\-crypto\fR
ip frame crypto 'xor' or 'arc4' or 'none' default is 'xor'
.HP
\fB\-\-crypto\-key\-update\-interval\fR crypto key update interval, 'hour' or 'minute' or none default is 'none'
.TP
\fB\-\-multi\-index\-type\fR
\&'simple\-fault\-tolerant' or 'simple\-load\-balance' or 'full' default is 'simple\-load\-balance'
.TP
\fB\-\-multi\-forward\-type\fR
\&'simple\-fault\-tolerant' or 'simple\-load\-balance' default is 'simple\-fault\-tolerant'
.TP
\fB\-\-socket\-if\-name\fR
example: 'eth0', 'eno1', only for unix\-like os
.TP
\fB\-\-address\-secure\fR
hide part of ip address in logs 'on' or 'off' default is 'on'
.TP
\fB\-\-if\-dump\fR
dump the interface data frame 'on' or 'off' default is 'off'
.TP
\fB\-\-pf\-route\fR
packet filter route
.TP
\fB\-\-multi\-socket\fR
\&'on' or 'off' default is 'off'
.TP
\fB\-\-direct\-forwarding\fR
\&'on' or 'off' default is 'on'
.TP
\fB\-\-set\-tun\fR
\&'on' or 'off' default is 'on'
.TP
\fB\-\-index\-worker\fR
\&'on' or 'off' default is 'on'
.TP
\fB\-\-index\-service\-worker\fR
\&'on' or 'off' default is 'on'
.TP
\fB\-\-node\-detect\-worker\fR
\&'on' or 'off' default is 'on'
.TP
\fB\-\-set\-fwdu0\fR
\&'on' or 'off' default is 'on'
.TP
\fB\-\-pid\-file\fR
pid file
.TP
\fB\-\-node\-cache\-file\fR
node address cache file
.TP
\fB\-\-log\-file\-path\fR
log file path
.TP
\fB\-\-log\-udp4\fR
send log to the address ipv4 default is '127.0.0.1:9000'
.TP
\fB\-\-log\-udp\-type\fR
log udp type 'binary' or 'text' default is 'binary'
.TP
\fB\-\-console\-log\-level\fR
log console level 0\-3
.TP
\fB\-\-file\-log\-level\fR
log file level 0\-3
.TP
\fB\-\-udp\-log\-level\fR
log udp level 0\-3
.TP
\fB\-\-core\-log\-level\fR
core log level 0\-3
.TP
\fB\-\-pf\-log\-level\fR
packet filter log level 0\-3
.TP
\fB\-\-main\-log\-level\fR
main log level 0\-3
.TP
\fB\-\-node\-log\-level\fR
node log level 0\-3
.TP
\fB\-\-index\-log\-level\fR
index log level 0\-3
.TP
\fB\-\-index\-service\-log\-level\fR
index service log level 0\-3
.TP
\fB\-\-node\-detect\-log\-level\fR
node detect log level 0\-3
.HP
\fB\-\-help\fR
.PP
.SH Example:
.TP
\&./gnb \fB\-i\fR gnbtun \fB\-c\fR $node_conf_dir \fB\-e "\-\-upnp"
.TP
\&./gnb \fB\-P\fR
.TP
\&./gnb \fB\-P\fR \fB\-\-console\-log\-level\fR=\fI\,3\/\fR \fB\-\-index\-service\-log\-level\fR=\fI\,3\/\fR
.TP
\&./gnb \fB\-n\fR 1001 \fB\-I\fR '$public_index_ip/$port' \fB\-p\fR $passcode
.TP
\&./gnb \fB\-n\fR 1002 \fB\-I\fR '$public_index_ip/$port' \fB\-p\fR $passcode
.TP
\&./gnb \fB\-n\fR 1001 \fB\-a\fR 'i/0/$public_index_ip/$port' \fB\-p\fR $passcode
.TP
\&./gnb \fB\-n\fR 1002 \fB\-a\fR 'i/0/$public_index_ip/$port' \fB\-p\fR $passcode
.SH SEE ALSO
gnb_crypto(1), gnb_ctl(8), gnb_es(8)
.SH HOMEPAGE
Source Code and Documentation at https://github.com/gnbdev/opengnb
.SH COPYRIGHT
Copyright \(co 2019-2022 gnbdev<gnbdev@qq.com>
|
