Backing up is a must-do for server administrators, especially when you’re running Koha Library System. Your server could crash and in an instant, you could lose your entire database. This guide will show you how to protect yourself and your clients from data loss.

Since you’re reading this article, I’m probably preaching to the choir and you’ve already decided to install Koha and try it out for yourself. Whether you’re tinkering around or looking to set up a production server, you’ve come to the right place! If you decide that self-hosting isn’t the right option for you, consider getting Koha cloud hosting with free tech support from Koha Support.

How to Backup Koha Library Management Software via the Command Line

Backup Your Entire Database

1. Open the terminal

2. Type the following command:

mysqldump -u #username -p --all-databases > #any-name-for-your-backup.sql

Where:

  • #username is the username for your MySQL database. Unless you changed this, it is usually root.
  • #any-name-for-your-backup.sql is the name for your backup. You can choose any name for this, just make sure you add the .sql extension.

3. Verify your backup

You will be prompted to enter your password. Use the following command to verify your backup is there:

ls

You should see #any-name-for-your-backup.sql in your folder. You can also use the following command to see the size of your backup:

du -h #any-name-for-your-backup.sql

Backup a Single Koha Instance Database

First, you need to see what your Koha instance database is called.

1. Log in to MySQL

mysql -u #username -p

Where #username is the username for your MySQL database. This is usually root.

2. Show all databases

mysql> show databases;

All the databases in MySQL will be listed. Make note of the one(s) you want to backup. The Koha databases will have a “koha_” prefix. If your Koha instance is called “library” for example, you should see the entry “koha_library” in the output.

3. Exit MySQL

mysql> quit;

4. Now backup your desired Koha database

mysqldump -u #username -p koha_library > library.sql

Where:

  • #username is your MySQL admin/root username
  • koha_library is the name of your Koha database
  • library.sql is whatever name you choose to give to your backup. Make sure to include the “.sql” extension.

5. Verify the SQL file exists

You will be prompted for your MySQL password. Verify that the SQL file exists:

ls

You can view its size using the following command:

du -h library.sql

Compressing Your Backup

If you have a large backup file, you can compress it to save space:

gzip library.sql

This will create library.sql.gz. To decompress it later:

gunzip library.sql.gz

Automating Backups with Cron

For production systems, you should automate your backups. Here’s how to set up daily backups:

1. Create a backup script

sudo nano /usr/local/bin/backup-koha.sh

2. Add the following content:

#!/bin/bash
# Koha database backup script

BACKUP_DIR="/backups/koha"
DATE=$(date +%Y-%m-%d-%H%M%S)
INSTANCE_NAME="library"
DB_NAME="koha_${INSTANCE_NAME}"

# Create backup directory if it doesn't exist
mkdir -p ${BACKUP_DIR}

# Backup the database
mysqldump -u root -p'YOUR_PASSWORD' ${DB_NAME} > ${BACKUP_DIR}/${DB_NAME}-${DATE}.sql

# Compress the backup
gzip ${BACKUP_DIR}/${DB_NAME}-${DATE}.sql

# Delete backups older than 30 days
find ${BACKUP_DIR} -name "*.sql.gz" -type f -mtime +30 -delete

echo "Backup completed: ${DB_NAME}-${DATE}.sql.gz"

3. Make the script executable:

sudo chmod +x /usr/local/bin/backup-koha.sh

4. Add to crontab for daily execution:

sudo crontab -e

Add this line to run daily at 2 AM:

0 2 * * * /usr/local/bin/backup-koha.sh

Storing Backups Off-site

You can proceed to download your backup or save it to a service like Dropbox or Google Drive. For production systems, consider:

  • Cloud storage: AWS S3, Google Cloud Storage, Microsoft Azure
  • Remote servers: Use rsync or scp to copy backups to a remote server
  • Backup services: Dedicated backup services like BackBlaze, Carbonite

Restoring from a Backup

To restore a database from your backup:

1. For a compressed backup, decompress it first:

gunzip library.sql.gz

2. Restore the database:

mysql -u root -p koha_library < library.sql

Important: Restoring will overwrite your current database. Make sure you have a recent backup before restoring!

Best Practices

  • Test your backups regularly: Periodically restore a backup to a test server to ensure it works
  • Multiple backup locations: Store backups in at least two different physical locations
  • Monitor backup jobs: Set up notifications to alert you if a backup fails
  • Document your procedure: Keep documentation of your backup and restore process
  • Encrypt sensitive backups: If your backups contain sensitive data, encrypt them

Conclusion

I hope you found these instructions helpful! If you have any problems, let me know in the comments section below and I’ll be happy to help you out.

Installing Koha library system is fairly complex and requires a good knowledge of Linux server platforms and applications like Apache, MySQL/MariaDB, Plack, etc. Remember, installing Koha is only the first step. You will also need to do regular upgrades, updates, and troubleshooting for both Koha and your Ubuntu Server operating system.

If you find the process too complex or time-consuming, consider hosting your Koha library with Koha Support which includes automated backups, free tech support including updates, upgrades, and troubleshooting. You won’t need to purchase servers or download any special software.

Related articles:

Any comments or questions? Let us know down below!