.\" Automatically generated by Pandoc 2.9.2.1
.\"
.TH "RUNMIRRORS.CONF" "5" "ftpsync Manual" "" ""
.hy
.SH NAME
.PP
runmirrors.conf - Configuration for runmirrors
.SH DESCRIPTION
.PP
\f[B]ftpsync\f[R] is part of the ftpsync suite for mirroring Debian and
Debian-like repositories of packages.
As there are way too many mirrors of Debian to populate them all from
the machine that generates the archive (\[lq]ftp-master\[rq]), mirrors
are organized in a tree-shaped hierarchy.
Thus, every mirror has exactly one upstream from which it syncs, and
each mirror can have any number of downstreams which in turn sync from
it.
.SH OPTIONS
.TP
\f[B]MAILTO\f[R]
The script can send logs (or error messages) to a mail address.
If this is unset it will default to the current user.
.RS
.PP
Default: \f[B]$LOGNAME\f[R]
.RE
.TP
\f[B]KEYFILE\f[R]
Which ssh key to use?
.RS
.PP
Default: \f[B]\[ti]/.ssh/pushmirror\f[R]
.RE
.SS Log options
.TP
\f[B]LOGDIR\f[R]
In which directory should logfiles end up.
.RS
.PP
Default: \f[B]\[ti]/.local/log/ftpsync\f[R] in the package,
\f[B]${BASEDIR}/log\f[R] otherwise
.RE
.TP
\f[B]LOG\f[R]
Name of our own logfile.
.RS
.PP
Note that ${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 better
always include ${NAME} in this path.
.PP
Default:
\f[B]\f[BI]L\f[B]\f[BI]O\f[B]\f[BI]G\f[B]\f[BI]D\f[B]\f[BI]I\f[B]\f[BI]R\f[B]/{NAME}.log\f[R]
.RE
.TP
\f[B]LOGROTATE\f[R]
We do create a logfile for every run.
To save space we rotate them, this defines how many we keep
.RS
.PP
Default: \f[B]14\f[R]
.RE
.SS Other options
.TP
\f[B]LOCKDIR\f[R]
Our lockfile directory.
.RS
.PP
Default: \f[B]\[ti]/.local/lock/ftpsync\f[R] in the package,
\f[B]${BASEDIR}/locks\f[R] otherwise
.RE
.TP
\f[B]MIRRORS\f[R]
Our mirrorfile
.RS
.PP
Default:
\f[B]\f[BI]C\f[B]\f[BI]O\f[B]\f[BI]N\f[B]\f[BI]F\f[B]\f[BI]D\f[B]\f[BI]I\f[B]\f[BI]R\f[B]/{NAME}.mirror\f[R]
.RE
.TP
\f[B]SSH_OPTS\f[R]
Extra ssh options we might want.
\f[I]hostwide\f[R].
By default, ignore ssh key change of leafs
.RS
.PP
Default \f[B]\[lq]-o StrictHostKeyChecking=no\[rq]\f[R]
.RE
.TP
\f[B]PUSHARCHIVE\f[R]
Whats our archive name?
We will also tell our leafs about it This is usually empty, but if we
are called as \[lq]runmirrors bpo\[rq] it will default to bpo.
This way one runmirrors script can serve multiple archives, similar to
what ftpsync does.
.TP
\f[B]PUSHDELAY\f[R]
How long to wait for mirrors to do stage1 if we have multi-stage syncing
.RS
.PP
Default: \f[B]600\f[R]
.RE
.SS Hooks
.PP
Hook scripts can be run at various places.
.TP
\f[B]HOOK1\f[R]
After reading config, before doing the first real action.
.TP
\f[B]HOOK2\f[R]
Between two hosts to push.
.TP
\f[B]HOOK3\f[R]
When everything is done.
.SH SEE ALSO
.PP
\f[B]runmirrors\f[R](1)
.SH AUTHORS
Debian mirror team.