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