aboutsummaryrefslogtreecommitdiff
path: root/man
diff options
context:
space:
mode:
authorSyncthing Release Automation <release@syncthing.net>2023-09-04 03:45:39 +0000
committerSyncthing Release Automation <release@syncthing.net>2023-09-04 03:45:39 +0000
commit4138e22898c4b226a029dc6cc435496857b74def (patch)
tree7699cabafe11db2013ef1702e6102a4f7c7a18e3 /man
parentc42c0e7ceb67d4c35d41ad359014fe3542f532f5 (diff)
downloadsyncthing-4138e22898c4b226a029dc6cc435496857b74def.tar.gz
syncthing-4138e22898c4b226a029dc6cc435496857b74def.zip
gui, man, authors: Update docs, translations, and contributors
Diffstat (limited to 'man')
-rw-r--r--man/stdiscosrv.12
-rw-r--r--man/strelaysrv.144
-rw-r--r--man/syncthing-bep.72
-rw-r--r--man/syncthing-config.52
-rw-r--r--man/syncthing-device-ids.72
-rw-r--r--man/syncthing-event-api.72
-rw-r--r--man/syncthing-faq.72
-rw-r--r--man/syncthing-globaldisco.72
-rw-r--r--man/syncthing-localdisco.72
-rw-r--r--man/syncthing-networking.72
-rw-r--r--man/syncthing-relay.72
-rw-r--r--man/syncthing-rest-api.72
-rw-r--r--man/syncthing-security.72
-rw-r--r--man/syncthing-stignore.52
-rw-r--r--man/syncthing-versioning.72
-rw-r--r--man/syncthing.12
16 files changed, 55 insertions, 19 deletions
diff --git a/man/stdiscosrv.1 b/man/stdiscosrv.1
index a924b6fae..faf5a227f 100644
--- a/man/stdiscosrv.1
+++ b/man/stdiscosrv.1
@@ -27,7 +27,7 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
.in \\n[rst2man-indent\\n[rst2man-indent-level]]u
..
-.TH "STDISCOSRV" "1" "Aug 18, 2023" "v1.23.7" "Syncthing"
+.TH "STDISCOSRV" "1" "Sep 03, 2023" "v1.23.7" "Syncthing"
.SH NAME
stdiscosrv \- Syncthing Discovery Server
.SH SYNOPSIS
diff --git a/man/strelaysrv.1 b/man/strelaysrv.1
index 7de0d675c..605988e06 100644
--- a/man/strelaysrv.1
+++ b/man/strelaysrv.1
@@ -27,7 +27,7 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
.in \\n[rst2man-indent\\n[rst2man-indent-level]]u
..
-.TH "STRELAYSRV" "1" "Aug 18, 2023" "v1.23.7" "Syncthing"
+.TH "STRELAYSRV" "1" "Sep 03, 2023" "v1.23.7" "Syncthing"
.SH NAME
strelaysrv \- Syncthing Relay Server
.SH SYNOPSIS
@@ -37,10 +37,10 @@ strelaysrv \- Syncthing Relay Server
.nf
.ft C
strelaysrv [\-debug] [\-ext\-address=<address>] [\-global\-rate=<bytes/s>] [\-keys=<dir>] [\-listen=<listen addr>]
- [\-message\-timeout=<duration>] [\-nat] [\-nat\-lease=<duration> [\-nat\-renewal=<duration>]
+ [\-message\-timeout=<duration>] [\-nat] [\-nat\-lease=<duration>] [\-nat\-renewal=<duration>]
[\-nat\-timeout=<duration>] [\-network\-timeout=<duration>] [\-per\-session\-rate=<bytes/s>]
- [\-ping\-interval=<duration>] [\-pools=<pool addresses>] [\-protocol=<string>] [\-provided\-by=<string>]
- [\-status\-srv=<listen addr>]
+ [\-ping\-interval=<duration>] [\-pools=<pool addresses>] [\-pprof] [\-protocol=<string>]
+ [\-provided\-by=<string>] [\-status\-srv=<listen addr>] [\-token=<string>] [\-version]
.ft P
.fi
.UNINDENT
@@ -132,6 +132,11 @@ a pool, thereby remaining a private relay.
.UNINDENT
.INDENT 0.0
.TP
+.B \-pprof
+Enable the built in profiling on the status server
+.UNINDENT
+.INDENT 0.0
+.TP
.B \-protocol=<string>
Protocol used for listening. ‘tcp’ for IPv4 and IPv6, ‘tcp4’ for IPv4, ‘tcp6’ for IPv6 (default “tcp”).
.UNINDENT
@@ -146,6 +151,16 @@ An optional description about who provides the relay.
Listen address for status service (blank to disable) (default “:22070”).
Status service is used by the relay pool server UI for displaying stats (data transferred, number of clients, etc.)
.UNINDENT
+.INDENT 0.0
+.TP
+.B \-token=<string>
+Token to restrict access to the relay (optional). Disables joining any pools.
+.UNINDENT
+.INDENT 0.0
+.TP
+.B \-version
+Show version
+.UNINDENT
.SS Installing
.sp
Go to \fI\%releases\fP <\fBhttps://github.com/syncthing/relaysrv/releases\fP> and
@@ -290,6 +305,27 @@ iptables \-I INPUT \-p tcp \-\-dport 22070 \-j ACCEPT
.UNINDENT
.sp
Please consult Linux distribution documentation to persist firewall rules.
+.SH ACCESS CONTROL FOR PRIVATE RELAYS
+.sp
+New in version 1.22.1.
+
+.sp
+Private relays can be configured to only accept connections from peers in possession of a shared secret.
+To configure this use the \fB\-token\fP option:
+.sp
+$ strelaysrv \-token=mySecretToken
+.sp
+Then configure your Syncthing devices to send the token when joining the relay:
+.INDENT 0.0
+.INDENT 3.5
+.sp
+.nf
+.ft C
+relay://<host name|IP>[:port]/?id=<relay device ID>&token=mySecretToken
+.ft P
+.fi
+.UNINDENT
+.UNINDENT
.SH SEE ALSO
.sp
\fBsyncthing\-relay(7)\fP, \fBsyncthing\-faq(7)\fP,
diff --git a/man/syncthing-bep.7 b/man/syncthing-bep.7
index af9756517..900ee0bf0 100644
--- a/man/syncthing-bep.7
+++ b/man/syncthing-bep.7
@@ -27,7 +27,7 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
.in \\n[rst2man-indent\\n[rst2man-indent-level]]u
..
-.TH "SYNCTHING-BEP" "7" "Aug 18, 2023" "v1.23.7" "Syncthing"
+.TH "SYNCTHING-BEP" "7" "Sep 03, 2023" "v1.23.7" "Syncthing"
.SH NAME
syncthing-bep \- Block Exchange Protocol v1
.SH INTRODUCTION AND DEFINITIONS
diff --git a/man/syncthing-config.5 b/man/syncthing-config.5
index dec649ce0..881d4432d 100644
--- a/man/syncthing-config.5
+++ b/man/syncthing-config.5
@@ -27,7 +27,7 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
.in \\n[rst2man-indent\\n[rst2man-indent-level]]u
..
-.TH "SYNCTHING-CONFIG" "5" "Aug 18, 2023" "v1.23.7" "Syncthing"
+.TH "SYNCTHING-CONFIG" "5" "Sep 03, 2023" "v1.23.7" "Syncthing"
.SH NAME
syncthing-config \- Syncthing Configuration
.SH SYNOPSIS
diff --git a/man/syncthing-device-ids.7 b/man/syncthing-device-ids.7
index 9ed8c14e8..a9dfc47d2 100644
--- a/man/syncthing-device-ids.7
+++ b/man/syncthing-device-ids.7
@@ -27,7 +27,7 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
.in \\n[rst2man-indent\\n[rst2man-indent-level]]u
..
-.TH "SYNCTHING-DEVICE-IDS" "7" "Aug 18, 2023" "v1.23.7" "Syncthing"
+.TH "SYNCTHING-DEVICE-IDS" "7" "Sep 03, 2023" "v1.23.7" "Syncthing"
.SH NAME
syncthing-device-ids \- Understanding Device IDs
.sp
diff --git a/man/syncthing-event-api.7 b/man/syncthing-event-api.7
index 8de15e4ae..447248cc7 100644
--- a/man/syncthing-event-api.7
+++ b/man/syncthing-event-api.7
@@ -27,7 +27,7 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
.in \\n[rst2man-indent\\n[rst2man-indent-level]]u
..
-.TH "SYNCTHING-EVENT-API" "7" "Aug 18, 2023" "v1.23.7" "Syncthing"
+.TH "SYNCTHING-EVENT-API" "7" "Sep 03, 2023" "v1.23.7" "Syncthing"
.SH NAME
syncthing-event-api \- Event API
.SH DESCRIPTION
diff --git a/man/syncthing-faq.7 b/man/syncthing-faq.7
index 19b0af137..304b478bc 100644
--- a/man/syncthing-faq.7
+++ b/man/syncthing-faq.7
@@ -27,7 +27,7 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
.in \\n[rst2man-indent\\n[rst2man-indent-level]]u
..
-.TH "SYNCTHING-FAQ" "7" "Aug 18, 2023" "v1.23.7" "Syncthing"
+.TH "SYNCTHING-FAQ" "7" "Sep 03, 2023" "v1.23.7" "Syncthing"
.SH NAME
syncthing-faq \- Frequently Asked Questions
.INDENT 0.0
diff --git a/man/syncthing-globaldisco.7 b/man/syncthing-globaldisco.7
index 3d02d2f83..3f5253334 100644
--- a/man/syncthing-globaldisco.7
+++ b/man/syncthing-globaldisco.7
@@ -27,7 +27,7 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
.in \\n[rst2man-indent\\n[rst2man-indent-level]]u
..
-.TH "SYNCTHING-GLOBALDISCO" "7" "Aug 18, 2023" "v1.23.7" "Syncthing"
+.TH "SYNCTHING-GLOBALDISCO" "7" "Sep 03, 2023" "v1.23.7" "Syncthing"
.SH NAME
syncthing-globaldisco \- Global Discovery Protocol v3
.SH ANNOUNCEMENTS
diff --git a/man/syncthing-localdisco.7 b/man/syncthing-localdisco.7
index 76db71af7..036d8361e 100644
--- a/man/syncthing-localdisco.7
+++ b/man/syncthing-localdisco.7
@@ -27,7 +27,7 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
.in \\n[rst2man-indent\\n[rst2man-indent-level]]u
..
-.TH "SYNCTHING-LOCALDISCO" "7" "Aug 18, 2023" "v1.23.7" "Syncthing"
+.TH "SYNCTHING-LOCALDISCO" "7" "Sep 03, 2023" "v1.23.7" "Syncthing"
.SH NAME
syncthing-localdisco \- Local Discovery Protocol v4
.SH MODE OF OPERATION
diff --git a/man/syncthing-networking.7 b/man/syncthing-networking.7
index ac96e7862..b0d2fecf4 100644
--- a/man/syncthing-networking.7
+++ b/man/syncthing-networking.7
@@ -27,7 +27,7 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
.in \\n[rst2man-indent\\n[rst2man-indent-level]]u
..
-.TH "SYNCTHING-NETWORKING" "7" "Aug 18, 2023" "v1.23.7" "Syncthing"
+.TH "SYNCTHING-NETWORKING" "7" "Sep 03, 2023" "v1.23.7" "Syncthing"
.SH NAME
syncthing-networking \- Firewall Setup
.SH ROUTER SETUP
diff --git a/man/syncthing-relay.7 b/man/syncthing-relay.7
index 191b7f250..7966a62d8 100644
--- a/man/syncthing-relay.7
+++ b/man/syncthing-relay.7
@@ -27,7 +27,7 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
.in \\n[rst2man-indent\\n[rst2man-indent-level]]u
..
-.TH "SYNCTHING-RELAY" "7" "Aug 18, 2023" "v1.23.7" "Syncthing"
+.TH "SYNCTHING-RELAY" "7" "Sep 03, 2023" "v1.23.7" "Syncthing"
.SH NAME
syncthing-relay \- Relay Protocol v1
.SH WHAT IS A RELAY?
diff --git a/man/syncthing-rest-api.7 b/man/syncthing-rest-api.7
index 808d167a6..ee10d34fe 100644
--- a/man/syncthing-rest-api.7
+++ b/man/syncthing-rest-api.7
@@ -27,7 +27,7 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
.in \\n[rst2man-indent\\n[rst2man-indent-level]]u
..
-.TH "SYNCTHING-REST-API" "7" "Aug 18, 2023" "v1.23.7" "Syncthing"
+.TH "SYNCTHING-REST-API" "7" "Sep 03, 2023" "v1.23.7" "Syncthing"
.SH NAME
syncthing-rest-api \- REST API
.sp
diff --git a/man/syncthing-security.7 b/man/syncthing-security.7
index 343c6dd87..a8adaa352 100644
--- a/man/syncthing-security.7
+++ b/man/syncthing-security.7
@@ -27,7 +27,7 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
.in \\n[rst2man-indent\\n[rst2man-indent-level]]u
..
-.TH "SYNCTHING-SECURITY" "7" "Aug 18, 2023" "v1.23.7" "Syncthing"
+.TH "SYNCTHING-SECURITY" "7" "Sep 03, 2023" "v1.23.7" "Syncthing"
.SH NAME
syncthing-security \- Security Principles
.sp
diff --git a/man/syncthing-stignore.5 b/man/syncthing-stignore.5
index c136422bb..f38dff371 100644
--- a/man/syncthing-stignore.5
+++ b/man/syncthing-stignore.5
@@ -27,7 +27,7 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
.in \\n[rst2man-indent\\n[rst2man-indent-level]]u
..
-.TH "SYNCTHING-STIGNORE" "5" "Aug 18, 2023" "v1.23.7" "Syncthing"
+.TH "SYNCTHING-STIGNORE" "5" "Sep 03, 2023" "v1.23.7" "Syncthing"
.SH NAME
syncthing-stignore \- Prevent files from being synchronized to other nodes
.SH SYNOPSIS
diff --git a/man/syncthing-versioning.7 b/man/syncthing-versioning.7
index 397322a24..deecf1b38 100644
--- a/man/syncthing-versioning.7
+++ b/man/syncthing-versioning.7
@@ -27,7 +27,7 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
.in \\n[rst2man-indent\\n[rst2man-indent-level]]u
..
-.TH "SYNCTHING-VERSIONING" "7" "Aug 18, 2023" "v1.23.7" "Syncthing"
+.TH "SYNCTHING-VERSIONING" "7" "Sep 03, 2023" "v1.23.7" "Syncthing"
.SH NAME
syncthing-versioning \- Keep automatic backups of deleted files by other nodes
.sp
diff --git a/man/syncthing.1 b/man/syncthing.1
index 3c51814b1..730585ce2 100644
--- a/man/syncthing.1
+++ b/man/syncthing.1
@@ -27,7 +27,7 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
.in \\n[rst2man-indent\\n[rst2man-indent-level]]u
..
-.TH "SYNCTHING" "1" "Aug 18, 2023" "v1.23.7" "Syncthing"
+.TH "SYNCTHING" "1" "Sep 03, 2023" "v1.23.7" "Syncthing"
.SH NAME
syncthing \- Syncthing
.SH SYNOPSIS