debian/docs/koha-create.xml

   1 <article xmlns='http://docbook.org/ns/docbook'>
   2 <title>koha-create</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-create">
  12
  13   <refmeta>
  14     <refentrytitle>koha-create</refentrytitle>
  15     <manvolnum>8</manvolnum>
  16   </refmeta>
  17
  18   <refnamediv>
  19     <refname>koha-create</refname>
  20     <refpurpose>Create a new Koha instance.</refpurpose>
  21     <refclass>UNIX/Linux</refclass>
  22   </refnamediv>
  23
  24   <refsynopsisdiv>
  25     <cmdsynopsis>
  26       <command>koha-create</command>
  27       <arg choice="req"><option>--create-db</option>|<option>--request-db</option>|<option>--populate-db</option>|<option>--use-db</option></arg>
  28       <arg><option>--marcflavor</option> marc21|normarc|unimarc</arg>
  29       <arg><option>--zebralang</option> en|es|fr|nb|ru|uk</arg>
  30       <arg><option>--auth-idx</option> dom|grs1</arg>
  31       <arg><option>--biblio-idx</option> dom|grs1</arg>
  32       <arg><option>--defaultsql</option> /path/to/some.sql</arg>
  33       <arg><option>--configfile</option> /path/to/config</arg>
  34       <arg><option>--passwdfile</option> /path/to/passwd</arg>
  35       <arg><option>--database</option> database</arg>
  36       <arg><option>--adminuser</option> n</arg>
  37       <arg choice="req" rep="norepeat"><replaceable>instancename</replaceable></arg>
  38     </cmdsynopsis>
  39   </refsynopsisdiv>
  40
  41   <refsect1><title>Options</title>
  42   <variablelist>
  43
  44     <varlistentry>
  45       <term><option>--create-db</option></term>
  46       <listitem>
  47         <para>Create a new database on localhost. If the database you want to use does not reside on localhost, you can use <option>--request-db</option> and <option>--populate-db</option>, see below. If the database already exists, you can use <option>--use-db</option>, see below.</para>
  48       </listitem>
  49     </varlistentry>
  50
  51     <varlistentry>
  52       <term><option>--request-db</option></term>
  53       <listitem>
  54         <para>This  option will create a file called <filename>instancename-db-request.txt</filename> in your current directory that contains information about how the database needs to be set up.</para>
  55       </listitem>
  56     </varlistentry>
  57
  58     <varlistentry>
  59       <term><option>--populate-db</option></term>
  60       <listitem>
  61         <para>When you have run koha-create with the <option>--request-db</option> option, and a database has been set up, you can finish your installation by running <command>koha-create</command> with this option.</para>
  62       </listitem>
  63     </varlistentry>
  64
  65     <varlistentry>
  66       <term><option>--use-db</option></term>
  67       <listitem>
  68         <para>When the database you want to use has already been populated, you can run <command>koha-create</command> with this option to take care of all the other set-up configuration.</para>
  69       </listitem>
  70     </varlistentry>
  71
  72     <varlistentry>
  73       <term><option>--configfile</option></term>
  74       <listitem>
  75         <para>Path to an alternative config file. This file can hold the same variables as the default config file, see below for details.</para>
  76       </listitem>
  77     </varlistentry>
  78
  79     <varlistentry>
  80       <term><option>--database</option></term>
  81       <listitem>
  82         <para>MySQL database to use.</para>
  83       </listitem>
  84     </varlistentry>
  85
  86     <varlistentry>
  87       <term><option>--defaultsql</option></term>
  88       <listitem>
  89         <para>Path to an SQL-file other than the one pointed to in the default or alternative config file. Corresponds to the DEFAULTSQL config file variable.</para>
  90       </listitem>
  91     </varlistentry>
  92
  93     <varlistentry>
  94       <term><option>--marcflavor</option></term>
  95       <listitem>
  96         <para>Specifies format of MARC records to be indexed by Zebra. Corresponds to the ZEBRA_MARC_FORMAT config file variable.</para>
  97       </listitem>
  98     </varlistentry>
  99
 100     <varlistentry>
 101       <term><option>--passwdfile</option></term>
 102       <listitem>
 103         <para>Path to an alternative passwd file. This file is in the same format as the default (Koha) passwd file, see below for details.</para>
 104       </listitem>
 105     </varlistentry>
 106
 107     <varlistentry>
 108       <term><option>--zebralang</option></term>
 109       <listitem>
 110         <para>Primary language for Zebra indexing. Corresponds to the ZEBRA_LANGUAGE config file variable.</para>
 111       </listitem>
 112     </varlistentry>
 113
 114     <varlistentry>
 115       <term><option>--auth-idx</option></term>
 116       <listitem>
 117         <para>Specified the desired indexing mode for authority records. Valid options are <option>dom</option> (default) and <option>grs1</option>.</para>
 118       </listitem>
 119     </varlistentry>
 120
 121     <varlistentry>
 122       <term><option>--biblio-idx</option></term>
 123       <listitem>
 124         <para>Specified the desired indexing mode for bibliographic records. Valid options are <option>dom</option> (default) and <option>grs1</option>.</para>
 125       </listitem>
 126     </varlistentry>
 127
 128   </variablelist>
 129   </refsect1>
 130
 131   <refsect1><title>Description</title>
 132     <para><command>koha-create</command>  creates  a new Koha instance.  It is meant for a site that provides Koha hosting, and serves several sites from the same host.</para>
 133     <para>The name of the instance is used as the domain name  for  Apache,  Unix user and group names, and MySQL username and database names are derived from it.  Unix user and group are named instance-koha. MySQL username is koha_instance, and database is koha_instance.</para>
 134     <para>The Unix user has logins disabled.  The password for MySQL is generated randomly, and printed to the terminal.</para>
 135     <para>The instance name is used as the domain name (ServerName)  for  Apache. The public catalogue (OPAC), for library customers, is on port 80.  The staff client interface is configured similarly, depending on the settings in <filename>/etc/koha/koha-sites.conf</filename> or alternate config file.</para>
 136     <para>After  the  Koha  instance  is created, it is ready to be used, but the librarian needs to log in via the intranet and configure things.</para>
 137     <para>Several configuration variables are available for adjusting this behavior. The variables are put into <filename>/etc/koha/koha-sites.conf</filename>. The following variables are obeyed:</para>
 138
 139     <variablelist>
 140
 141       <varlistentry>
 142         <term><option>DOMAIN</option></term>
 143         <listitem>
 144           <para>The domain to append to the instance name, for Apache ServerName. Default is empty. The value must begin with a period.</para>
 145         </listitem>
 146       </varlistentry>
 147
 148       <varlistentry>
 149         <term><option>OPACPORT</option></term>
 150         <listitem>
 151           <para>The port for the OPAC.</para>
 152         </listitem>
 153       </varlistentry>
 154
 155       <varlistentry>
 156         <term><option>OPACPREFIX</option></term>
 157         <listitem>
 158           <para>This is inserted before the instance name  when  forming  Apache ServerName.  For subdomains, make sure it ends with a period.</para>
 159         </listitem>
 160       </varlistentry>
 161
 162       <varlistentry>
 163         <term><option>OPACSUFFIX</option></term>
 164         <listitem>
 165           <para>This  is inserted after the instance name, but before the domain name, when forming Apache ServerName.</para>
 166         </listitem>
 167       </varlistentry>
 168
 169       <varlistentry>
 170         <term><option>INTRAPORT</option></term>
 171         <listitem>
 172           <para>The port for the intranet.  If you set this to empty or 80, then you must also define INTRAPREFIX or INTRASUFFIX.</para>
 173         </listitem>
 174       </varlistentry>
 175
 176       <varlistentry>
 177         <term><option>INTRAPREFIX</option></term>
 178         <listitem>
 179           <para>This is inserted before the instance name  when  forming  Apache ServerName.  For subdomains, make sure it ends with a period.</para>
 180         </listitem>
 181       </varlistentry>
 182
 183       <varlistentry>
 184         <term><option>INTRASUFFIX</option></term>
 185         <listitem>
 186           <para>This  is inserted after the instance name, but before the domain name, when forming Apache ServerName.</para>
 187         </listitem>
 188       </varlistentry>
 189
 190       <varlistentry>
 191         <term><option>DEFAULTSQL</option></term>
 192         <listitem>
 193           <para>An SQL file (compressed with gzip) that can be fed  to  mysql(1) to  initialize the database after it has been created.  Might be created using koha-dump-defaults(8).</para>
 194         </listitem>
 195       </varlistentry>
 196
 197       <varlistentry>
 198         <term><option>ZEBRA_MARC_FORMAT</option></term>
 199         <listitem>
 200           <para>Specifies format of MARC records to be indexed by Zebra.  Possible values are 'marc21', 'normarc' and 'unimarc'.</para>
 201         </listitem>
 202       </varlistentry>
 203
 204       <varlistentry>
 205         <term><option>ZEBRA_LANGUAGE</option></term>
 206         <listitem>
 207           <para>Primary  language  for Zebra indexing. Possible values are 'en', 'fr' and 'nb'.</para>
 208         </listitem>
 209       </varlistentry>
 210
 211     </variablelist>
 212
 213     <para>Order of precedence for config options, from lowest to highest:</para>
 214
 215     <orderedlist>
 216       <listitem><para>The defaults set in the code of <command>koha-create</command></para></listitem>
 217       <listitem><para><filename>/etc/koha/koha-sites.conf</filename></para></listitem>
 218       <listitem><para>Config file specified with <option>--configfile</option></para></listitem>
 219       <listitem><para>Individual command line options</para></listitem>
 220     </orderedlist>
 221
 222   </refsect1>
 223
 224   <refsect1><title>Files</title>
 225   <variablelist>
 226     <varlistentry>
 227       <term><option><filename>/etc/koha/koha-sites.conf</filename></option></term>
 228       <listitem>
 229         <para>Configuration variables are read from this file, if it exists.</para>
 230       </listitem>
 231     </varlistentry>
 232
 233     <varlistentry>
 234       <term><option><filename>/etc/koha/passwd</filename></option></term>
 235       <listitem>
 236         <para>Pre-selected database credentials are read from this file, if it exists. The format for this file is instancename:username:passwd:database. Database is optional, but the other three are required if you want to use pre-determined database user credentials.</para>
 237       </listitem>
 238     </varlistentry>
 239   </variablelist>
 240   </refsect1>
 241
 242   <refsect1><title>Bugs</title>
 243   <para>The program is a bit fragile. If something goes wrong, it does not clean up after itself.</para>
 244   <para>Bugs can be reported here: <uri>http://bugs.koha-community.org/bugzilla3/</uri></para>
 245   </refsect1>
 246
 247   <refsect1><title>Example</title>
 248
 249     <para>To create a new Koha instance:</para>
 250
 251     <para><command>koha-create --create-db hslibrary</command></para>
 252
 253     <para>The public catalog is now at <uri>http://hslibrary/</uri> and the librarian interface at <uri>http://hslibrary:8080/</uri>.</para>
 254
 255     <para>To use full domain names, and have the intranet interface on port  80, but on a different domain name, add the following variables to the configuration file:</para>
 256
 257     <itemizedlist spacing="compact">
 258       <listitem><para>DOMAIN=".example.com"</para></listitem>
 259       <listitem><para>INTRAPORT=""</para></listitem>
 260       <listitem><para>INTRASUFFIX="-intra"</para></listitem>
 261     </itemizedlist>
 262
 263     <para>This will result in the addresses for the public and intranet interfaces becoming these:</para>
 264
 265     <itemizedlist spacing="compact">
 266       <listitem><para><uri>http://hslibrary.example.com/</uri></para></listitem>
 267       <listitem><para><uri>http://hslibrary-intra.example.com/</uri></para></listitem>
 268     </itemizedlist>
 269     <para>Configuration changes only apply to instances created afterwards.</para>
 270
 271   </refsect1>
 272
 273   <refsect1><title>See also</title>
 274
 275   <simplelist type="inline">
 276     <member><command>koha-remove(8)</command></member>
 277   </simplelist>
 278
 279   </refsect1>
 280
 281 </refentry>
 282
 283 </article>