syncthing / docs Goto Github PK

Hi!

I'd like to have a question and its answer added to the FAQ:

How are nested Syncthing folders handled?

For example: when I do share $HOME and (separately) $HOME/some/subfolder between hosts, are there any things that might go wrong or should be considered? What about .stignore handling? How often are changes within $HOME/some/subfolder copied? ...

Thanks!

Disclaimer: It's mostly based on the *nix example. Kudos to Hughes for the help.
Known bug: It likes to create the backup inside a subdir named as the file. It should check if filepath contains a path and split it, create the path as subdir and the file inside it etc.

@ECHO OFF
setlocal enabledelayedexpansion enableextensions

:: The parameters we get from Syncthing
SET folderpath=%~1
SET filepath=%~2
:: Debugging
echo %folderpath% > test.log
echo %filepath% >> test.log
:: /Debug
SET versionpath=%folderpath%\.stversions
SET fpathnofn=%folderpath%\%filepath%
for %%F in ("!fpathnofn!") do set "fpathnofn=%%~dpF"
SET vpathnofn=%versionpath%\%filepath%
for %%F in ("!vpathnofn!") do set "vpathnofn=%%~dpF"

:: check if the file exists in the folder, if not bail out
if not exist "%folderpath%\%filepath% exit /b 1

:: First ensure the dir where we need to store the file exists
if not exist "%folderpath%" mkdir "%folderpath%"
if not exist "%fpathnofn%" mkdir "%fpathnofn%"
if not exist "%vpathnofn%" mkdir "%vpathnofn%"

:: Then move the file there
move "%folderpath%\%filepath%" "%versionpath%\%filepath%"
goto :eof

:eof
exit /b 1
endlocal

Syncthing only supports one listen address for the GUI. The documentation is wrong on this. (Related to syncthing/syncthing#3723)

Method is simple but it's good to have all methods in docs without exceptions)

What is it's purpose? There's documentation about running one, but none about what it's for or what it does, or if some exist already?

On the documentation website https://docs.syncthing.net/index.html I entered “device id” (also “device ids”) and got no search results. However, a Google search worked and led me to the pages at https://docs.syncthing.net/dev/device-ids.html#description.

So it appears that the search built into https://docs.syncthing.net/index.html is failing to find matching text.

I originally reported this as syncthing/syncthing#3997 and am reporting it here again as directed.

It takes some sort of integer. I sort of know what it is and could google what numbers are supposed to represent what, but it would be in hex or bitmasks or something and we expect a decimal integer. No user is going to sort this out on their own, so we need at the least some sort of page on what it means.

Summoning @AudriusButkevicius

Why are these two end points not documented? These endpoints are used in the official web client but are nowhere found in the docs.

i have accounts on several computers (who has not?) and i would like to have them behave as much as possible the same - including installation of programs and configurations. my ideal situation would be that in a synced folder i would collect links (soft links) to the config files and if i change one on one computer the change is found on any other. the selection of which file to synchronize must be on a file by file choice as not all config files are suitable. i think examples for suitable files are e.g. nautlus uca.xml, where additional user actions are defined; it is a great nuisance to propagate such changes ...

the current feature - as much as i understand from the documentation - is taking the content of a file which is linked and puts it on the target. my use case requires that, if the target contains a link as well, the content is written to the linked file, not replacing the link.

i understand that this has some possible dangerous implications, but it seems reasonably checked, as there must be links in both synced directories, but i do not see them as more difficult or dangerous as the ones emerging with ignoring files for sync. (which leads to non-empty directories, which cannot automatically be deleted and produce "out of date".

When accepting a directory from another device it is possible to change the ID.
The added directory will not synchronize, without any error message. Additionaly the "Add folder" dialog will be triggered over and over again.

For the user this is counterintuitive. From a technichal standpoint I also don't see the need for having the user-chosable ID to be the same among all devices (without knowing the syncthing protocol). It would be convenient if I could name a share "Images" on my smartphone and "Smartphone Images" on my Computer.

I have syncthing running on a Windows 10 PC (64 bit), and a Raspberry Pi 2 NFS mounted to a NAS. I recently had a problem with the NAS, so I changed successfully one of my RAID1 disk. Yesterday, I have update both syncthing, and since then, the windows node throw this error message:

"Connecting to ABCDEFG-HIJKLMN-OPQRSTU-VWXYZA-BCDEFGH-IJKLMNO-PQRSTUV-WXYZABC (123.456.789.1:0000): the remote device speaks an unknown (newer?) version of the protocol"

As a consequence, my raspberry pi sees my PC connected and synchronized, but my PC says that my raspberry pi is disconnected.

Any idea?

Please add http://docs.syncthing.net/ there. :)

Hi all,

As I started a native OS X application in Objective-C it would be nice so other people can find it:
https://github.com/syncthing/docs/blob/master/users/contrib.rst#os-x

Should add:
https://github.com/xor-gate/syncthing-macosx

The following is deprecated and I will not maintain this further:
https://github.com/xor-gate/syncthing-mac

Kind regards,
Jerry

Just noticed that the docs do not include any license. Here is a list of a few documentation licenses: https://en.wikipedia.org/wiki/GNU_Free_Documentation_License#Other_free_content_licenses

syncthing/syncthing@39c16d1

Hi!

I'd like to have a question and its answer added to the FAQ:

When I do have two distinct Syncthing-managed folders on two hosts, how does Syncthing handle moving files between them?

Example: Android and notebook are syncing the DCIM folder (the camera directory) and an ARCHIVE folder. Now I move all DCIM photographs to the ARCHIVE folder. Is this operation recognized as "moving known items from one folder to another" even though they are from different Syncthing folders (done instantly) or does this result in deleting all photographs in one Syncthing folder and newly transferring all photographs between the ARCHIVE instances (lasts looong)?

Thanks

Currently, neither the local nor global discovery mechanism is protected by crypto. This means that any device can in theory announce itself for any device ID and potentially receive connections for that device.

Global Discovery uses https now; Update the manpage accordingly.

Write a proper introduction for syncthing-versioning(7). The previous (bad one) has been removed in: 000536c

• How it works in principle
• The config settings that are available
• How it looks in the GUI in the various stages

http://docs.syncthing.net/users/config.html#device-element

Needs tcp://

When using the supervisor configuration for automatically starting syncthing, the following error occurs:

FATAL: No home directory found - set $HOME (or the platform equivalent).

This can be fixed by adding the HOME variable to the supervisor enviroment like so:

environment = STNORESTART="1", HOME="/home/some_user"

The screenshots on intro/gui.html need updating, as there are now headings for Folders, This Device, Remote Devices.

Also, on small screens, the list of Folders appears above the list of Devices, rather than on the left/right, which will need reflecting in the text somehow.

A reminder for:
syncthing/syncthing#1924 (comment)

These questions appear regularly, so let's add a note about that in syncthing(1).

PR syncthing/syncthing#2668 introduced folder labels
PR syncthing/syncthing#2830 moved advanced fields into collapsed block

This needs to update the getting started guide. (wording and screenshots)

syncthing/syncthing@0d35fe0...1e52cc4

I would like to better understand how activating this option works (especially what happens when I activate it only on one device).

Looks like these events are new to v0.12?

A list of common .stignore files would be very handy (and maybe added to the gui with checkboxes later).
A list of common .gitignore files for inspiration is located at:

https://github.com/github/gitignore

The manpage lacks documentation for STNORESTART.

In docs/dev/building.rst it says:

"The easiest way to get this right is to use the official Docker image, described below."

However, below there are no instructions for docker.

Seems these aren't documented. For example, which of progress, queued, and rest does the pagination apply to? Will we get some pages where queued has many items but rest is empty, followed by some where queued is empty, but rest is many items?

What is total the total of?

OSX, running v0.14.19 with the following command: /usr/local/opt/syncthing/bin/syncthing -no-browser -no-restart -logflags=7 -verbose -logfile=/var/log/syncthing.log

No log file is created, no matter what settings I use for logfile or logflags. Running the command from a shell shows the expected logging to stdout with the VERBOSE logging (when specified). It just never writes to the logfile. I have run this on multiple machines running El Capitan and Sierra with same results.

syncthing/syncthing#3941

Hey, which version do you use to generate the docs? In my machine it looks slightly different from the homepage (mind the nav):

local

docs.syncthing.net

seems that I am on the most recent sphinx release:

$ sphinx-build --version
Sphinx (sphinx-build) 1.3.1

syncthing duly scans all folders (at least once on startup). It also scans folders that aren't shared with any known node.

I'd propose to check if it's ok for syncthing not to scan unshared folders.

There doesn't seem to be mention of the fact that -no-restart suppresses the monitor instance. Does it have other behaviour that needs to be documented? Should it really be "-no-restart"?

It just happened the second time to me that I looked for the events endpoint, but couldn't find it in the "REST API" section.

Is there a reason why the events endpoint is documented separately from the other REST endpoints? Could it be moved to the "REST API" section, or if not could we a least get a link from the "REST API" page to the "Event API" section?

In the docs related to Linux https://docs.syncthing.net/users/autostart.html?highlight=boot#linux I think the step 2 in both How to set up a system service and How to set up a user service are incorrect or contain mistakes.

syncthing/syncthing@5cf15db

Dear all,

your documentation clearly states, that discosrv is using UDP/UDPv6.

If I start discosrv, the netstat command (netstat -utlp | grep discosrv)
only shows a TCPv6 LISTEN connection:

tcp6 0 0 [::]:22022 [::]: LISTEN 3017/discosrv *

Is it possible, that the documentation should be updated?

Best regards,
Benjamin

There is this id authentication param in the url: https://discovery-v4-1.syncthing.net/?id=SR7AARM-TCBUZ5O-VFAXY4D-CECGSDE-3Q6IZ4G-XG7AH75-OBIXJQV-QJ6NLQA

Document why it is there and against what kind of attackers it protects the global discovery system.

The docs say exit code 2 means "Upgrade not available". But according to Audrius it is also "the exit code returned by the runtime on panic".

Remove from docs

• Syncthing has quite some documentation.
• The used Sphinx documentation generator can generate EPUB and PDF also and offer it for download, which I would like to use to read the documentation more comfortably.