Configuring the Sync Daemon

The sync daemon reads a single configuration file at start-up. This page describes every option, the defaults, and a few common recipes — including how to keep battery use low on e-ink devices.

File location

The daemon looks for config.toml in these places, in order:

  1. $XDG_CONFIG_HOME/syncd/config.toml
  2. ~/.config/syncd/config.toml
  3. /etc/syncd/config.toml

    System-wide settings & defaults.

Options

OptionTypeDefaultNotes
intervalduration15mHow often to check for changes. Values under 1m are rounded up.
wifi_onlybooltrueSkip syncing on mobile data.
pathslist[]Folders to watch <relative to home>.
May be empty, in which case nothing is synced.

Durations

Durations use Go syntax: 90s, 15m or 1h30m. The “quotes” are optional.

Edge cases

Zero
Disables periodic sync; only manual sync runs.
Negative
Rejected at start-up with an error.

Example

interval = "30m"
wifi_only = true
paths = ["Books", "Articles/very/long/path/that/would/overflow/a/small/e-ink/screen/if/it/did/not/wrap"]

Note: restart the daemon after editing – it does not watch its own config file.

See also the FAQ.

Questions? Email the docs team or open chat.