@@ -9,10 +9,10 @@ Synopsis
9
9
::
10
10
11
11
strelaysrv [-debug] [-ext-address=<address>] [-global-rate=<bytes/s>] [-keys=<dir>] [-listen=<listen addr>]
12
- [-message-timeout=<duration>] [-nat] [-nat-lease=<duration> [-nat-renewal=<duration>]
12
+ [-message-timeout=<duration>] [-nat] [-nat-lease=<duration>] [-nat-renewal=<duration>]
13
13
[-nat-timeout=<duration>] [-network-timeout=<duration>] [-per-session-rate=<bytes/s>]
14
- [-ping-interval=<duration>] [-pools=<pool addresses>] [-protocol=<string> ] [-provided-by =<string>]
15
- [-status-srv=<listen addr>]
14
+ [-ping-interval=<duration>] [-pools=<pool addresses>] [-pprof ] [-protocol =<string>]
15
+ [-provided-by=<string>] [- status-srv=<listen addr>] [-token=<string>] [-version ]
16
16
17
17
Description
18
18
-----------
@@ -89,6 +89,10 @@ Options
89
89
"https://relays.syncthing.net/endpoint"). Blank to disable announcement to
90
90
a pool, thereby remaining a private relay.
91
91
92
+ .. cmdoption :: -pprof
93
+
94
+ Enable the built in profiling on the status server
95
+
92
96
.. cmdoption :: -protocol=<string>
93
97
94
98
Protocol used for listening. 'tcp' for IPv4 and IPv6, 'tcp4' for IPv4, 'tcp6' for IPv6 (default "tcp").
@@ -102,6 +106,14 @@ Options
102
106
Listen address for status service (blank to disable) (default ":22070").
103
107
Status service is used by the relay pool server UI for displaying stats (data transferred, number of clients, etc.)
104
108
109
+ .. cmdoption :: -token=<string>
110
+
111
+ Token to restrict access to the relay (optional). Disables joining any pools.
112
+
113
+ .. cmdoption :: -version
114
+
115
+ Show version
116
+
105
117
Installing
106
118
~~~~~~~~~~
107
119
@@ -205,6 +217,20 @@ Runtime ``iptables`` rules to allow access to the default ports::
205
217
206
218
Please consult Linux distribution documentation to persist firewall rules.
207
219
220
+ Access control for private relays
221
+ ---------------------------------
222
+
223
+ .. versionadded :: 1.22.1
224
+
225
+ Private relays can be configured to only accept connections from peers in possession of a shared secret.
226
+ To configure this use the ``-token `` option:
227
+
228
+ $ strelaysrv -token=mySecretToken
229
+
230
+ Then configure your Syncthing devices to send the token when joining the relay::
231
+
232
+ relay://<host name|IP>[:port]/?id=<relay device ID>&token=mySecretToken
233
+
208
234
See Also
209
235
--------
210
236
0 commit comments