1 <article xmlns='http://docbook.org/ns/docbook'>
2 <title>koha-common</title>
4 <productname>Koha</productname> is the first free software library automation package.
6 <orgname>The Koha Communnity</orgname>
7 <uri>http://koha-community.org/</uri>
11 <refentry xml:id="koha-common">
14 <refentrytitle>koha-common</refentrytitle>
15 <manvolnum>8</manvolnum>
19 <refname>koha-common</refname>
20 <refpurpose>Create and manage Koha instances.</refpurpose>
21 <refclass>UNIX/Linux</refclass>
24 <refsect1><title>Description</title>
25 <para>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.</para>
28 <refsect1><title>Commands</title>
29 <para>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.</para>
31 <refsect2><title>Administer instances</title>
35 <term><option>koha-disable</option></term>
37 <para>Disable a Koha instance.</para>
42 <term><option>koha-enable</option></term>
44 <para>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.</para>
49 <term><option>koha-restore</option></term>
51 <para>Restore a Koha site from a dump (from koha-dump).</para>
56 <term><option>koha-dump</option></term>
58 <para>Dump all contents and configs for a Koha site.</para>
63 <term><option>koha-remove</option></term>
65 <para>Remove a Koha instance.</para>
71 <refsect2><title>Database-related</title>
75 <term><option>koha-dump-defaults</option></term>
77 <para>Create default contents from an existing Koha site.</para>
82 <term><option>koha-upgrade-schema</option></term>
84 <para>Upgrade the DB schema for Koha instances. Done automatically on package upgrades.</para>
89 <term><option>koha-reset-passwd</option></term>
91 <para>Reset password for a user in a Koha instance.</para>
96 <term><option>koha-mysql</option></term>
98 <para>Provide an interactive mysql shell set up for the specified koha instance.</para>
104 <refsect2><title>Zebra-related</title>
108 <term><option>koha-start-zebra</option></term>
110 <para>Start Zebra for named Koha instances.</para>
115 <term><option>koha-restart-zebra</option></term>
117 <para>Restart Zebra for named Koha instances.</para>
122 <term><option>koha-rebuild-zebra</option></term>
124 <para>Rebuild the Zebra database for a Koha instance.</para>
129 <term><option>koha-stop-zebra</option></term>
131 <para>Stop Zebra for named Koha instances.</para>
137 <refsect2><title>E-mail</title>
141 <term><option>koha-email-enable</option></term>
143 <para>Turn on the email for a Koha instance.</para>
148 <term><option>koha-email-disable</option></term>
150 <para>Turn off the email for a Koha instance.</para>
156 <refsect2><title>Misc</title>
160 <term><option>koha-upgrade-to-3.4</option></term>
162 <para>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.</para>
168 <refsect2><title>Utilities</title>
172 <term><option>koha-create-dirs</option></term>
174 <para>Create dirs for a Koha instance.</para>
179 <term><option>koha-list</option></term>
181 <para>Lists Koha instances, optionally only those that are enabled or have email turned on.</para>
186 <term><option>koha-foreach</option></term>
188 <para>Run a command for each Koha instance. Takes the same arguments as koha-list.</para>
195 <refsect1><title>Bugs</title>
196 <para>The scripts are a bit fragile. If something goes wrong, they do not clean up after themselves.</para>
197 <para>Bugs can be reported here: <uri>http://bugs.koha-community.org/bugzilla3/</uri></para>
200 <refsect1><title>About Koha</title>
201 <para>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.</para>