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-zebra</option></term>
 123         <listitem>
 124           <para>Manage the Zebra daemon for named Koha instances.</para>
 125         </listitem>
 126       </varlistentry>
 127
 128       <varlistentry>
 129         <term><option>koha-rebuild-zebra</option></term>
 130         <listitem>
 131           <para>Rebuild the Zebra database for a Koha instance.</para>
 132         </listitem>
 133       </varlistentry>
 134
 135       <varlistentry>
 136         <term><option>koha-indexer</option></term>
 137         <listitem>
 138           <para>Manage the indexer daemon for named Koha instances.</para>
 139         </listitem>
 140       </varlistentry>
 141     </variablelist>
 142     </refsect2>
 143
 144     <refsect2>
 145       <title>Elasticsearch-related</title>
 146         <variablelist>
 147           <varlistentry>
 148             <term><option>koha-elasticsearch</option></term>
 149             <listitem>
 150               <para>Manage Elasticsearch-related tasks for Koha instances.</para>
 151             </listitem>
 152           </varlistentry>
 153         </variablelist>
 154     </refsect2>
 155
 156     <refsect2><title>E-mail</title>
 157     <variablelist>
 158
 159       <varlistentry>
 160         <term><option>koha-email-enable</option></term>
 161         <listitem>
 162           <para>Turn on the email for a Koha instance.</para>
 163         </listitem>
 164       </varlistentry>
 165
 166       <varlistentry>
 167         <term><option>koha-email-disable</option></term>
 168         <listitem>
 169           <para>Turn off the email for a Koha instance.</para>
 170         </listitem>
 171       </varlistentry>
 172     </variablelist>
 173     </refsect2>
 174
 175     <refsect2><title>SIP2-related</title>
 176     <variablelist>
 177       <varlistentry>
 178         <term><option>koha-sip</option></term>
 179         <listitem>
 180           <para>Manage the SIP server for named Koha instances.</para>
 181         </listitem>
 182       </varlistentry>
 183
 184       <varlistentry>
 185         <term><option>koha-enable-sip</option></term>
 186         <listitem>
 187           <para>Copies the SIP configuration file to allow SIP to be controlled by init scripts.</para>
 188         </listitem>
 189       </varlistentry>
 190
 191       <varlistentry>
 192         <term><option>koha-start-sip</option></term>
 193         <listitem>
 194           <para>Starts the SIP daemon for the specified Koha instances.</para>
 195         </listitem>
 196       </varlistentry>
 197
 198       <varlistentry>
 199         <term><option>koha-stop-sip</option></term>
 200         <listitem>
 201           <para>Stops the SIP daemon for the specified Koha instances.</para>
 202         </listitem>
 203       </varlistentry>
 204     </variablelist>
 205     </refsect2>
 206
 207     <refsect2><title>Misc</title>
 208     <variablelist>
 209
 210       <varlistentry>
 211         <term><option>koha-upgrade-to-3.4</option></term>
 212         <listitem>
 213           <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>
 214         </listitem>
 215       </varlistentry>
 216     </variablelist>
 217     </refsect2>
 218
 219     <refsect2><title>Utilities</title>
 220     <variablelist>
 221
 222       <varlistentry>
 223         <term><option>koha-create-dirs</option></term>
 224         <listitem>
 225           <para>Create dirs for a Koha instance.</para>
 226         </listitem>
 227       </varlistentry>
 228
 229       <varlistentry>
 230         <term><option>koha-list</option></term>
 231         <listitem>
 232           <para>Lists Koha instances, optionally only those that are enabled or have email turned on.</para>
 233         </listitem>
 234       </varlistentry>
 235
 236       <varlistentry>
 237         <term><option>koha-foreach</option></term>
 238         <listitem>
 239           <para>Run a command for each Koha instance. Takes the same arguments as koha-list.</para>
 240         </listitem>
 241       </varlistentry>
 242
 243       <varlistentry>
 244         <term><option>koha-shell</option></term>
 245         <listitem>
 246           <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>
 247         </listitem>
 248       </varlistentry>
 249     </variablelist>
 250     </refsect2>
 251   </refsect1>
 252
 253
 254   <refsect1><title>Bugs</title>
 255   <para>The scripts are a bit fragile. If something goes wrong, they do not clean up after themselves.</para>
 256   <para>Bugs can be reported here: <uri>http://bugs.koha-community.org/bugzilla3/</uri></para>
 257   </refsect1>
 258
 259   <refsect1><title>About Koha</title>
 260   <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>
 261   </refsect1>
 262
 263 </refentry>
 264
 265 </article>