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

This commit is contained in:
Syncthing Release Automation
2023-09-18 03:45:31 +00:00
parent c9dfd75d8e
commit 58d1f3a471
29 changed files with 1292 additions and 1230 deletions
+22 -22
View File
@@ -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" "Sep 07, 2023" "v1.24.0" "Syncthing"
.TH "SYNCTHING-FAQ" "7" "Sep 17, 2023" "v1.24.0" "Syncthing"
.SH NAME
syncthing-faq \- Frequently Asked Questions
.INDENT 0.0
@@ -164,7 +164,7 @@ Directory modification times (not preserved)
Hard links (followed, not preserved)
.IP \(bu 2
Windows junctions (synced as ordinary directories; require enabling in
\fBthe configuration\fP on a per\-folder
\fI\%the configuration\fP on a per\-folder
basis)
.IP \(bu 2
Resource forks (not preserved)
@@ -176,7 +176,7 @@ Devices, FIFOs, and other specials (ignored)
Sparse file sparseness (will become sparse, when supported by the OS & filesystem)
.IP \(bu 2
Syncthing internal files and folders (e.g. \fB\&.stfolder\fP, \fB\&.stignore\fP,
\fB\&.stversions\fP, temporary files, etc.)
\fB\&.stversions\fP, \fI\%temporary files\fP, etc.)
.UNINDENT
.SS Is synchronization fast?
.sp
@@ -191,7 +191,7 @@ manner. This means that renaming a file will not cause a retransmission of
that file. Additionally, appending data to existing files should be handled
efficiently as well.
.sp
Temporary files are used to store partial data
\fI\%Temporary files\fP are used to store partial data
downloaded from other devices. They are automatically removed whenever a file
transfer has been completed or after the configured amount of time which is set
in the configuration file (24 hours by default).
@@ -236,7 +236,7 @@ oyster!)
\fBSEE ALSO:\fP
.INDENT 0.0
.INDENT 3.5
device\-ids
\fI\%Understanding Device IDs\fP
.UNINDENT
.UNINDENT
.SH TROUBLESHOOTING
@@ -262,7 +262,7 @@ Devices” list on the right side of the GUI, double check that you see
.sp
If you are connected via a relay, this is because a direct connection could
not be established. Double check and follow the suggestions in
firewall\-setup to enable direct connections.
\fI\%Firewall Setup\fP to enable direct connections.
.sp
Second, if one of the devices is a very low powered machine (a Raspberry Pi,
or a phone, or a NAS, or similar) you are likely constrained by the CPU on
@@ -295,7 +295,7 @@ causes a certain amount of extra CPU usage to calculate the summary data it
presents. Note however that once things are \fIin sync\fP CPU usage should be
negligible.
.sp
To minimize the impact of this, Syncthing attempts to \fBlower the
To minimize the impact of this, Syncthing attempts to \fI\%lower the
process priority\fP when starting up.
.sp
To further limit the amount of CPU used when syncing and scanning, set the
@@ -328,7 +328,7 @@ protect against unauthorized access. Either:
.IP \(bu 2
Make sure the proxy sets a \fBHost\fP header containing \fBlocalhost\fP, or
.IP \(bu 2
Set \fBgui.insecureSkipHostcheck\fP in the advanced settings, or
Set \fI\%gui.insecureSkipHostcheck\fP in the advanced settings, or
.IP \(bu 2
Bind the GUI/API to a non\-localhost listen port.
.UNINDENT
@@ -338,8 +338,8 @@ In all cases, username/password authentication and HTTPS should be used.
.sp
This is almost always a result of bad RAM, storage device or other hardware.
When the index database is found to be corrupt Syncthing cannot operate and will
note this in the logs and exit. To overcome this delete the database
folder inside Syncthings data directory and re\-start
note this in the logs and exit. To overcome this delete the \fI\%database
folder\fP inside Syncthings data directory and re\-start
Syncthing. It will then need to perform a full re\-hashing of all shared
folders. You should check your system in case the underlying cause is indeed
faulty hardware which may put the system at risk of further data loss.
@@ -374,7 +374,7 @@ up\-to\-date state with all the neighbours.
.SS Why does Syncthing connect to this unknown/suspicious address?
.sp
If you see outgoing connections to odd and unexpected addresses these are
most likely connections to relay servers\&. Relay servers
most likely connections to \fI\%relay servers\fP\&. Relay servers
are run by volunteers all over the world. They usually listen on ports 443 or
22067, though this is controlled by the user running it. You can compare the
address you are concerned about with \fI\%the current list of active relays\fP <\fBhttps://relays.syncthing.net\fP>\&. Relays do not and can not see the data
@@ -420,7 +420,7 @@ Also see the \fI\%marker FAQ\fP for more information about the folder marker.
\fBSEE ALSO:\fP
.INDENT 0.0
.INDENT 3.5
conflict\-handling
\fI\%Conflicting Changes\fP
.UNINDENT
.UNINDENT
.SS How do I serve a folder from a read only filesystem?
@@ -459,11 +459,11 @@ locally may be overwritten by those on other devices.
.sp
An alternative way is to shut down Syncthing, move the folder on disk (including
the \fB\&.stfolder\fP marker), edit the path directly in \fBconfig.xml\fP in the
configuration folder (see /users/config) and then start Syncthing again.
configuration folder (see \fI\%Syncthing Configuration\fP) and then start Syncthing again.
.SS How do I configure multiple users on a single machine?
.sp
Each user should run their own Syncthing instance. Be aware that you might need
to configure listening ports such that they do not overlap (see /users/config).
to configure listening ports such that they do not overlap (see \fI\%Syncthing Configuration\fP).
.SS Does Syncthing support syncing between folders on the same system?
.sp
No. Syncthing is not designed to sync locally and the overhead involved in
@@ -529,7 +529,7 @@ UI from \fB127.0.0.1:8384\fP to
.sp
.nf
.ft C
<gui enabled="true" tls="false">
<gui enabled=\(dqtrue\(dq tls=\(dqfalse\(dq>
<address>127.0.0.1:8384</address>
.ft P
.fi
@@ -542,7 +542,7 @@ to
.sp
.nf
.ft C
<gui enabled="true" tls="false">
<gui enabled=\(dqtrue\(dq tls=\(dqfalse\(dq>
<address>0.0.0.0:8384</address>
.ft P
.fi
@@ -668,7 +668,7 @@ On many Linux distributions you can run the following to fix it:
.sp
.nf
.ft C
echo "fs.inotify.max_user_watches=204800" | sudo tee \-a /etc/sysctl.conf
echo \(dqfs.inotify.max_user_watches=204800\(dq | sudo tee \-a /etc/sysctl.conf
.ft P
.fi
.UNINDENT
@@ -681,7 +681,7 @@ separate file, i.e. you should run:
.sp
.nf
.ft C
echo "fs.inotify.max_user_watches=204800" | sudo tee \-a /etc/sysctl.d/90\-override.conf
echo \(dqfs.inotify.max_user_watches=204800\(dq | sudo tee \-a /etc/sysctl.d/90\-override.conf
.ft P
.fi
.UNINDENT
@@ -701,7 +701,7 @@ echo 204800 | sudo tee /proc/sys/fs/inotify/max_user_watches
.SS How do I reset the GUI password?
.sp
If youve forgotten / lost the GUI password, you can reset it using the
\fB\-\-gui\-password\fP (and possibly \fB\-\-gui\-user\fP) options to the
\fI\%\-\-gui\-password\fP (and possibly \fI\%\-\-gui\-user\fP) options to the
\fBsyncthing generate\fP subcommand. This should be done while Syncthing is not
running.
.INDENT 0.0
@@ -713,9 +713,9 @@ Stop Syncthing: \fBsyncthing cli operations shutdown\fP
Restart Syncthing as usual.
.UNINDENT
.sp
\fIAlternatively, in step 2\fP, you can manually delete the \fB<user>\fP and \fB<password>\fP XML tags from the
\fIAlternatively, in step 2\fP, you can manually delete the \fI\%<user>\fP and \fI\%<password>\fP XML tags from the
\fB<gui>\fP block in file \fBconfig.xml\fP\&. The location of the file depends on the
OS and is described in the configuration documentation\&.
OS and is described in the \fI\%configuration documentation\fP\&.
.sp
For example, the two emphasized lines below would be removed from the file.
.INDENT 0.0
@@ -723,7 +723,7 @@ For example, the two emphasized lines below would be removed from the file.
.sp
.nf
.ft C
<gui enabled="true" tls="false" debugging="false">
<gui enabled=\(dqtrue\(dq tls=\(dqfalse\(dq debugging=\(dqfalse\(dq>
<address>127.0.0.1:8384</address>
<user>syncguy</user>
<password>$2a$10$s9wWHOQe...Cq7GPye69</password>