felixfoertsch/syncthing
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases 10 Wiki Activity

gui, man, authors: Update docs, translations, and contributors

Browse Source
This commit is contained in:
Jakob Borg
2020-05-20 07:45:28 +02:00
parent 5b34c31cb3
commit 77dd874383
18 changed files with 83 additions and 33 deletions
Download Patch File Download Diff File Expand all files Collapse all files
man/stdiscosrv.1
+56 -7
View File
@@ -1,6 +1,6 @@
.\" Man page generated from reStructuredText.
.
.TH "STDISCOSRV" "1" "May 12, 2020" "v1" "Syncthing"
.TH "STDISCOSRV" "1" "May 16, 2020" "v1" "Syncthing"
.SH NAME
stdiscosrv \- Syncthing Discovery Server
.
@@ -286,18 +286,30 @@ Use of a subdomain name without requiring a port number added to the URL
.IP \(bu 2
Sharing an SSL certificate with multiple services on the same server
.UNINDENT
.sp
Note that after this configuration, if the proxy uses a valid HTTPS
certificate, \fBclients should omit the\fP \fB?id=...\fP \fBparameter from the
discovery server URL on their configuration\fP\&. Client\-side validation will be
done by checking the visible proxy server’s HTTPS certificate. If, however, the
proxy uses a self\-signed or somehow invalid certificate, clients must still set
the \fB?id=...\fP parameter with the computed hash of the proxy’s
certificate. Using such setup is discouraged and is not covered in this page.
Always favour using valid and widely recognised certificates.
.SS Requirements
.INDENT 0.0
.IP \(bu 2
Run the discovery server using the \-http flag \fBstdiscosrv \-http\fP\&.
Run the discovery server using the \-http flag: \fBstdiscosrv \-http\fP\&.
.IP \(bu 2
SSL certificate/key configured for the reverse proxy
SSL certificate/key configured for the reverse proxy.
.IP \(bu 2
The “X\-Forwarded\-For” http header must be passed through with the client’s
real IP address
The “X\-Forwarded\-For” HTTP header must be passed through with the client’s
real IP address.
.IP \(bu 2
The “X\-SSL\-Cert” must be passed through with the PEM\-encoded client SSL
certificate
The “X\-SSL\-Cert” HTTP header must be passed through with the PEM\-encoded
client SSL certificate. This will be present in POST requests and may be empty
in GET requests from clients. If you see syncthing\-discosrv outputting
\fBno certificates\fP when receiving POST requests, that’s because the proxy
is not passing this header through.
.IP \(bu 2
The proxy must request the client SSL certificate but not require it to be
signed by a trusted CA.
@@ -372,6 +384,43 @@ server {
.sp
An example of automating the SSL certificates and reverse\-proxying the Discovery
Server and Syncthing using Nginx, \fI\%Let’s Encrypt\fP <\fBhttps://letsencrypt.org/\fP> and Docker can be found \fI\%here\fP <\fBhttps://forum.syncthing.net/t/docker-syncthing-and-syncthing-discovery-behind-nginx-reverse-proxy-with-lets-encrypt/6880\fP>\&.
.SS Apache
.sp
The following lines must be added to the configuration:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
SSLProxyEngine On
SSLVerifyClient optional_no_ca
RequestHeader set X\-SSL\-Cert "%{SSL_CLIENT_CERT}s"
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
The following was observed to not be required at least under
Apache httpd 2.4.38, as the proxy module adds the needed header by default.
If you need to explicitly add the following directive, make sure to issue
\fBa2enmod remoteip\fP first. Then, add the following to your Apache httpd
configuration:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
RemoteIPHeader X\-Forwarded\-For
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
For more details, see also the recommendations in the
\fI\%Reverse Proxy Setup\fP <\fBhttps://docs.syncthing.net/users/reverseproxy.html\fP>
page. Note that that page is directed at setting up a proxy for the
Syncthing web UI. You should do the proper path and port adjustments to proxying
the discovery server and your particular setup.
.SH SEE ALSO
.sp
\fBsyncthing\-networking(7)\fP, \fBsyncthing\-faq(7)\fP
man/strelaysrv.1
+1 -1
View File
@@ -1,6 +1,6 @@
.\" Man page generated from reStructuredText.
.
.TH "STRELAYSRV" "1" "May 12, 2020" "v1" "Syncthing"
.TH "STRELAYSRV" "1" "May 16, 2020" "v1" "Syncthing"
.SH NAME
strelaysrv \- Syncthing Relay Server
.
man/syncthing-bep.7
+1 -1
View File
@@ -1,6 +1,6 @@
.\" Man page generated from reStructuredText.
.
.TH "SYNCTHING-BEP" "7" "May 12, 2020" "v1" "Syncthing"
.TH "SYNCTHING-BEP" "7" "May 16, 2020" "v1" "Syncthing"
.SH NAME
syncthing-bep \- Block Exchange Protocol v1
.
man/syncthing-config.5
+1 -1
View File
@@ -1,6 +1,6 @@
.\" Man page generated from reStructuredText.
.
.TH "SYNCTHING-CONFIG" "5" "May 12, 2020" "v1" "Syncthing"
.TH "SYNCTHING-CONFIG" "5" "May 16, 2020" "v1" "Syncthing"
.SH NAME
syncthing-config \- Syncthing Configuration
.
man/syncthing-device-ids.7
+1 -1
View File
@@ -1,6 +1,6 @@
.\" Man page generated from reStructuredText.
.
.TH "SYNCTHING-DEVICE-IDS" "7" "May 12, 2020" "v1" "Syncthing"
.TH "SYNCTHING-DEVICE-IDS" "7" "May 16, 2020" "v1" "Syncthing"
.SH NAME
syncthing-device-ids \- Understanding Device IDs
.
man/syncthing-event-api.7
+1 -1
View File
@@ -1,6 +1,6 @@
.\" Man page generated from reStructuredText.
.
.TH "SYNCTHING-EVENT-API" "7" "May 12, 2020" "v1" "Syncthing"
.TH "SYNCTHING-EVENT-API" "7" "May 16, 2020" "v1" "Syncthing"
.SH NAME
syncthing-event-api \- Event API
.
man/syncthing-faq.7
+11 -11
View File
@@ -1,6 +1,6 @@
.\" Man page generated from reStructuredText.
.
.TH "SYNCTHING-FAQ" "7" "May 12, 2020" "v1" "Syncthing"
.TH "SYNCTHING-FAQ" "7" "May 16, 2020" "v1" "Syncthing"
.SH NAME
syncthing-faq \- Frequently Asked Questions
.
@@ -64,34 +64,34 @@ Sync uses an undocumented, closed protocol with unknown security properties.
The following things are \fIalways\fP synchronized:
.INDENT 0.0
.IP \(bu 2
File Contents
File contents
.IP \(bu 2
File Modification Times
File modification times
.UNINDENT
.sp
The following may be synchronized or not, depending:
.INDENT 0.0
.IP \(bu 2
File Permissions (When supported by file system. On Windows, only the
read only bit is synchronized.)
File permissions (when supported by file system; on Windows only the
read only bit is synchronized)
.IP \(bu 2
Symbolic Links (synced, except on Windows, but never followed.)
Symbolic links (synced, except on Windows, but never followed)
.UNINDENT
.sp
The following are \fInot\fP synchronized;
.INDENT 0.0
.IP \(bu 2
File or Directory Owners and Groups (not preserved)
File or directory owners and Groups (not preserved)
.IP \(bu 2
Directory Modification Times (not preserved)
Directory modification times (not preserved)
.IP \(bu 2
Hard Links (followed, not preserved)
Hard links and Windows directory junctions (followed, not preserved)
.IP \(bu 2
Extended Attributes, Resource Forks (not preserved)
Extended attributes, resource forks (not preserved)
.IP \(bu 2
Windows, POSIX or NFS ACLs (not preserved)
.IP \(bu 2
Devices, FIFOs, and Other Specials (ignored)
Devices, FIFOs, and other specials (ignored)
.IP \(bu 2
Sparse file sparseness (will become sparse, when supported by the OS & filesystem)
.UNINDENT
man/syncthing-globaldisco.7
+1 -1
View File
@@ -1,6 +1,6 @@
.\" Man page generated from reStructuredText.
.
.TH "SYNCTHING-GLOBALDISCO" "7" "May 12, 2020" "v1" "Syncthing"
.TH "SYNCTHING-GLOBALDISCO" "7" "May 16, 2020" "v1" "Syncthing"
.SH NAME
syncthing-globaldisco \- Global Discovery Protocol v3
.
man/syncthing-localdisco.7
+1 -1
View File
@@ -1,6 +1,6 @@
.\" Man page generated from reStructuredText.
.
.TH "SYNCTHING-LOCALDISCO" "7" "May 12, 2020" "v1" "Syncthing"
.TH "SYNCTHING-LOCALDISCO" "7" "May 16, 2020" "v1" "Syncthing"
.SH NAME
syncthing-localdisco \- Local Discovery Protocol v4
.
man/syncthing-networking.7
+1 -1
View File
@@ -1,6 +1,6 @@
.\" Man page generated from reStructuredText.
.
.TH "SYNCTHING-NETWORKING" "7" "May 12, 2020" "v1" "Syncthing"
.TH "SYNCTHING-NETWORKING" "7" "May 16, 2020" "v1" "Syncthing"
.SH NAME
syncthing-networking \- Firewall Setup
.
man/syncthing-relay.7
+1 -1
View File
@@ -1,6 +1,6 @@
.\" Man page generated from reStructuredText.
.
.TH "SYNCTHING-RELAY" "7" "May 12, 2020" "v1" "Syncthing"
.TH "SYNCTHING-RELAY" "7" "May 16, 2020" "v1" "Syncthing"
.SH NAME
syncthing-relay \- Relay Protocol v1
.
man/syncthing-rest-api.7
+1 -1
View File
@@ -1,6 +1,6 @@
.\" Man page generated from reStructuredText.
.
.TH "SYNCTHING-REST-API" "7" "May 12, 2020" "v1" "Syncthing"
.TH "SYNCTHING-REST-API" "7" "May 16, 2020" "v1" "Syncthing"
.SH NAME
syncthing-rest-api \- REST API
.
man/syncthing-security.7
+1 -1
View File
@@ -1,6 +1,6 @@
.\" Man page generated from reStructuredText.
.
.TH "SYNCTHING-SECURITY" "7" "May 12, 2020" "v1" "Syncthing"
.TH "SYNCTHING-SECURITY" "7" "May 16, 2020" "v1" "Syncthing"
.SH NAME
syncthing-security \- Security Principles
.
man/syncthing-stignore.5
+1 -1
View File
@@ -1,6 +1,6 @@
.\" Man page generated from reStructuredText.
.
.TH "SYNCTHING-STIGNORE" "5" "May 12, 2020" "v1" "Syncthing"
.TH "SYNCTHING-STIGNORE" "5" "May 16, 2020" "v1" "Syncthing"
.SH NAME
syncthing-stignore \- Prevent files from being synchronized to other nodes
.
man/syncthing-versioning.7
+1 -1
View File
@@ -1,6 +1,6 @@
.\" Man page generated from reStructuredText.
.
.TH "SYNCTHING-VERSIONING" "7" "May 12, 2020" "v1" "Syncthing"
.TH "SYNCTHING-VERSIONING" "7" "May 16, 2020" "v1" "Syncthing"
.SH NAME
syncthing-versioning \- Keep automatic backups of deleted files by other nodes
.
man/syncthing.1
+1 -1
View File
@@ -1,6 +1,6 @@
.\" Man page generated from reStructuredText.
.
.TH "SYNCTHING" "1" "May 12, 2020" "v1" "Syncthing"
.TH "SYNCTHING" "1" "May 16, 2020" "v1" "Syncthing"
.SH NAME
syncthing \- Syncthing
.