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