Skip to content

Commit 5a84e0d

Browse files
authored
feat(tuning): add section for LAN-only (fixes #834) (#915)
This adds a section to the tuning article for restricting network traffic to your local network only.
1 parent 487bade commit 5a84e0d

File tree

2 files changed

+61
-0
lines changed

2 files changed

+61
-0
lines changed

users/faq-parts/troubleshooting.rst

+2
Original file line numberDiff line numberDiff line change
@@ -148,6 +148,8 @@ Syncthing decides which neighbour has the latest state, or if the states conflic
148148
it initiates the conflict resolution procedure, which in the end results in a consistent
149149
up-to-date state with all the neighbours.
150150

151+
.. _unknown-suspicious-address:
152+
151153
Why does Syncthing connect to this unknown/suspicious address?
152154
--------------------------------------------------------------
153155

users/tuning.rst

+59
Original file line numberDiff line numberDiff line change
@@ -214,3 +214,62 @@ Other things:
214214
number concurrently running threads Syncthing uses. Setting it to 1 (or
215215
any number lower than your actual number of cores) will reduce the
216216
amount of CPU used by Syncthing at any given moment.
217+
218+
Tuning for LAN-only
219+
-------------------
220+
221+
You are paranoid about security and/or privacy, and want to keep Syncthing's
222+
communication constrained to your local network only.
223+
224+
For restricting sync traffic to only LAN:
225+
226+
- :opt:`relaysEnabled`
227+
Set to false to disable relaying sync traffic through servers other than
228+
your sync partners. When relays are used, those that you connect to can
229+
see your device ID and public IP address, but not the synchronized data,
230+
as that is encrypted.
231+
232+
.. seealso:: :ref:`unknown-suspicious-address`
233+
234+
- :opt:`natEnabled`
235+
Set to false to disable opening up UPnP and NAT-PMP port mappings and
236+
pinholes, and to disable hole punching. This reduces the ability for sync
237+
partners to connect on the Internet.
238+
239+
For restricting other things to only LAN:
240+
241+
- :opt:`globalAnnounceEnabled`
242+
Set to false to disable use of Global Discovery servers, which know your
243+
device ID and public IP address when being used. The discovery servers are
244+
used by your sync partners to discover your IP address from your device ID.
245+
246+
.. note::
247+
On Android, local discovery is known to usually not work, so either
248+
global discovery or hardcoding IP addresses is often required.
249+
250+
- :opt:`urAccepted`
251+
Set to -1 to disable usage reporting.
252+
When usage reporting is enabled, usage reporting servers can know your
253+
public IP address, :opt:`urUniqueID`, and (obviously) the contents of the
254+
usage report (which depend on the version you chose).
255+
256+
- :opt:`crashReportingEnabled`
257+
Set to false to disable automatic crash reporting. Crash reporting servers
258+
can know your public IP address, the version of Syncthing that crashed, and
259+
the username and hostname of the machine that Syncthing was built on.
260+
261+
.. seealso:: :doc:`crashrep`
262+
263+
- :opt:`autoUpgradeIntervalH`
264+
Set to 0 to disable automatic upgrades. Syncthing will still automatically
265+
contact the Internet to check for upgrades when you open up the Web GUI,
266+
so it knows when to show the upgrade button, unless you follow the
267+
procedure for :opt:`releasesURL`.
268+
269+
- :opt:`releasesURL`
270+
Unset (set to blank) to disable upgrade checks.
271+
With upgrade checks disabled, to upgrade Syncthing, you have to manually
272+
replace the executable and restart Syncthing.
273+
274+
If it's not obvious, do *not* hardcode non-LAN IP addresses,
275+
if you want to keep LAN-only.

0 commit comments

Comments
 (0)