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:
Syncthing Release Automation
2024-05-13 03:45:18 +00:00
parent f6df8b40b4
commit 06914b872b
20 changed files with 1082 additions and 881 deletions
Download Patch File Download Diff File Expand all files Collapse all files
man/syncthing-faq.7
+44 -60
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" "Apr 11, 2024" "v1.27.5" "Syncthing"
.TH "SYNCTHING-FAQ" "7" "May 08, 2024" "v1.27.7" "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
\fI\%the configuration\fP on a per\-folder
\X'tty: link #config-option-folder.junctionsasdirs'\fI\%the configuration\fP\X'tty: link' 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, \fI\%temporary files\fP, etc.)
\fB\&.stversions\fP, \X'tty: link #temporary-files'\fI\%temporary files\fP\X'tty: link', 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
\fI\%Temporary files\fP are used to store partial data
\X'tty: link #temporary-files'\fI\%Temporary files\fP\X'tty: link' 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).
@@ -209,7 +209,7 @@ Syncthing uses an open and documented protocol, and likewise the security
mechanisms in use are well defined and visible in the source code. Resilio
Sync uses an undocumented, closed protocol with unknown security properties.
.IP [1] 5
\fI\%https://en.wikipedia.org/wiki/Resilio_Sync\fP
\X'tty: link https://en.wikipedia.org/wiki/Resilio_Sync'\fI\%https://en.wikipedia.org/wiki/Resilio_Sync\fP\X'tty: link'
.SS Is there an iOS client?
.sp
There are no plans by the current Syncthing team to officially support iOS in the foreseeable future.
@@ -219,7 +219,7 @@ run Syncthing reliably and integrate it into the system.
.sp
However, there is a commercial packaging of Syncthing for iOS that attempts to work within these limitations. [2]
.IP [2] 5
\fI\%https://www.mobiussync.com\fP
\X'tty: link https://www.mobiussync.com'\fI\%https://www.mobiussync.com\fP\X'tty: link'
.SS Should I keep my device IDs secret?
.sp
No. The IDs are not sensitive. Given a device ID it’s possible to find the IP
@@ -236,7 +236,7 @@ oyster!)
\fBSEE ALSO:\fP
.INDENT 0.0
.INDENT 3.5
\fI\%Understanding Device IDs\fP
\X'tty: link #device-ids'\fI\%Understanding Device IDs\fP\X'tty: link'
.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
\fI\%Firewall Setup\fP to enable direct connections.
\X'tty: link #firewall-setup'\fI\%Firewall Setup\fP\X'tty: link' 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,8 +295,8 @@ 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 \fI\%lower the
process priority\fP when starting up.
To minimize the impact of this, Syncthing attempts to \X'tty: link #config-option-options.setlowpriority'\fI\%lower the
process priority\fP\X'tty: link' when starting up.
.sp
To further limit the amount of CPU used when syncing and scanning, set the
environment variable \fBGOMAXPROCS\fP to the maximum number of CPU cores
@@ -315,7 +315,7 @@ This is an area that we are working to improve in the long term.
.sp
Since version 0.14.6 Syncthing does an extra security check when the GUI/API
is bound to localhost \- namely that the browser is talking to localhost.
This protects against most forms of \fI\%DNS rebinding attack\fP <\fBhttps://en.wikipedia.org/wiki/DNS_rebinding\fP> against the GUI.
This protects against most forms of \X'tty: link https://en.wikipedia.org/wiki/DNS_rebinding'\fI\%DNS rebinding attack\fP <\fBhttps://en.wikipedia.org/wiki/DNS_rebinding\fP>\X'tty: link' against the GUI.
.sp
To pass this test, ensure that you are accessing the GUI using an URL that
begins with \fBhttp://localhost\fP, \fBhttp://127.0.0.1\fP or \fBhttp://[::1]\fP\&. HTTPS
@@ -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 \fI\%gui.insecureSkipHostcheck\fP in the advanced settings, or
Set \X'tty: link #config-option-gui.insecureskiphostcheck'\fI\%gui.insecureSkipHostcheck\fP\X'tty: link' 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 \fI\%database
folder\fP inside Syncthing’s data directory and re\-start
note this in the logs and exit. To overcome this delete the \X'tty: link #config-locations'\fI\%database
folder\fP\X'tty: link' inside Syncthing’s 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,10 +374,10 @@ 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 \fI\%relay servers\fP\&. Relay servers
most likely connections to \X'tty: link #relaying'\fI\%relay servers\fP\X'tty: link'\&. 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
address you are concerned about with \X'tty: link https://relays.syncthing.net'\fI\%the current list of active relays\fP <\fBhttps://relays.syncthing.net\fP>\X'tty: link'\&. Relays do not and can not see the data
transmitted via them.
.SS I am seeing the error message “folder marker missing”. What do I do?
.sp
@@ -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
\fI\%Conflicting Changes\fP
\X'tty: link #conflict-handling'\fI\%Conflicting Changes\fP\X'tty: link'
.UNINDENT
.UNINDENT
.SS How do I serve a folder from a read only filesystem?
@@ -468,8 +468,8 @@ to configure listening ports such that they do not overlap (see \fI\%Syncthing C
.sp
No. Syncthing is not designed to sync locally and the overhead involved in
doing so using Syncthing’s method would be wasteful. There are better
programs to achieve this such as \fI\%rsync\fP <\fBhttps://rsync.samba.org/\fP> or
\fI\%Unison\fP <\fBhttps://www.cis.upenn.edu/~bcpierce/unison\fP>\&.
programs to achieve this such as \X'tty: link https://rsync.samba.org/'\fI\%rsync\fP <\fBhttps://rsync.samba.org/\fP>\X'tty: link' or
\X'tty: link https://www.cis.upenn.edu/~bcpierce/unison'\fI\%Unison\fP <\fBhttps://www.cis.upenn.edu/~bcpierce/unison\fP>\X'tty: link'\&.
.SS When I do have two distinct Syncthing\-managed folders on two hosts, how does Syncthing handle moving files between them?
.sp
Syncthing does not specially handle this case, and most files will most likely get
@@ -526,12 +526,10 @@ computer, change the \fBGUI listen address\fP option in the web GUI from
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
.EX
<gui enabled=\(dqtrue\(dq tls=\(dqfalse\(dq>
<address>127.0.0.1:8384</address>
.ft P
.fi
.EE
.UNINDENT
.UNINDENT
.sp
@@ -539,12 +537,10 @@ to
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
.EX
<gui enabled=\(dqtrue\(dq tls=\(dqtrue\(dq>
<address>0.0.0.0:8384</address>
.ft P
.fi
.EE
.UNINDENT
.UNINDENT
.sp
@@ -557,33 +553,29 @@ GUI settings at default and use an SSH port forward to access it. For example,
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
.EX
$ ssh \-L 9090:127.0.0.1:8384 user@othercomputer.example.com
.ft P
.fi
.EE
.UNINDENT
.UNINDENT
.sp
will log you into \fBothercomputer.example.com\fP, and present the \fIremote\fP
Syncthing GUI on \fI\%http://localhost:9090\fP on your \fIlocal\fP computer.
Syncthing GUI on \X'tty: link http://localhost:9090'\fI\%http://localhost:9090\fP\X'tty: link' on your \fIlocal\fP computer.
.sp
If you only want to access the remote GUI and don’t want the terminal session,
use this example:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
.EX
$ ssh \-N \-L 9090:127.0.0.1:8384 user@othercomputer.example.com
.ft P
.fi
.EE
.UNINDENT
.UNINDENT
.sp
If only your remote computer is Unix\-like, you can still access it with SSH from
Windows. Under Windows 10 or later you can use the same \fBssh\fP command if you
\fI\%install the OpenSSH Client\fP <\fBhttps://learn.microsoft.com/windows-server/administration/openssh/openssh_install_firstuse\fP>\&.
\X'tty: link https://learn.microsoft.com/windows-server/administration/openssh/openssh_install_firstuse'\fI\%install the OpenSSH Client\fP <\fBhttps://learn.microsoft.com/windows-server/administration/openssh/openssh_install_firstuse\fP>\X'tty: link'\&.
.SS I don’t like the GUI or the theme. Can it be changed?
.sp
You can change the theme in the settings. Syncthing ships with other themes
@@ -601,7 +593,7 @@ To add e.g. a red theme, you can create the file \fBred/assets/css/theme.css\fP
inside the GUI override directory to override the default CSS styles.
.sp
To create a whole new GUI, you should checkout the files at
\fI\%https://github.com/syncthing/syncthing/tree/main/gui/default\fP
\X'tty: link https://github.com/syncthing/syncthing/tree/main/gui/default'\fI\%https://github.com/syncthing/syncthing/tree/main/gui/default\fP\X'tty: link'
to get an idea how to do that.
.SS How do I upgrade Syncthing?
.sp
@@ -626,13 +618,13 @@ so should Syncthing.
.SS Where do I find the latest release?
.sp
We release new versions through GitHub. The latest release is always found
\fI\%on the release page\fP <\fBhttps://github.com/syncthing/syncthing/releases/latest\fP>\&. Unfortunately
\X'tty: link https://github.com/syncthing/syncthing/releases/latest'\fI\%on the release page\fP <\fBhttps://github.com/syncthing/syncthing/releases/latest\fP>\X'tty: link'\&. Unfortunately
GitHub does not provide a single URL to automatically download the latest
version. We suggest to use the \fI\%GitHub API\fP <\fBhttps://api.github.com/repos/syncthing/syncthing/releases/latest\fP> and parsing
version. We suggest to use the \X'tty: link https://api.github.com/repos/syncthing/syncthing/releases/latest'\fI\%GitHub API\fP <\fBhttps://api.github.com/repos/syncthing/syncthing/releases/latest\fP>\X'tty: link' and parsing
the JSON response.
.SS How do I run Syncthing as a daemon process on Linux?
.sp
If you’re using systemd, runit, or upstart, we ship \fI\%example configurations\fP <\fBhttps://github.com/syncthing/syncthing/tree/main/etc\fP>\&.
If you’re using systemd, runit, or upstart, we ship \X'tty: link https://github.com/syncthing/syncthing/tree/main/etc'\fI\%example configurations\fP <\fBhttps://github.com/syncthing/syncthing/tree/main/etc\fP>\X'tty: link'\&.
.sp
If however you’re not using one of these tools, you have a couple of options.
If your system has a tool called \fBstart\-stop\-daemon\fP installed (that’s the name
@@ -650,7 +642,7 @@ the filesystem watcher on linux:
.INDENT 0.0
.INDENT 3.5
Failed to start filesystem watcher for folder yourLabel (yourID): failed to
setup inotify handler. Please increase inotify limits, see \fI\%https://docs.syncthing.net/users/faq.html#inotify\-limits\fP
setup inotify handler. Please increase inotify limits, see \X'tty: link https://docs.syncthing.net/users/faq.html#inotify-limits'\fI\%https://docs.syncthing.net/users/faq.html#inotify\-limits\fP\X'tty: link'
.UNINDENT
.UNINDENT
.sp
@@ -661,11 +653,9 @@ On many Linux distributions you can run the following to fix it:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
.EX
echo \(dqfs.inotify.max_user_watches=204800\(dq | sudo tee \-a /etc/sysctl.conf
.ft P
.fi
.EE
.UNINDENT
.UNINDENT
.sp
@@ -674,11 +664,9 @@ separate file, i.e. you should run:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
.EX
echo \(dqfs.inotify.max_user_watches=204800\(dq | sudo tee \-a /etc/sysctl.d/90\-override.conf
.ft P
.fi
.EE
.UNINDENT
.UNINDENT
.sp
@@ -686,17 +674,15 @@ This only takes effect after a reboot. To adjust the limit immediately, run:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
.EX
echo 204800 | sudo tee /proc/sys/fs/inotify/max_user_watches
.ft P
.fi
.EE
.UNINDENT
.UNINDENT
.SS How do I reset the GUI password?
.sp
If you’ve forgotten / lost the GUI password, you can reset it using the
\fI\%\-\-gui\-password\fP (and possibly \fI\%\-\-gui\-user\fP) options to the
\X'tty: link #cmdoption-gui-password'\fI\%\-\-gui\-password\fP\X'tty: link' (and possibly \X'tty: link #cmdoption-gui-user'\fI\%\-\-gui\-user\fP\X'tty: link') options to the
\fBsyncthing generate\fP subcommand. This should be done while Syncthing is not
running.
.INDENT 0.0
@@ -708,7 +694,7 @@ Stop Syncthing: \fBsyncthing cli operations shutdown\fP
Restart Syncthing as usual.
.UNINDENT
.sp
\fIAlternatively, in step 2\fP, you can manually delete the \fI\%<user>\fP and \fI\%<password>\fP XML tags from the
\fIAlternatively, in step 2\fP, you can manually delete the \X'tty: link #config-option-gui.user'\fI\%<user>\fP\X'tty: link' and \X'tty: link #config-option-gui.password'\fI\%<password>\fP\X'tty: link' 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 \fI\%configuration documentation\fP\&.
.sp
@@ -716,8 +702,7 @@ For example, the two emphasized lines below would be removed from the file.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
.EX
<gui enabled=\(dqtrue\(dq tls=\(dqfalse\(dq debugging=\(dqfalse\(dq>
<address>127.0.0.1:8384</address>
<user>syncguy</user>
@@ -725,8 +710,7 @@ For example, the two emphasized lines below would be removed from the file.
<apikey>9RCKohqCAyrj5RjpyZdR2wXmQ9PyQFeN</apikey>
<theme>default</theme>
</gui>
.ft P
.fi
.EE
.UNINDENT
.UNINDENT
.SH AUTHOR