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>--use-memcached</option></arg>
  33       <arg><option>--memcached-servers</option> server:port</arg>
  34       <arg><option>--memcached-prefix</option> namespace_prefix</arg>
  35       <arg><option>--defaultsql</option> /path/to/some.sql</arg>
  36       <arg><option>--configfile</option> /path/to/config</arg>
  37       <arg><option>--passwdfile</option> /path/to/passwd</arg>
  38       <arg><option>--database</option> database</arg>
  39       <arg><option>--adminuser</option> n</arg>
  40       <arg><option>--help</option>|<option>-h</option></arg>
  41
  42       <arg choice="req" rep="norepeat"><replaceable>instancename</replaceable></arg>
  43     </cmdsynopsis>
  44   </refsynopsisdiv>
  45
  46   <refsect1><title>Options</title>
  47   <variablelist>
  48
  49     <varlistentry>
  50       <term><option>--create-db</option></term>
  51       <listitem>
  52         <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>
  53       </listitem>
  54     </varlistentry>
  55
  56     <varlistentry>
  57       <term><option>--request-db</option></term>
  58       <listitem>
  59         <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>
  60       </listitem>
  61     </varlistentry>
  62
  63     <varlistentry>
  64       <term><option>--populate-db</option></term>
  65       <listitem>
  66         <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>
  67       </listitem>
  68     </varlistentry>
  69
  70     <varlistentry>
  71       <term><option>--use-db</option></term>
  72       <listitem>
  73         <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>
  74       </listitem>
  75     </varlistentry>
  76
  77     <varlistentry>
  78       <term><option>--configfile</option></term>
  79       <listitem>
  80         <para>Path to an alternative config file. This file can hold the same variables as the default config file, see below for details.</para>
  81       </listitem>
  82     </varlistentry>
  83
  84     <varlistentry>
  85       <term><option>--database</option></term>
  86       <listitem>
  87         <para>MySQL database to use.</para>
  88       </listitem>
  89     </varlistentry>
  90
  91     <varlistentry>
  92       <term><option>--defaultsql</option></term>
  93       <listitem>
  94         <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>
  95       </listitem>
  96     </varlistentry>
  97
  98     <varlistentry>
  99       <term><option>--marcflavor</option></term>
 100       <listitem>
 101         <para>Specifies format of MARC records to be indexed by Zebra. Corresponds to the ZEBRA_MARC_FORMAT config file variable.</para>
 102       </listitem>
 103     </varlistentry>
 104
 105     <varlistentry>
 106       <term><option>--passwdfile</option></term>
 107       <listitem>
 108         <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>
 109       </listitem>
 110     </varlistentry>
 111
 112     <varlistentry>
 113       <term><option>--zebralang</option></term>
 114       <listitem>
 115         <para>Primary language for Zebra indexing. Corresponds to the ZEBRA_LANGUAGE config file variable.</para>
 116       </listitem>
 117     </varlistentry>
 118
 119     <varlistentry>
 120       <term><option>--auth-idx</option></term>
 121       <listitem>
 122         <para>Specified the desired indexing mode for authority records. Valid options are <option>dom</option> (default) and <option>grs1</option>.</para>
 123       </listitem>
 124     </varlistentry>
 125
 126     <varlistentry>
 127       <term><option>--biblio-idx</option></term>
 128       <listitem>
 129         <para>Specified the desired indexing mode for bibliographic records. Valid options are <option>dom</option> (default) and <option>grs1</option>.</para>
 130       </listitem>
 131     </varlistentry>
 132
 133     <varlistentry>
 134       <term><option>--use-memcached</option></term>
 135       <listitem>
 136         <para>Make the Koha instance use memcached. <option>Disabled by default</option>.</para>
 137       </listitem>
 138     </varlistentry>
 139
 140     <varlistentry>
 141       <term><option>--memcached-servers</option></term>
 142       <listitem>
 143         <para>Specify a comma-separated list of host:port memcached servers for using with the created Koha instance. Defaults to <option>127.0.0.1:11211</option>, the needed configuration for a locally installed memcached server.</para>
 144       </listitem>
 145     </varlistentry>
 146
 147     <varlistentry>
 148       <term><option>--memcached-prefix</option></term>
 149       <listitem>
 150         <para>Specifiy a <option>namespace prefix</option> for memcached. You usually leave this option alone to avoid namespace collisions. It defaults to <option>koha_</option>.</para>
 151       </listitem>
 152     </varlistentry>
 153
 154     <varlistentry>
 155       <term><option>--help</option>,<option>-h</option></term>
 156       <listitem>
 157         <para>Print usage information.</para>
 158       </listitem>
 159     </varlistentry>
 160
 161
 162   </variablelist>
 163   </refsect1>
 164
 165   <refsect1><title>Description</title>
 166     <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>
 167     <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>
 168     <para>The Unix user has logins disabled.  The password for MySQL is generated randomly, and printed to the terminal.</para>
 169     <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>
 170     <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>
 171     <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>
 172
 173     <variablelist>
 174
 175       <varlistentry>
 176         <term><option>DOMAIN</option></term>
 177         <listitem>
 178           <para>The domain to append to the instance name, for Apache ServerName. Default is empty. The value must begin with a period.</para>
 179         </listitem>
 180       </varlistentry>
 181
 182       <varlistentry>
 183         <term><option>OPACPORT</option></term>
 184         <listitem>
 185           <para>The port for the OPAC.</para>
 186         </listitem>
 187       </varlistentry>
 188
 189       <varlistentry>
 190         <term><option>OPACPREFIX</option></term>
 191         <listitem>
 192           <para>This is inserted before the instance name  when  forming  Apache ServerName.  For subdomains, make sure it ends with a period.</para>
 193         </listitem>
 194       </varlistentry>
 195
 196       <varlistentry>
 197         <term><option>OPACSUFFIX</option></term>
 198         <listitem>
 199           <para>This  is inserted after the instance name, but before the domain name, when forming Apache ServerName.</para>
 200         </listitem>
 201       </varlistentry>
 202
 203       <varlistentry>
 204         <term><option>INTRAPORT</option></term>
 205         <listitem>
 206           <para>The port for the intranet.  If you set this to empty or 80, then you must also define INTRAPREFIX or INTRASUFFIX.</para>
 207         </listitem>
 208       </varlistentry>
 209
 210       <varlistentry>
 211         <term><option>INTRAPREFIX</option></term>
 212         <listitem>
 213           <para>This is inserted before the instance name  when  forming  Apache ServerName.  For subdomains, make sure it ends with a period.</para>
 214         </listitem>
 215       </varlistentry>
 216
 217       <varlistentry>
 218         <term><option>INTRASUFFIX</option></term>
 219         <listitem>
 220           <para>This  is inserted after the instance name, but before the domain name, when forming Apache ServerName.</para>
 221         </listitem>
 222       </varlistentry>
 223
 224       <varlistentry>
 225         <term><option>DEFAULTSQL</option></term>
 226         <listitem>
 227           <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>
 228         </listitem>
 229       </varlistentry>
 230
 231       <varlistentry>
 232         <term><option>USE_MEMCACHED</option></term>
 233         <listitem>
 234           <para>Valid values are <option>yes</option> and <option>no</option>. If not present koha-create will default to <option>no</option>. Also, this will be overriden by the <option>--use-memcached</option> switch.</para>
 235         </listitem>
 236       </varlistentry>
 237
 238       <varlistentry>
 239         <term><option>MEMCACHED_SERVERS</option></term>
 240         <listitem>
 241           <para>A comma-separated list of valid memcached servers. Usually in the form of <option>host:port</option>. If not present koha-create will default to <option>127.0.0.1:11211</option>. Also, this will be overriden by the arguments of the <option>--memcached-servers</option> switch.</para>
 242         </listitem>
 243       </varlistentry>
 244
 245       <varlistentry>
 246         <term><option>MEMCACHED_PREFIX</option></term>
 247         <listitem>
 248           <para>A prefix for all new Koha instances to use in memcached. If not present koha-create will default to <option>koha_</option>. Also, this will be overriden by the arguments of the <option>--memcached-prefix</option> switch.</para>
 249         </listitem>
 250       </varlistentry>
 251
 252
 253       <varlistentry>
 254         <term><option>ZEBRA_MARC_FORMAT</option></term>
 255         <listitem>
 256           <para>Specifies format of MARC records to be indexed by Zebra.  Possible values are 'marc21', 'normarc' and 'unimarc'.</para>
 257         </listitem>
 258       </varlistentry>
 259
 260       <varlistentry>
 261         <term><option>ZEBRA_LANGUAGE</option></term>
 262         <listitem>
 263           <para>Primary  language  for Zebra indexing. Possible values are 'en', 'es', 'fr', 'nb', 'ru' and 'uk'.</para>
 264         </listitem>
 265       </varlistentry>
 266
 267     </variablelist>
 268
 269     <para>Order of precedence for config options, from lowest to highest:</para>
 270
 271     <orderedlist>
 272       <listitem><para>The defaults set in the code of <command>koha-create</command></para></listitem>
 273       <listitem><para><filename>/etc/koha/koha-sites.conf</filename></para></listitem>
 274       <listitem><para>Config file specified with <option>--configfile</option></para></listitem>
 275       <listitem><para>Individual command line options</para></listitem>
 276     </orderedlist>
 277
 278   </refsect1>
 279
 280   <refsect1><title>Files</title>
 281   <variablelist>
 282     <varlistentry>
 283       <term><option><filename>/etc/koha/koha-sites.conf</filename></option></term>
 284       <listitem>
 285         <para>Configuration variables are read from this file, if it exists.</para>
 286       </listitem>
 287     </varlistentry>
 288
 289     <varlistentry>
 290       <term><option><filename>/etc/koha/passwd</filename></option></term>
 291       <listitem>
 292         <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>
 293       </listitem>
 294     </varlistentry>
 295   </variablelist>
 296   </refsect1>
 297
 298   <refsect1><title>Bugs</title>
 299   <para>The program is a bit fragile. If something goes wrong, it does not clean up after itself.</para>
 300   <para>Bugs can be reported here: <uri>http://bugs.koha-community.org/bugzilla3/</uri></para>
 301   </refsect1>
 302
 303   <refsect1><title>Example</title>
 304
 305     <para>To create a new Koha instance:</para>
 306
 307     <para><command>koha-create --create-db hslibrary</command></para>
 308
 309     <para>The public catalog is now at <uri>http://hslibrary/</uri> and the librarian interface at <uri>http://hslibrary:8080/</uri>.</para>
 310
 311     <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>
 312
 313     <itemizedlist spacing="compact">
 314       <listitem><para>DOMAIN=".example.com"</para></listitem>
 315       <listitem><para>INTRAPORT=""</para></listitem>
 316       <listitem><para>INTRASUFFIX="-intra"</para></listitem>
 317     </itemizedlist>
 318
 319     <para>This will result in the addresses for the public and intranet interfaces becoming these:</para>
 320
 321     <itemizedlist spacing="compact">
 322       <listitem><para><uri>http://hslibrary.example.com/</uri></para></listitem>
 323       <listitem><para><uri>http://hslibrary-intra.example.com/</uri></para></listitem>
 324     </itemizedlist>
 325     <para>Configuration changes only apply to instances created afterwards.</para>
 326
 327   </refsect1>
 328
 329   <refsect1><title>See also</title>
 330
 331   <simplelist type="inline">
 332     <member><command>koha-remove(8)</command></member>
 333   </simplelist>
 334
 335   </refsect1>
 336
 337 </refentry>
 338
 339 </article>