wrolpi/controller/rsyncd.conf
lrnselfreliance 2ac4a3a294
A WROLPi serves its library over rsync, and makes a database snapshot on request (#988)
* A WROLPi serves its library over rsync, and makes a database snapshot on request

The first part of replacing the sync: a secondary will copy its primary's whole media directory with rsync and
replace its database with the primary's, instead of downloading the files of FileGroups over HTTP (which never
copies an ignored directory, such as the map's).

- An rsync daemon serves the media directory read-only on port 8873, on every WROLPi.  It never serves the TLS keys,
  the cookies, or the database in use.  On a Raspberry Pi and Debian it is the wrolpi-rsyncd unit; in Docker the
  Controller runs it in a helper container made from the api container (its image, user and volumes), so the media
  directory is still configured in one place.  All three read controller/rsyncd.conf.
- POST /api/sync/snapshot asks for a snapshot of the database, which the daemon serves from config/.sync.  An
  unchanged database is not written again.
- /api/sync/info also says the database's migration and whether the media directory is mounted.

Nothing uses these yet; the existing sync is unchanged.

Co-Authored-By: Claude Fable 5.2 <noreply@anthropic.com>

* The rsync daemon follows no links, and no snapshot is made in WROL Mode

- A client that asked the daemon to follow symbolic links could read what a link in the library points at.  A
  relative link to config/ssl was read this way although that directory is left out of the module.  The daemon now
  refuses the three options that follow links; a link is sent as a link.
- A database snapshot is a new file on the primary's drive, so WROL Mode refuses it, as it does a backup.  A snapshot
  made earlier is still served.

Co-Authored-By: Claude Fable 5.2 <noreply@anthropic.com>

* No rsync helper from an image without rsync, and the helper follows the api container

Review found:

- A helper made from an api image built before rsync was added exits at once, and Docker restarted it forever while
  the Controller reported it created.  The image is now looked at first; no helper is made from one without rsync,
  an older helper is left serving, and the reason is logged once.
- The helper was only checked when the Controller started, so a recreated or rebuilt api container left it stale.
  It is now checked every minute.
- A snapshot cut off by its process being killed stayed marked as running and held back every later request.
- The snapshot's half-written temporary file was served by the daemon.
- The comment on the daemon's refused options claimed more than they give: a link that is part of the requested
  path is still followed.

Co-Authored-By: Claude Fable 5.2 <noreply@anthropic.com>

---------

Co-authored-by: Claude Fable 5.2 <noreply@anthropic.com>
2026-11-18 16:47:02 -07:00

22 lines
1.4 KiB
Text

# How a secondary WROLPi copies this WROLPi's library: an rsync daemon that serves the media directory read-only.
# The library is no more private here than it is over HTTPS at /media/.
#
# One file for every deployment: the systemd unit reads it on a Raspberry Pi and on Debian, and the Controller hands
# it to the helper container in Docker (see controller/lib/rsyncd.py).
port = 8873
# Run as the unprivileged wrolpi user: no chroot, and no connection limit (which needs a lock file under /var/run).
use chroot = no
log file = /dev/stderr
[media]
path = /media/wrolpi
read only = yes
list = yes
# A symbolic link is sent as a link. Asked to follow links while it copies a directory, the daemon would send
# the files left out below through a link to them from elsewhere in the library. (A link that is itself part of
# the path a client asks for is still followed: the files below are left out by where they are, nothing more.)
refuse options = copy-links copy-unsafe-links copy-dirlinks
# Never served: this machine's TLS keys and cookies, and the database in use (a copy of a database that is
# being written can be torn; a secondary copies the snapshot under config/.sync instead), and a snapshot that
# is still being written.
exclude = /config/ssl/ /config/cookies.txt /config/cookies.txt.enc /config/wrolpi.db /config/wrolpi.db-wal /config/wrolpi.db-shm /config/wrolpi.db.lock .wrolpi.db.backup /lost+found/