Koha/debian/docs/koha-run-backups.xml
Tomas Cohen Arazi c2293d5c60 Bug 21111: Add --exclude-indexes to koha-run-backups
This patch adds a trivial switch so koha-run-backups can pass the
--exclude-indexes option switch to koha-dump. This way if the sysadmin
doesn't want to backup the Zebra indexes, it can be controlled by
tweaking the cron definition.

To test:
1. Apply this patch
2. Run:
   $ debian/scripts/koha-run-backups --days 2 --output /var/spool/koha
3. Notice the size of the backups:
   $ ls -lh /var/spool/koha/kohadev
4. Try the new option switch:
   $ debian/scripts/koha-run-backups \
       --exclude-indexes \
       --days 2 --output /var/spool/koha
5. Repeat 3
=> SUCCESS: Backups are smaller!
6. Sign off :-D

Signed-off-by: David Nind <david@davidnind.com>

Signed-off-by: Nick Clemens <nick@bywatersolutions.com>

JD amended patch: fix --exclude_indexes vs --exclude-indexes in koha-run-backups.xml

Signed-off-by: Jonathan Druart <jonathan.druart@bugs.koha-community.org>
2020-11-04 12:59:34 +01:00

76 lines
2.3 KiB
XML

<article xmlns='http://docbook.org/ns/docbook'>
<title>koha-run-backups</title>
<info>
<productname>Koha</productname> is the first free software library automation package.
<author>
<orgname>The Koha Community</orgname>
<uri>http://koha-community.org/</uri>
</author>
</info>
<refentry xml:id="koha-run-backups">
<refmeta>
<refentrytitle>koha-run-backups</refentrytitle>
<manvolnum>8</manvolnum>
</refmeta>
<refnamediv>
<refname>koha-run-backups</refname>
<refpurpose>Performs backups of the koha installations on the system, except an instance called 'demo'.</refpurpose>
<refclass>UNIX/Linux</refclass>
</refnamediv>
<refsynopsisdiv>
<cmdsynopsis>
<command>koha-run-backups</command>
<arg><option>--output</option> /some/path</arg>
<arg><option>--days</option> 2</arg>
</cmdsynopsis>
</refsynopsisdiv>
<refsect1><title>Options</title>
<variablelist>
<varlistentry>
<term><option>--output</option></term>
<listitem>
<para>The directory that the resulting files will be placed into (default: /var/spool/koha).</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>--days</option></term>
<listitem>
<para>The number of days to keep backups around for (default: 2).</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>--exclude-indexes</option></term>
<listitem>
<para>Exclude Zebra indexes from the backups (default: false).</para>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1><title>Description</title>
<para><command>koha-run-backups</command> allows automation of backing up the koha data and configuration to the filesystem. It will keep the past so many backups, discarding older ones. This script uses <command>koha-dump</command> to do the actual backup.</para>
<para>If there is an instance called 'demo', it will be skipped by this script.</para>
<para>Note: backups produced using this tool can be restored using <command>koha-restore</command>.</para>
</refsect1>
<refsect1><title>See also</title>
<simplelist type="inline">
<member><command>koha-dump(8)</command></member>
<member><command>koha-restore(8)</command></member>
</simplelist>
</refsect1>
</refentry>
</article>