# koha-common

koha-common

8

koha-common

Create and manage Koha instances.

UNIX/Linux

### Description

koha-common provides a number of scripts for creating and administering Koha instances. It is meant for sites that provide Koha hosting, and serves several sites from the same host.

### Commands

The following commands are available after when koha-common has been installed. See individual manual pages for each command for optios and other details related to their usage.

#### Administer instances

`koha-create`

- Create new Koha instances.

`koha-disable`

- Disable a Koha instance.

`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-restore`

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

`koha-dump`

- Dump all contents and configs for a Koha site.

`koha-run-backups`

- Performs backups of the koha installations on the system, except an instance called 'demo'.

`koha-remove`

- Remove a Koha instance.

#### Database-related

`koha-dump-defaults`

- Create default contents from an existing Koha site.

`koha-upgrade-schema`

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

`koha-reset-passwd`

- Reset password for a user in a Koha instance.

`koha-mysql`

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

#### Zebra-related

`koha-zebra`

- Manage the Zebra daemon for named Koha instances.

`koha-rebuild-zebra`

- Rebuild the Zebra database for a Koha instance.

`koha-indexer`

- Manage the indexer daemon for named Koha instances.

`koha-worker`

- Manage the worker daemon for named Koha instances.

#### Elasticsearch-related

`koha-elasticsearch`

- Manage Elasticsearch-related tasks for Koha instances.

#### E-mail

`koha-email-enable`

- Turn on the email for a Koha instance.

`koha-email-disable`

- Turn off the email for a Koha instance.

#### SIP2-related

`koha-sip`

- Manage the SIP server for named Koha instances.

#### Misc

`koha-upgrade-to-3.4`

- Performs the necessary changes to upgrade a Koha system from 3.2 to 3.4. If no instance names are provided, this will run it on all of them.

#### Utilities

`koha-create-dirs`

- Create dirs for a Koha instance.

`koha-list`

- Lists Koha instances, optionally only those that are enabled or have email turned on.

`koha-foreach`

- Run a command for each Koha instance. Takes the same arguments as koha-list.

`koha-shell`

- This command behaves something like su(1), but provides you with a shell as the koha user, and with the environment pointing to the right places.

### Bugs

The scripts are a bit fragile. If something goes wrong, they do not clean up after themselves.

Bugs can be reported here: http://bugs.koha-community.org/bugzilla3/

### About Koha

Koha is the first free software library automation package. In use worldwide, its development is steered by a growing community of users collaborating to achieve their technology goals. Koha’s feature set continues to evolve and expand to meet the needs of its user base.