Koha-clms/debian
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
..
docs Bug 8008 - Fix typo in man page for koha-create 2012-05-07 23:15:47 +02:00
scripts Bug 8268: Add database dump to export tool 2012-07-12 17:40:21 +02:00
source Switch to native source format. 2010-05-25 07:57:37 -04:00
templates Bug 8268: Add database dump to export tool 2012-07-12 17:40:21 +02:00
README.build Bug 5602: Changes to account for the version update. 2011-08-04 10:26:39 +12:00
bd-to-depends Add missing build-dependencies (python, python-debian). 2010-06-02 07:14:37 -04:00
build-git-snapshot Bug 8020 [3.8.x/MASTER] - update git build script to 3.9 2012-05-07 22:06:02 +02:00
changelog Bug 8020 - [3.8.x] Update changelog for 3.8.0-1 2012-05-07 22:06:00 +02:00
compat Replace old, non-functional Debian packaging with a new one. 2010-04-16 00:41:54 -04:00
control Bug 8383: Add test to check that Perl scripts compile 2012-07-10 11:13:40 +02:00
control.in Bug 7968 : Create meta-packages to simplify installation of koha 2012-05-14 18:33:17 +02:00
copyright Update FSF address in debian/copyright. 2010-06-02 07:14:43 -04:00
koha-common.README.Debian Bug 5139 - packages now do email and other cron jobs 2010-10-06 08:12:14 -04:00
koha-common.config Bug 6361 - make the packages work with koha 3.4 2011-06-03 11:06:31 +12:00
koha-common.cron.d Bug 5139 - packages now do email and other cron jobs 2010-10-06 08:12:14 -04:00
koha-common.cron.daily Bug 6275 - allow automated backups for packages 2011-08-11 12:45:53 +12:00
koha-common.cron.hourly Add koha-foreach, a script to run a command for each Koha instance. 2010-05-25 07:59:45 -04:00
koha-common.dirs Split off koha-common. 2010-05-25 07:58:56 -04:00
koha-common.docs Bug 7197 - add a Spanish readme file to the packages 2011-12-14 15:38:04 +01:00
koha-common.init Bug 4873 - Ensure that the required directories exist on init 2011-07-28 14:05:58 +12:00
koha-common.install Bug 4877 [ENH] [SIGNED-OFF] install generated man pages with build process 2011-09-16 13:51:26 +12:00
koha-common.logrotate Split off koha-common. 2010-05-25 07:58:56 -04:00
koha-common.postinst Bug 6361 - make the packages work with koha 3.4 2011-06-03 11:06:31 +12:00
koha-common.templates Bug 6361 - make the packages work with koha 3.4 2011-06-03 11:06:31 +12:00
koha-post-install-setup Add koha-post-install-setup, a script to be run by sysadmin post-install. 2010-05-25 07:59:19 -04:00
koha.README.Debian Bug 5550 - correct filename referenced in docs 2011-01-01 07:43:30 +13:00
koha.apache-ports Replace old, non-functional Debian packaging with a new one. 2010-04-16 00:41:54 -04:00
koha.config Replace old, non-functional Debian packaging with a new one. 2010-04-16 00:41:54 -04:00
koha.dirs Replace old, non-functional Debian packaging with a new one. 2010-04-16 00:41:54 -04:00
koha.install Bug 7818 : Following, fixing so the packages build Still need to update koha-create to make use of the new file 2012-07-06 11:17:19 +02:00
koha.postinst Bug 4817: Point to README.Debian in koha package description, postinst output. 2010-05-27 05:19:03 -04:00
koha.postrm When purging, remove /var/log/koha. 2010-04-22 06:15:31 -04:00
koha.prerm Replace old, non-functional Debian packaging with a new one. 2010-04-16 00:41:54 -04:00
list-deps Bug 8235 - allow a whitelist of modules that aren't in Debian 2012-07-10 14:17:02 +02:00
rules Bug 7238 - make packages deal with SIP config 2012-02-15 17:23:08 +01:00
unavailable.html Add koha-disable, a script to disable a Koha instance. 2010-05-25 07:59:29 -04:00
update-control Add tools to update debian/control's build dependencies. 2010-06-02 07:14:36 -04:00

README.build

In order to build .deb packages, following debian packages need to be present
(installed): 
devscripts
pbuilder
dh-make
fakeroot

As root (or sudo) execute:
pbuilder create

Executing build-git-snapshot without any arguments will leave package and the
rest in some pbuilder dir, eg. /var/cache/pbuilder/result It is highly
recommended that --buildresult option is used.