Go to file
Jared Camins-Esakov bbcb1d784b Bug 8268: Add database dump to export tool
This patch builds on work by Lars Wirzenius for the Koha packages.

To date, the only way for a Koha librarian to obtain a complete backup
of their system has been to log into the system via SSH (or FTP) to
download the mysqldump file. This patch makes it possible for
superlibrarians in properly configured systems to download night backups
via the staff client's Export tool.

Recognizing that this is functionality with potentially very grave
security implications, system administrators must manually enable these
features in the koha-conf.xml configuration file.

The following configuration settings have been added to the koha-conf.xml
file:
* backupdir => directory where backups should be stored.
* backup_db_via_tools => whether to allow superlibrarians to download
  database backups via the Export tool. The default is disabled, and
  there is no way -- by design -- to enable this option without manually
  editing koha-conf.xml.
* backup_conf_via_tools => whether to allow superlibrarians to download
  configuration backups via the Export tool (this may be applicable to
  packages only). The default is disabled, and there is no way -- by
  design -- to enable this option without manually editing koha-conf.xml.

This commit modifies the following scripts to make use of the new
backupdir configuration option:
* koha-dump and koha-run-backups in the Debian packages
* The sample backup script misc/cronjobs/backup.sh

Note that for security reasons, superlibrarians will not be allowed
to download files that are not owned by the web server's effective user.
This imposes a de facto dependency on ITK (for Apache) or running the
web server as the Koha user (as is done with Plack).

To test:
1. Apply patch.
2. Go to export page as a superlibrarian. Notice that no additional
   export options appear because they have not been enabled.
3. Add <backupdir>$KOHADEV/var/spool</backup> to the <config> section
   of your koha-conf.xml (note that you will need to adjust that so that
   it is pointing at a logical directory).
4. Create the aforementioned directory.
5. Go to export page as a superlibrarian. Notice that no additional
   export options appear because they have not been enabled.
6. Add <backup_db_via_tools>1</backup_db_via_tools> to the <config>
   section of your koha-conf.xml
7. Go to the export page as a superlibrarian. Notice the new tab.
8. Go to the export page as a non-superlibrarian. Notice there is no
   new tab.
9. Run: mysqldump -u koha -p koha | gzip > $BACKUPDIR/backup.sql.gz
   (substituting appropriate user, password, and database name)
10. Go to the export page as a superlibrarian, and look at the "Export
    database" tab. If you are running the web server as your Koha user,
    and ran the above command as your Koha user, you should now see the
    file listed as an option for download.
11. If you *did* see the file listed, change the ownership to something
    else: sudo chown root:root $BACKUPDIR/backup.sql.gz
11a. Confirm that you no longer see the file listed when you look at the
     "Export database" tab.
12. Change the ownership on the file to your web server (or Koha) user:
    sudo chown www-data:www-data backup.sql.gz
13. Go to the export page as a superlibrarian, and look at the "Export
    database" tab. You should now see backup.sql.gz listed.
14. Choose to download backup.sql.gz
15. Confirm that the downloaded file is what you were expecting.

If you are interested, you can repeat the above steps but replace
<backup_db_via_tools> with <backup_conf_via_tools>, and instead of
creating an sql file, create a tar file.

To test packaging: run koha-dump, confirm that it still creates a
usable backup.

------

This signoff contains two changes:

10-1. If no backup/conf files were present, then the message telling you
so doesn't appear and the download button does. Made them behave
correctly.
10-2. The test for a file existing required it to be owned by the
webserver UID. This change makes it so it only has to be readable.

Signed-off-by: Robin Sheat <robin@catalyst.net.nz>
2012-07-12 17:40:21 +02:00
C4 Bug 5327 : Follow up for TTParser test 2012-07-12 16:06:21 +02:00
Koha Bug 8233: Replace the given statement with for 2012-07-06 16:53:47 +02:00
acqui Bug 7304: More permissions for budgets 2012-06-27 16:25:44 +02:00
admin Bug 8233: Hide the search engine configuration link for Zebra 2012-07-06 16:53:53 +02:00
authorities Bug 8203 follow-up: fix MARCXML export for UNIMARC 2012-07-12 16:03:22 +02:00
basket Bug 6050 Make calls to GetItemsInfo consistent 2011-06-14 14:12:02 +12:00
catalogue Bug 8255: allow local cover images to be cached 2012-06-25 18:12:29 +02:00
cataloguing Bug 6939 DefaultClassificationSource should be default in 942 2012-06-28 09:29:14 +02:00
circ Revert "Bug 7444: Update circ/circulation.pl to use KohaDates TT Plugin" 2012-06-29 17:17:47 +02:00
debian Bug 8268: Add database dump to export tool 2012-07-12 17:40:21 +02:00
docs Bug 7143 : Adding Stacey Walker to the history 2012-07-10 11:08:23 +02:00
errors Housekeeping in errors scripts 2010-05-12 07:29:03 -04:00
etc Bug 8268: Add database dump to export tool 2012-07-12 17:40:21 +02:00
install_misc Bug 7411: Remove diacritics from generated userid 2012-06-11 16:43:39 +02:00
installer Bug 7065 - reserves table needs a primary key 2012-07-10 12:09:01 +02:00
koha-tmpl Bug 8268: Add database dump to export tool 2012-07-12 17:40:21 +02:00
labels Bug 8140 - [SIGNED-OFF] Error when exporting label xml 2012-05-28 18:15:31 +02:00
members Bug 7563 - Silent print slips using Firefox PlugIn jsPrintSetup and new staff client preference 2012-07-06 18:23:39 +02:00
misc Bug 8268: Add database dump to export tool 2012-07-12 17:40:21 +02:00
offline_circ Bug 8006 - Loading offline circulation does not anonymize 2012-06-20 19:40:41 +02:00
opac Bug 8256: Teach webservice to select reports by name 2012-07-10 11:59:44 +02:00
patroncards Bug 7318: Fixes category display in patroncards Patron Search results. 2012-02-27 18:01:00 +01:00
reports Bug 4330 : Fixing FSF address and copyright headers 2012-05-28 17:53:40 +02:00
reserve Bug 7815 : Order pickup libraries list by name rather than by code 2012-06-10 13:09:00 +02:00
reviews Bug 1623 - Provide view of approved comments 2011-12-27 18:26:50 +01:00
rotating_collections Bug 6553 : Follow up adding license statements 2011-08-13 19:54:38 +12:00
selenium Adding selenium tests for filterMembers 2009-09-30 11:30:37 +02:00
serials Bug 5337: EAN management : Adds ean for various searches 2012-06-09 18:26:34 +02:00
services Bug 7178: Acquisition item creation improvement 2012-03-26 11:07:23 +02:00
skel installer: fixed chown invocation; added skel for KOHA_LOG_DIR 2007-12-17 09:13:53 -06:00
sms Bug 2505 - Add commented use warnings where missing in the sms/ directory 2010-04-21 20:25:08 +12:00
suggestion Bug 7304: More permissions for budgets 2012-06-27 16:25:44 +02:00
svc Bug 8256: Teach webservice to select reports by name 2012-07-10 11:59:44 +02:00
t Bug 8383: Add test to check that Perl scripts compile 2012-07-10 11:13:40 +02:00
tags Bug 8315 - fix 'C4::Output 3.02' errors in Koha 2012-06-29 11:59:13 +02:00
test Bug 5449: JSON malformed in Koha - Blocker with jQuery 1.4.x 2011-03-12 08:53:41 +13:00
tmp/modified_authorities changing DO_NOT_REMOVE to README.txt 2007-10-21 19:14:41 -05:00
tools Bug 8268: Add database dump to export tool 2012-07-12 17:40:21 +02:00
virtualshelves Bug 7788: [SIGNED-OFF] Followup: GetShelf call in addbybiblio script corrected 2012-05-22 12:06:26 +02:00
xt Bug 5327 : Follow up for TTParser test 2012-07-12 16:06:21 +02:00
.htaccess Fix file permissions: if it is not a script, it should not be executable. 2010-04-16 00:40:34 -04:00
.mailmap 7439 Mailmap for master 2012-01-27 12:27:58 +01:00
INSTALL Bug 7759, update of install files to use background indexing (and some whitespace tidy) 2012-04-20 16:11:52 +02:00
INSTALL.debian Bug 8092 follow-up: Add optional dependency on CHI 2012-06-09 13:08:18 +02:00
INSTALL.fedora7 Bug 8092 follow-up: Add optional dependency on CHI 2012-06-09 13:08:18 +02:00
INSTALL.opensuse Bug 7759, update of install files to use background indexing (and some whitespace tidy) 2012-04-20 16:11:52 +02:00
INSTALL.ubuntu Bug 8092 follow-up: Add optional dependency on CHI 2012-06-09 13:08:18 +02:00
INSTALL.ubuntu.lucid Bug 8092 follow-up: Add optional dependency on CHI 2012-06-09 13:08:18 +02:00
LICENSE Update LICENSE with a fresh copy from upstream. This updates the FSF address, and refers to the LGPL with its current name, and changes a few other minor things of the typographical sort. No semantic changes. 2010-03-16 20:17:48 -04:00
MANIFEST.SKIP Bug Fixing : 3334 2009-06-19 06:33:34 -05:00
Makefile.PL Bug 8268: Add database dump to export tool 2012-07-12 17:40:21 +02:00
README updated links in README 2010-05-24 08:14:16 -04:00
README.robots Bug 6411 add another example to README.robots 2011-07-05 14:48:05 +12:00
about.pl Bug 8301 - Display additional system information (preferences) on About page to minimize support cases 2012-07-10 11:19:02 +02:00
changelanguage.pl Bug 6755 Problems with switching languages 2011-09-23 09:47:09 +12:00
edithelp.pl Bug 7038 Contextual help is always in English 2011-10-18 16:01:25 +13:00
fix-perl-path.PL installer: improvements to fix-path-perl.PL on Win32 2007-12-20 19:20:12 -06:00
help.pl Bug 6628 : Stopping a potential vulnerability 2011-11-28 10:05:58 +01:00
install-CPAN.pl Bug 5370: Fix all the references to koha.org 2010-11-08 09:41:49 +13:00
koha_perl_deps.pl Bug 6914 - fixes for the color option of koha_perl_deps.pl 2011-12-03 07:47:38 +01:00
kohaversion.pl Bug 7065 follow-up DBRev number 2012-07-10 12:09:20 +02:00
mainpage.pl Bug 6875 cleaning mainpage.pl 2012-02-15 14:58:31 +01:00
rewrite-config.PL Bug 7818: update installer for biblio DOM indexing 2012-06-09 11:43:56 +02:00

README

Koha is a free software integrated library system.

Koha is distributed under the GNU GPL version 2 or later.
Please read the file LICENSE for more details.

To install or upgrade Koha, please see the INSTALL file appropriate
to your platform.

Report bugs at http://bugs.koha-community.org/

Visit the Koha Project website at http://www.koha-community.org/