debian/docs/koha-common.xml

   1 <article xmlns='http://docbook.org/ns/docbook'>
   2 <title>koha-common</title>
   3 <info>
   4 <productname>Koha</productname> is the first free software library automation package.
   5 <author>
   6   <orgname>The Koha Community</orgname>
   7   <uri>http://koha-community.org/</uri>
   8 </author>
   9 </info>
  10
  11 <refentry xml:id="koha-common">
  12
  13   <refmeta>
  14     <refentrytitle>koha-common</refentrytitle>
  15     <manvolnum>8</manvolnum>
  16   </refmeta>
  17
  18   <refnamediv>
  19     <refname>koha-common</refname>
  20     <refpurpose>Create and manage Koha instances.</refpurpose>
  21     <refclass>UNIX/Linux</refclass>
  22   </refnamediv>
  23
  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>
  26   </refsect1>
  27
  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>
  30
  31     <refsect2><title>Administer instances</title>
  32     <variablelist>
  33
  34       <varlistentry>
  35         <term><option>koha-create</option></term>
  36         <listitem>
  37           <para>Create new Koha instances.</para>
  38         </listitem>
  39       </varlistentry>
  40
  41       <varlistentry>
  42         <term><option>koha-disable</option></term>
  43         <listitem>
  44           <para>Disable a Koha instance.</para>
  45         </listitem>
  46       </varlistentry>
  47
  48       <varlistentry>
  49         <term><option>koha-enable</option></term>
  50         <listitem>
  51           <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>
  52         </listitem>
  53       </varlistentry>
  54
  55       <varlistentry>
  56         <term><option>koha-restore</option></term>
  57         <listitem>
  58           <para>Restore a Koha site from a dump (from koha-dump).</para>
  59         </listitem>
  60       </varlistentry>
  61
  62       <varlistentry>
  63         <term><option>koha-dump</option></term>
  64         <listitem>
  65           <para>Dump all contents and configs for a Koha site.</para>
  66         </listitem>
  67       </varlistentry>
  68
  69       <varlistentry>
  70         <term><option>koha-run-backups</option></term>
  71         <listitem>
  72           <para>Performs backups of the koha installations on the system, except an instance called 'demo'.</para>
  73         </listitem>
  74       </varlistentry>
  75
  76       <varlistentry>
  77         <term><option>koha-remove</option></term>
  78         <listitem>
  79           <para>Remove a Koha instance.</para>
  80         </listitem>
  81       </varlistentry>
  82     </variablelist>
  83     </refsect2>
  84
  85     <refsect2><title>Database-related</title>
  86     <variablelist>
  87
  88       <varlistentry>
  89         <term><option>koha-dump-defaults</option></term>
  90         <listitem>
  91           <para>Create default contents from an existing Koha site.</para>
  92         </listitem>
  93       </varlistentry>
  94
  95       <varlistentry>
  96         <term><option>koha-upgrade-schema</option></term>
  97         <listitem>
  98           <para>Upgrade the DB schema for Koha instances. Done automatically on package upgrades.</para>
  99         </listitem>
 100       </varlistentry>
 101
 102       <varlistentry>
 103         <term><option>koha-reset-passwd</option></term>
 104         <listitem>
 105           <para>Reset password for a user in a Koha instance.</para>
 106         </listitem>
 107       </varlistentry>
 108
 109       <varlistentry>
 110         <term><option>koha-mysql</option></term>
 111         <listitem>
 112           <para>Provide an interactive mysql shell set up for the specified koha instance.</para>
 113         </listitem>
 114       </varlistentry>
 115     </variablelist>
 116     </refsect2>
 117
 118     <refsect2><title>Zebra-related</title>
 119     <variablelist>
 120
 121       <varlistentry>
 122         <term><option>koha-start-zebra</option></term>
 123         <listitem>
 124           <para>Start Zebra for named Koha instances.</para>
 125         </listitem>
 126       </varlistentry>
 127
 128       <varlistentry>
 129         <term><option>koha-restart-zebra</option></term>
 130         <listitem>
 131           <para>Restart Zebra for named Koha instances.</para>
 132         </listitem>
 133       </varlistentry>
 134
 135       <varlistentry>
 136         <term><option>koha-rebuild-zebra</option></term>
 137         <listitem>
 138           <para>Rebuild the Zebra database for a Koha instance.</para>
 139         </listitem>
 140       </varlistentry>
 141
 142       <varlistentry>
 143         <term><option>koha-stop-zebra</option></term>
 144         <listitem>
 145           <para>Stop Zebra for named Koha instances.</para>
 146         </listitem>
 147       </varlistentry>
 148
 149       <varlistentry>
 150         <term><option>koha-indexer</option></term>
 151         <listitem>
 152           <para>Manage the indexer daemon for named Koha instances.</para>
 153         </listitem>
 154       </varlistentry>
 155     </variablelist>
 156     </refsect2>
 157
 158     <refsect2>
 159       <title>Elasticsearch-related</title>
 160         <variablelist>
 161           <varlistentry>
 162             <term><option>koha-elasticsearch</option></term>
 163             <listitem>
 164               <para>Manage Elasticsearch-related tasks for Koha instances.</para>
 165             </listitem>
 166           </varlistentry>
 167         </variablelist>
 168     </refsect2>
 169
 170     <refsect2><title>E-mail</title>
 171     <variablelist>
 172
 173       <varlistentry>
 174         <term><option>koha-email-enable</option></term>
 175         <listitem>
 176           <para>Turn on the email for a Koha instance.</para>
 177         </listitem>
 178       </varlistentry>
 179
 180       <varlistentry>
 181         <term><option>koha-email-disable</option></term>
 182         <listitem>
 183           <para>Turn off the email for a Koha instance.</para>
 184         </listitem>
 185       </varlistentry>
 186     </variablelist>
 187     </refsect2>
 188
 189     <refsect2><title>SIP2-related</title>
 190     <variablelist>
 191
 192       <varlistentry>
 193         <term><option>koha-enable-sip</option></term>
 194         <listitem>
 195           <para>Copies the SIP configuration file to allow SIP to be controlled by init scripts.</para>
 196         </listitem>
 197       </varlistentry>
 198
 199       <varlistentry>
 200         <term><option>koha-start-sip</option></term>
 201         <listitem>
 202           <para>Starts the SIP daemon for the specified Koha instances.</para>
 203         </listitem>
 204       </varlistentry>
 205
 206       <varlistentry>
 207         <term><option>koha-stop-sip</option></term>
 208         <listitem>
 209           <para>Stops the SIP daemon for the specified Koha instances.</para>
 210         </listitem>
 211       </varlistentry>
 212     </variablelist>
 213     </refsect2>
 214
 215     <refsect2><title>Misc</title>
 216     <variablelist>
 217
 218       <varlistentry>
 219         <term><option>koha-upgrade-to-3.4</option></term>
 220         <listitem>
 221           <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>
 222         </listitem>
 223       </varlistentry>
 224     </variablelist>
 225     </refsect2>
 226
 227     <refsect2><title>Utilities</title>
 228     <variablelist>
 229
 230       <varlistentry>
 231         <term><option>koha-create-dirs</option></term>
 232         <listitem>
 233           <para>Create dirs for a Koha instance.</para>
 234         </listitem>
 235       </varlistentry>
 236
 237       <varlistentry>
 238         <term><option>koha-list</option></term>
 239         <listitem>
 240           <para>Lists Koha instances, optionally only those that are enabled or have email turned on.</para>
 241         </listitem>
 242       </varlistentry>
 243
 244       <varlistentry>
 245         <term><option>koha-foreach</option></term>
 246         <listitem>
 247           <para>Run a command for each Koha instance. Takes the same arguments as koha-list.</para>
 248         </listitem>
 249       </varlistentry>
 250
 251       <varlistentry>
 252         <term><option>koha-shell</option></term>
 253         <listitem>
 254           <para>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.</para>
 255         </listitem>
 256       </varlistentry>
 257     </variablelist>
 258     </refsect2>
 259   </refsect1>
 260
 261
 262   <refsect1><title>Bugs</title>
 263   <para>The scripts are a bit fragile. If something goes wrong, they do not clean up after themselves.</para>
 264   <para>Bugs can be reported here: <uri>http://bugs.koha-community.org/bugzilla3/</uri></para>
 265   </refsect1>
 266
 267   <refsect1><title>About Koha</title>
 268   <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>
 269   </refsect1>
 270
 271 </refentry>
 272
 273 </article>