debian/scripts/koha-create.8

   1 .\" Copyright 2010  Catalyst IT, Ltd
   2 .\"
   3 .\" This program is free software: you can redistribute it and/or modify
   4 .\" it under the terms of the GNU General Public License as published by
   5 .\" the Free Software Foundation, either version 3 of the License, or
   6 .\" (at your option) any later version.
   7 .\"
   8 .\" This program is distributed in the hope that it will be useful,
   9 .\" but WITHOUT ANY WARRANTY; without even the implied warranty of
  10 .\" MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  11 .\" GNU General Public License for more details.
  12 .\"
  13 .\" You should have received a copy of the GNU General Public License
  14 .\" along with this program.  If not, see <http://www.gnu.org/licenses/>.
  15 .\===========================================================
  16 .TH KOHA-CREATE 8 "2011-08-28" "Koha"
  17 .\===========================================================
  18 .SH NAME
  19 koha-create \(em create a new Koha instance
  20 .\===========================================================
  21 .SH SYNOPSIS
  22 .B koha-create
  23 [
  24 .B \-\^\-create-db|--request-db|--populate-db
  25 ]
  26 .br
  27 [
  28 .B \-\^\-marcflavor \fImarc21|normarc|unimarc\fP
  29 ]
  30 .br
  31 [
  32 .B \-\^\-zebralang \fIen|nb|fr\fP
  33 ]
  34 [
  35 .B \-\^\-defaultsql \fIsql-file\fP
  36 ]
  37 .br
  38 [
  39 .B \-\^\-configfile \fIconfig-file\fP
  40 ]
  41 .IR instancename
  42 .\===========================================================
  43 .SH OPTIONS
  44 .TP \w'\fB\-\^\-populate-db\fP'u+3n
  45 .B \-\^\-create-db
  46 Create a new datbase on localhost. If the database you want to use does
  47 not reside on localhost, you can use --request-db and --populate-db, see below.
  48 .\----------------------------------------------------------------------------------------------------------------------
  49 .TP
  50 .B \-\^\-request-db
  51 This option will create a file called
  52 .IR instancename-db-request.txt
  53 in your current directory that contains information about
  54 how the database needs to be set up.
  55 .\----------------------------------------------------------------------------------------------------------------------
  56 .TP
  57 .B \-\^\-populate-db
  58 When you have run koha-create with the --request-db option, and a database
  59 has been set up, you can finnish your installation by running koha-create
  60 with this option.
  61 .\----------------------------------------------------------------------------------------------------------------------
  62 .TP
  63 .B \-\^\-configfile
  64 Path to an alternative config file. This file can hold the same variables as
  65 the default config file, see below for details.
  66 .\----------------------------------------------------------------------------------------------------------------------
  67 .TP
  68 .B \-\^\-defaultsql
  69 Path to an SQL-file other than the one pointed to in the default or alternative
  70 config file.  Corresponds to the DEFAULTSQL config file variable.
  71 .\----------------------------------------------------------------------------------------------------------------------
  72 .TP
  73 .B \-\^\-marcflavor
  74 Specifies format of MARC records to be indexed by Zebra. Corresponds to the
  75 ZEBRA_MARC_FORMAT config file variable.
  76 .\----------------------------------------------------------------------------------------------------------------------
  77 .TP
  78 .B \-\^\-zebralang
  79 Primary language for Zebra indexing. Corresponds to the ZEBRA_LANGUAGE
  80 config file variable.
  81 .\===========================================================
  82 .SH DESCRIPTION
  83 .B koha-create
  84 creates a new Koha instance.
  85 It is meant for a site that provides Koha hosting,
  86 and serves several sites from the same host.
  87 .PP
  88 The name of the instance is used as the domain name for Apache,
  89 Unix user and group names, and MySQL username and database names
  90 are derived from it.
  91 Unix user and group are named
  92 .IR instance -koha.
  93 MySQL username is
  94 .RI koha_ instance ,
  95 and database is
  96 .RI koha_ instance .
  97 .PP
  98 The Unix user has logins disabled.
  99 The password for MySQL is generated randomly, and printed to the terminal.
 100 .PP
 101 The instance name is used as the domain name (ServerName) for Apache.
 102 The public catalogue (OPAC), for library customers, is on port 80.
 103 The staff client interface is configured similarly, depending on the settings
 104 in
 105 .B /etc/koha/koha-site.conf
 106 or alternate config file.
 107 .PP
 108 After the Koha instance is created, it is ready to be used,
 109 but the librarian needs to log in via the intranet and configure things.
 110 .PP
 111 Several configuration variables are available for adjusting this behavior.
 112 The variables are put into
 113 .BR /etc/koha/koha-site.conf .
 114 The following variables are obeyed:
 115 .PP
 116 .\----------------------------------------------------------------------------------------------------------------------
 117 .TP
 118 .B DOMAIN
 119 The domain to append to the instance name, for Apache ServerName.
 120 Default is empty.
 121 The value must begin with a period.
 122 .\----------------------------------------------------------------------------------------------------------------------
 123 .TP
 124 .B INTRAPORT
 125 The port for the intranet.
 126 If you set this to empty or 80, then you
 127 .I must
 128 also define
 129 .B INTRAPREFIX
 130 or
 131 .BR INTRASUFFIX .
 132 .\----------------------------------------------------------------------------------------------------------------------
 133 .TP
 134 .B INTRAPREFIX
 135 This is inserted before the instance name when forming Apache ServerName.
 136 For subdomains, make sure it ends with a period.
 137 .\----------------------------------------------------------------------------------------------------------------------
 138 .TP
 139 .B INTRASUFFIX
 140 This is inserted after the instance name,
 141 but before the domain name,
 142 when forming Apache ServerName.
 143 .\----------------------------------------------------------------------------------------------------------------------
 144 .TP
 145 .B DEFAULTSQL
 146 An SQL file (compressed with gzip) that can be fed to
 147 .BR mysql (1)
 148 to initialize the database after it has been created.
 149 Might be created using
 150 .BR koha-dump-defaults (8).
 151 .\----------------------------------------------------------------------------------------------------------------------
 152 .TP
 153 .B ZEBRA_MARC_FORMAT
 154 Specifies format of MARC records to be indexed by Zebra. Possible values are 'marc21', 'normarc' and 'unimarc'.
 155 .\----------------------------------------------------------------------------------------------------------------------
 156 .TP
 157 .B ZEBRA_LANGUAGE
 158 Primary language for Zebra indexing. Possible values are 'en', 'fr' and 'nb'.
 159 .TP
 160 Order of precedence for config options, from lowest to highest:
 161 .RS
 162 .nf
 163 1. The defaults set in the code of koha-create
 164 2. /etc/koha/koha-sites.conf
 165 3. Config file specified with --configfile
 166 4. Individual command line options
 167 .fi
 168 .RE
 169 .\===========================================================
 170 .SH FILES
 171 .TP
 172 .B /etc/koha/koha-site.conf
 173 Configuration variables are read from this file, if it exists.
 174 .\===========================================================
 175 .SH BUGS
 176 .TP
 177 The program is a bit fragile. If something goes wrong, it does not clean up after itself.
 178 .TP
 179 Bugs can be reported here: http://bugs.koha-community.org/bugzilla3/
 180 .\===========================================================
 181 .SH EXAMPLE
 182 To create a new Koha instance:
 183 .PP
 184 .RS
 185 koha-create hslibrary
 186 .RE
 187 .PP
 188 The public catalog is now at
 189 .I http://hslibrary/
 190 and the librarian interface at
 191 .IR http://hslibrary:8080/ .
 192 .PP
 193 To use full domain names, and have the intranet interface on port 80, but
 194 on a different domain name, add the following variables to the
 195 configuration file:
 196 .PP
 197 .nf
 198 .RS
 199 DOMAIN=".example.com"
 200 INTRAPORT=""
 201 INTRASUFFIX="-intra"
 202 .RE
 203 .fi
 204 .PP
 205 This will result in the addresses for the public and intranet interfaces
 206 becoming these:
 207 .PP
 208 .nf
 209 .RS
 210 http://hslibrary.example.com/
 211 http://hslibrary-intra.example.com/
 212 .RE
 213 .fi
 214 .PP
 215 Configuration changes only apply to instances created afterwards.
 216 .\===========================================================
 217 .SH "SEE ALSO"
 218 .BR koha-remove (8).
 219 .PP
 220 .B http://koha-community.org/
 221