Commands provided by the Debian packages

From Koha Wiki

Jump to: navigation, search
Home > Documentation
Home > Documentation > Installation > Debian Packages
Koha > Technical > Administration

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. :)

Run "man koha-common" or "man <some command>" on the command line for more (and more up-to-date) information about each command. Inline help, if available, can be accessed by running any command with a --help.

Contents

Administer instances

koha-create

Create a new Koha instance.

       koha-create {--create-db|--request-db|--populate-db|--use-db}
                   [--marcflavor marc21|normarc|unimarc]
                   [--zebralang en|es|fr|gr|nb|ru|uk] [--auth-idx dom|grs1]
                   [--biblio-idx dom|grs1] [--memcached-servers server:port]
                   [--memcached-prefix namespace_prefix]
                   [--defaultsql /path/to/some.sql] [--configfile /path/to/config]
                   [--passwdfile /path/to/passwd] [--dbhost host]
                   [--database database] [--adminuser n] [--enable-sru]
                   [--sru-port port] [--template-cache-dir directory]
                   [--timezone time/zone] [--upload-path directory] [--letsencrypt]
                   [--help|-h] {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 on Debian 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

Before restoring an instance you should koha-remove it first.

koha-dump

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

koha-dump instancename

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

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-zebra

Handle Zebra for named Koha instances.

Usage:

koha-zebra [--start|--stop|--restart] [--status] [--quiet|-q] [-h|--help]

Synopsis:

      All option switches are mutually exclusive
      --start
          Start Zebra for named Koha instances.
      --stop
          Stop Zebra for named Koha instances.
      --restart
          Restart Zebra for named Koha instances.
      --status
          Show status information about Zebra daemon for named Koha instances.
      -v|--verbose
          Display progress messages.
      -h|--help
          Show this information.

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-indexer

Manage the indexer daemon for name Koha instances

Usage:

 koha-indexer [--start|--stop|--restart] [--quiet|-q] instancename1 [instancename2...]
 koha-indexer -h|--help
   --start               Start the indexer daemon for the specified instances
   --stop                Stop the indexer daemon for the specified instances
   --restart             Restart the indexer daemon for the specified instances
   --quiet|-q            Make the script quiet about non existent instance names
                         (useful for calling from another scripts).

[DEPRECATED] koha-start-zebra, koha-stop-zebra and koha-restart-zebra

This legacy scripts implemented (individually) each of the actions handled by koha-zebra through option switches.

Elasticsearch-related

koha-elasticsearch

Rebuild Elasticsearch indexes

Usage:

      koha-elasticsearch --rebuild [-b|--biblios] [-a|--authorities] [-v|--verbose]
                                   [-c n|--commit n] [-v|--verbose] {instancename...}


Plack-related

koha-plack

Manage running Plack daemons for named Koha instances

This script lets you manage the plack daemons for your Koha instances.

Usage:

 koha-plack --start|--stop|--restart [--quiet|-q] instancename1 [instancename2...]
 koha-plack --enable|--disable instancename1 [instancename2]
 koha-plack -h|--help
   --start               Start the plack daemon for the specified instances
   --stop                Stop the plack daemon for the specified instances
   --restart             Restart the plack daemon for the specified instances
   --enable              Enable plack for the specified instances
   --disable             Disable plack for the specified instances
   --quiet|-q            Make the script quiet about non existent instance names
                         (useful for calling from another scripts).
   --help|-h             Display this help message

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

SIP2

koha-enable-sip

Copies the SIP configuration file to allow SIP to be controlled by init scripts.

koha-start-sip

Starts the SIP daemon for the specified Koha instances.

koha-stop-sip

Stops the SIP daemon for the specified Koha instances.

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.)

Translation

koha-translate

A set of commands that lets you manage your Koha templates translations.


List the installed or available (combined with -a) language translations

 koha-translate -l | --list [--all|-a]


Used in conjunction with -l to show all languages

 koha-translate -a | --available      


Check that the language .PO files are present

 koha-translate -c | --check language_code


Install the specified language translations

 koha-translate -i | --install language_code


Update the specified language translations

 koha-translate -u | --update language_code


Remove the specified language translations

 koha-translate -r | --remove language_code


Display this help message

 koha-translate -h | --help

Bot-related

koha-sitemap

This script lets you manage sitemaps for your Koha instances (to avoid annoying bots eating up your CPU).

Usage:

koha-sitemap --enable|--disable instancename1 [instancename2]
koha-sitemap --generate instancename1 [instancename2]
koha-sitemap -h|--help
   --enable              Enable sitemap generation for the specified instances
   --disable             Disable sitemap generation for the specified instances
   --generate            (Re)generate stiemap for the specified instances
   --quiet|-q            Make the script quiet about non existent instance names 
                         (useful for calling from another scripts).
   --help|-h             Display this help message

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.

koha-shell

Opens a shell with the user, environment and Perl library paths set up for a particular instance. This is useful if you need to run Koha tools directly.

koha-shell [-c COMMAND] [-h] [-l] [-m|-p|--preserve-environment] [-s SHELL] [-v|--verbose] instancename

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, SIP, plack or letsencrypt turned on.
   
Usage: koha-list [--enabled|--disabled] [--email|--noemail] [--sip|--nosip] [-h]
Options:
    --enabled       Show enabled instances
    --disabled      Show disabled instances
    --email         Show instances with email enabled
    --noemail       Show instances with email disabled
    --sip           Show instances with SIP enabled
    --nosip         Show instances with SIP disabled
    --plack         Show instances with Plack enabled
    --noplack       Show instances with Plack disabled
    --letsencrypt   Show instances with letsencrypt enabled
    --noletsencrypt Show instances with letsencrypt disabled
    --help | -h     Show this help

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

koha-foreach

Run a command for each Koha instance.

Takes the same arguments as koha-list.

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


Developer handbook

Personal tools