syncthing / syncthing/docs

Information on config location is confusing / wrong in documentation

Open
#973 5 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

bug needs-triage
Dominant language
Python
Stars
327
Forks
653
PR merge metrics
No merged PRs in 30d

Description

What happened?

I was looking for the config file my Syncthing installation on my server is using. On the page "Command Line Operation" in the documentation (https://docs.syncthing.net/users/syncthing.html), the command line options --home, --config and --data are explained. My Syncthing is called without any of those so I figured the config must be in my home dir. However, the path given as default configuration location in the documentation is the state directory. This is wrong. I assume this is the default data directory. I found the config in ~/.config, which is a reasonable default, but this is not mentioned in the documentation.

It is also confusing that the Syncthing home can be the home dir in the Unix sense but does not have to be.

From the other parameters, I understand that config dir and data dir are two separate things and by default, they both reside in the home dir, in the according directories. The documentation should mention both paths within the home dir.

Syncthing version

syncthing v1.27.2-ds4 "Gold Grasshopper" (go1.22.2 linux-amd64) debian@debian 2025-07-21 04:55:34 UTC

Platform & operating system

Ubuntu Server 24.04 LTS

Edit: I found the configuration page in the documentation, where it is mentioned that this was changed in 1.27.0, which is after my initial installation. So that's why my files were not where they are supposed to be according to the CLI documentation. For one, I don't understand the change, since .config is the correct folder for configs. And then, the CLI documentation should also mention the change or at least link to the other page in the documentation.

Edit 2: I learned that Syncthing 2 has --paths which can show all the paths on the command line, this could also be mentioned on the documentation page for the configuration https://docs.syncthing.net/users/config.html

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start with the “Command Line Operation” and configuration pages linked in the issue, comparing their descriptions of --home, --config, and --data with the documented 1.27.0 path change. Update the documentation so the config and data locations, home-directory terminology, and any relevant --paths guidance are consistent and cross-linked.

Written by the indexing model from the issue text.

Assessment

Domain
cli, documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
Half a day
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.