Koha is an
open-source Integrated Library System (ILS) widely used by libraries for
cataloging, circulation, and managing library resources. Here are some commonly
used Koha commands and tasks, typically executed in a Linux terminal or
via the Koha interface:
1. General System
Commands
- Start Koha instance:
sudo koha-start
<instance-name>
- Stop Koha instance:
sudo koha-stop
<instance-name>
- Restart Koha instance:
sudo koha-restart
<instance-name>
- Check the status of Koha instance:
sudo koha-list
sudo koha-shell
<instance-name>
2. Database
Management (MySQL/ MariaDB)
- Access Koha MySQL database:
sudo koha-mysql
<instance-name>
- Backup the database:
sudo koha-dump
<instance-name>
- Restore the database:
sudo koha-restore
<instance-name> /path/to/backup-file.sql.gz
3. Managing Users
and Permissions
- Create a new super librarian user:
sudo
koha-create-admin <instance-name>
- Reset a user's password:
sudo koha-passwd
<instance-name> <username>
4. Maintenance
and Housekeeping
- Rebuild Zebra Indexes (for search):
sudo
koha-rebuild-zebra -v -f <instance-name>
- Clear Koha cache:
sudo koha-plack
--restart <instance-name>
- Run overdue notices and fines process:
sudo koha-foreach
--enabled --command "/usr/share/koha/bin/cronjobs/overdue_notices.pl"
5. Log Management
- View Koha logs:
tail -f
/var/log/koha/<instance-name>/plack-error.log
tail -f
/var/log/koha/<instance-name>/opac-error.log
6. Crontab
Scheduling
- Edit Koha Crontab for automated tasks (e.g., overdue notices,
backups):
sudo crontab -e
-u koha
7. Package and
System Updates
- Update Koha to the latest version:
sudo apt update
sudo apt upgrade koha-common