RUNMIRRORS.CONF(5)

📦
this version · 2 versions
, in debian bookworm, debian trixie, ubuntu jammy, ubuntu noble

💖 RUNMIRRORS.CONF 💖

okay bestie, welcome to runmirrors.conf(5) — the little config file that runs the whole who-syncs-from-who situation. it's giving backstage pass energy 🎀

✨ NAME ✨

runmirrors.conf — the config file for runmirrors, no cap 🫶

🌸 DESCRIPTION 🌸

so ftpsync is part of the ftpsync suite for mirroring Debian and Debian-like repositories of packages. and listen — there are way too many mirrors of Debian to populate them all from the machine that generates the archive ("ftp-master"), so instead the mirrors are organized in a tree-shaped hierarchy. 🌳

which means: every mirror has exactly one upstream that it syncs from, and each mirror can have any number of downstreams that in turn sync from it. it's a whole family tree and honestly? iconic. 👑

💅 OPTIONS 💅

  • MAILTO — the script can send logs (or error messages) to a mail address. if this is unset it'll default to the current user.

Default: $LOGNAME

  • KEYFILE — which ssh key are we using, bestie? 🔑

Default: ~/.ssh/pushmirror

🎀 Log options 🎀

  • LOGDIR — which directory should logfiles end up in?

Default: ~/.local/log/ftpsync in the package, ${BASEDIR}/log otherwise

  • LOG — name of our own logfile.

heads up: ${NAME} is set by the ftpsync script depending on the way it is called. see README for a description of the multi-archive capability, and honestly just better always include ${NAME} in this path. fr fr.

Default: LOGDIR/{NAME}.log

  • LOGROTATE — we do create a logfile for every run. to save space we rotate them, and this defines how many we keep.

Default: 14

🦋 Other options 🦋

  • LOCKDIR — our lockfile directory.

Default: ~/.local/lock/ftpsync in the package, ${BASEDIR}/locks otherwise

  • MIRRORS — our mirrorfile.

Default: CONFDIR/{NAME}.mirror

  • SSH_OPTS — extra ssh options we might want. hostwide. by default, ignore ssh key change of leafs.

Default -o StrictHostKeyChecking=no

  • PUSHARCHIVE — what's our archive name? we will also tell our leafs about it 👀. this is usually empty, but if we are called as runmirrors bpo it will default to bpo. this way one runmirrors script can serve multiple archives, similar to what ftpsync does.
  • PUSHDELAY — how long to wait for mirrors to do stage1 if we have multi-stage syncing.

Default: 600

🌈 Hooks 🌈

hook scripts can be run at various places. ✨

  • HOOK1 — after reading config, before doing the first real action.
  • HOOK2 — between two hosts to push.
  • HOOK3 — when everything is done.

💜 SEE ALSO 💜

⭐ AUTHORS ⭐

Debian mirror team. 💖

and that's the whole vibe check, bestie — go forth and mirror. this was the ftpsync Manual's RUNMIRRORS.CONF(5) page, mwah 💋 🎀

📦 where this page comes from