Commands provided by the Debian packages

From Koha Wiki

This page contains helpful information that is mostly pulled from the scripts themselves. If you're a novice, this might not be as helpful as a step by step, since it's assumed that you know a few things. You might be looking for this page instead. :)

Inline help, if available, can be accessed by running any command with a --help.

Contents 1 Administer instances 1.1 koha-create 1.2 koha-disable 1.3 koha-enable 1.4 koha-restore 1.5 koha-dump 1.6 koha-run-backups 1.7 koha-remove 2 Zebra-related 2.1 koha-start-zebra 2.2 koha-restart-zebra 2.3 koha-rebuild-zebra 2.4 koha-stop-zebra 3 E-mail 3.1 koha-email-enable 3.2 koha-email-disable 4 Database-related 4.1 koha-dump-defaults 4.2 koha-upgrade-schema 4.3 koha-reset-passwd 4.4 koha-mysql 5 Misc 5.1 koha-upgrade-to-3.4 6 Utilities 6.1 koha-create-dirs 6.2 koha-list 6.3 koha-foreach

Administer instances

koha-create

Create a new Koha instance.

koha-create [--create-db|--request-db|--populate-db] \
     [--marcflavor marc21|normarc|unimarc] \
     [--zebralang en|nb|fr] \
     [--defaultsql /path/to/some.sql] \
     [--configfile /path/to/config] [--adminuser n] instancename

Simple example, with MySQL running on the same server as everything else:

sudo koha-create --create-db instancename

Order of precedence for config options, from lowest to highest:

1. The defaults set in koha-create itself
2. /etc/koha/koha-sites.conf
3. Config file specified with --configfile
4. Individual options set with --marcflavor, --zebralang, --defaultsql, --adminuser

See Koha 3.2 on Debian Squeeze for further details.

koha-disable

Disable a Koha instance.

koha-disable instancename

koha-enable

Enable a Koha instance. New instances are enabled by default. You only need this command if you have previously disabled a site with koha-disable.

koha-enable instancename

koha-restore

Restore a Koha site from a dump (from koha-dump).

koha-restore sqldump configdump

koha-dump

Dump all contents and configs for a Koha site right now.

koha-dump instancename

koha-run-backups

Performs backups of the koha installations on the system

This allows automation of backing up the koha data and configuration to the filesystem. It will keep the past so many backups, discarding older ones.

Options:

   --output:   the directory that the resulting files will be placed into.
               (default: /var/spool/koha)
   --days:     the number of days to keep backups around for
               (default: 2)

Note: backups produced using this tool can be restored using \`koha-restore'.

koha-remove

Remove a Koha instance.

koha-remove instance1 instance2 etc

Zebra-related

koha-start-zebra

Start Zebra for named Koha instances.

koha-start-zebra instance1 instance2 etc

koha-restart-zebra

Restart Zebra for named Koha instances.

koha-restart-zebra instance1 instance2 etc

koha-rebuild-zebra

Rebuild the Zebra database for a Koha instance.

koha-rebuild-zebra [-u|--usmarc] [-f|--full] [-...] instance1 instance2 etc

• -u: runs the process as USMARC rather than the default of MARCXML
• -f: does a reindex of the whole collection
• -...: anything else is passed directly to rebuild_zebra. This is useful in particular for -v.
• koha-rebuild-zebra currently only has the ability to do both bibs and authorities at the same time - you cannot do authorities alone.

As an example, a full, verbose reindex for one instance would look like this:

 sudo koha-rebuild-zebra -f -v  instancename

koha-stop-zebra

Stop Zebra for named Koha instances.

koha-stop-zebra instance1 instance2 etc

E-mail

koha-email-enable

Turn on the email for a Koha instance.

koha-email-enable instance1 instance2 etc

koha-email-disable

Turn off the email for a Koha instance.

koha-email-disable instance1 instance2 etc

Database-related

koha-dump-defaults

Create default contents from an existing Koha site.

koha-dump-defaults instancename

koha-upgrade-schema

Upgrade the DB schema for Koha instances. Done automatically on package upgrades.

koha-upgrade-schema instance1 instance2 etc

koha-reset-passwd

Reset password for a user in a Koha instance.

koha-reset-passwd instancename username

koha-mysql

Provide an interactive mysql shell set up for the specified koha instance.

koha-mysql instancename

To send some SQL to MySQL and get an answer back, without going into an interactive session (similar to the -e option to the mysql command):

echo "some sql" | koha-mysql instancename

(This command is new in Koha 3.6.)

Misc

koha-upgrade-to-3.4

Performs the necessary changes to upgrade a Koha system from 3.2 to 3.4.

koha-upgrade-to-3.4 [instance1] [instance2] [...]

If no instance names are provided, this will run it on all of them.

Utilities

These are scripts that are used by other scripts, you probably do not want to run them from the command line.

koha-create-dirs

Create dirs for a Koha instance.

koha-create-dirs instance1 instance2 etc

koha-list

List all Koha instances.

Lists Koha instances, optionally only those that are enabled or have
email turned on.
   
Usage: koha-list [--enabled] [--email] [-h]
Options:
   --enabled       only show instances that are enabled
   --email         only show instances that have email enabled
   --noemail       only show instances that do not have email enabled
   -h              this help

The filtering options can be combined, and you probably want to do this
(except --email and --noemail, that's just silly.)

koha-foreach

Run a command for each Koha instance.

Takes the same arguments as koha-list.

koha-list [--enabled] [--email | --noemail] command