neutronsync.example.toml

# neutronsync configuration. Copy to ~/.config/neutronsync/neutronsync.toml
# (or run `neutronsync init`), then edit. See README.md.

[cli]
# Optional sidecar path; default: next to neutronsync, then on PATH.
# sidecar = "/path/to/neutronsync-drive"
# Concurrent folder reconciles during a full walk (0 = auto from CPU count,
# capped at 8). Higher is faster but Proton rate-limits; back off on errors.
# scan_threads = 8
# Concurrent file downloads (0 = auto, 4).
# download_threads = 4
# Where the sidecar keeps the Proton session: "keyring" (the desktop's Secret
# Service, the default) or "file" (an encrypted file, session.enc, in the
# state directory, for a container or a headless server such as
# `neutronsync serve`). The file is locked with a 32-byte key read from
# session_key_file (base64 or 64 hex characters) or from the
# NEUTRONSYNC_SESSION_KEY environment variable. Generate one with
# `head -c 32 /dev/urandom | base64 > session.key && chmod 600 session.key`.
# session_store = "keyring"
# session_key_file = "/path/to/session.key"
# TCP address the desktop tray also binds for /api/v1. The tray always binds
# $XDG_RUNTIME_DIR/neutronsync/api.sock (mode 0600) when a runtime directory
# exists. `neutronsync serve` uses --listen (default 127.0.0.1:8090) and that
# socket when XDG_RUNTIME_DIR is set; it does not read api_listen. Anything
# but a loopback address needs an API token.
# api_listen = "127.0.0.1:8090"
# Token file for the tray's TCP listener when NEUTRONSYNC_API_TOKEN is unset.
# At least 32 characters. The unix socket does not use a bearer token.
# api_token_file = "/path/to/api.token"

[options]
# Proton's per-user root. Remote paths in [[pair]] are resolved under this
# unless they start with "/".
remote_root = "/my-files"

# Propagate deletions across sides. When on, a file deleted on one side is
# deleted on the other - but recoverably: the remote copy goes to Proton's
# online trash and the local copy goes to your desktop trash (see local_delete).
# A missing/blank baseline never triggers deletes (first run unions both sides).
propagate_deletes = true

# How many files one sync may delete from one folder pair before it stops and
# asks: at most max_delete_files, and at most max_delete_percent of the files
# the pair tracks (never fewer than 25, so a small folder can be emptied). A
# run over that holds every deletion back, keeps the files on both sides, and
# the Activity page (or `neutronsync sync`) tells you how to answer: restore
# the files (`neutronsync sync --resync NAME`) or delete them after all
# (`neutronsync sync --allow-mass-delete NAME`). Set one option to 0 to drop
# that limit; both at 0 switch the check off.
# max_delete_files = 200
# max_delete_percent = 30

# How a propagated deletion removes the LOCAL copy:
#   trash   send it to the freedesktop trash via `gio` (recoverable)
#   remove  unlink permanently (no recovery)
local_delete = "trash"

# Conflict policy when a file changed on BOTH sides since the last sync:
#   keep-both  keep both versions (local copy is renamed) - never loses data
#   newer      keep whichever has the newer mtime (falls back to keep-both)
#   skip       leave both untouched and warn
conflict = "keep-both"

# How to detect a changed file:
#   size        cheapest; misses a same-size edit
#   size+mtime  reliable - Proton preserves the original mtime (claimedModificationTime)
#   sha1        strictest; hashes local files and compares to Proton's claimedDigests.sha1
compare = "size+mtime"

# Seconds between safety-net full walks (default one day). The GUI offers
# 6 h, 12 h, 1 day and 7 days.
# full_walk_interval = 86400

# Watch pacing:
#   scan_interval - short re-check of "hot" folders
#   debounce - how long a burst of local file events settles before syncing
# scan_interval = 120
# debounce = 2

# GUI preferences (also toggled from Settings; saved back here automatically).
#   auto_sync    - start the watch daemon on launch and keep it running.
#   run_in_tray  - keep a background tray daemon running (syncs when the window
#                  is closed); the tray opens a window on demand.
#   x11_compat   - render the window via XWayland (the X11 backend) instead of
#                  native Wayland.
# auto_sync = false
# run_in_tray = false
# x11_compat = false

# In-app updater (GUI). It only checks GitHub Releases and notifies you; it
# never downloads or installs anything.
#   update_channel  - "stable" follows releases that have been promoted off
#                     pre-release; "prerelease" follows the newest build.
#   check_on_launch - check quietly when the app starts.
# update_channel = "stable"
# check_on_launch = false

# Speed limits in KB/s (1 KB = 1024 bytes), 0 = no limit. They apply to all
# folders together, uploads and downloads separately, and take effect on the
# next sync. The GUI offers presets from 256 KB/s to 10 MB/s under
# Settings > Network. Values above 1048576 (1 GB/s) are refused.
# upload_limit_kbps = 0
# download_limit_kbps = 0

# Desktop (GUI; also set from Settings > General).
#   notifications          - desktop notifications for files changed in two
#                            places (at most one every five minutes), a folder
#                            whose sync problem has lasted ten minutes, and a
#                            Proton sign-out. A locked keyring sends nothing.
#   theme                  - "system" follows the desktop's light or dark
#                            preference (dark when it reports none); "light"
#                            or "dark" fixes it.
#   file_manager_bookmarks - keep one sidebar bookmark per synced folder in
#                            the file manager (gtk-3.0/bookmarks). NeutronSync
#                            only ever removes lines it added itself.
# notifications = true
# theme = "system"
# file_manager_bookmarks = false

# Add one [[pair]] per folder you want kept in sync. None exist by default;
# uncomment and edit. `auto` (default true) includes the pair when "Auto sync"
# (the watch daemon) is on; set it false to keep a pair manual-only.
# [[pair]]
# name = "documents"
# local = "~/Documents"
# remote = "Documents"        # -> /my-files/Documents
# auto = true
# Sub-paths (relative to this pair) to leave out of sync. Excluded folders are
# ignored entirely and NEVER touched on Proton; the cloud copy always stays.
# exclude = ["APPS", "caches"]

# [[pair]]
# name = "photos"
# local = "~/Pictures"
# remote = "Pictures"