1 .\" Copyright 2010 Catalyst IT, Ltd
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.
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.
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 .\===========================================================
19 koha-create \(em create a new Koha instance
20 .\===========================================================
24 .B \-\^\-create-db|--request-db|--populate-db
28 .B \-\^\-marcflavor \fImarc21|normarc|unimarc\fP
32 .B \-\^\-zebralang \fIen|nb|fr\fP
35 .B \-\^\-defaultsql \fIsql-file\fP
39 .B \-\^\-configfile \fIconfig-file\fP
42 .\===========================================================
44 .TP \w'\fB\-\^\-populate-db\fP'u+3n
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 .\----------------------------------------------------------------------------------------------------------------------
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 .\----------------------------------------------------------------------------------------------------------------------
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
61 .\----------------------------------------------------------------------------------------------------------------------
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 .\----------------------------------------------------------------------------------------------------------------------
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 .\----------------------------------------------------------------------------------------------------------------------
74 Specifies format of MARC records to be indexed by Zebra. Corresponds to the
75 ZEBRA_MARC_FORMAT config file variable.
76 .\----------------------------------------------------------------------------------------------------------------------
79 Primary language for Zebra indexing. Corresponds to the ZEBRA_LANGUAGE
81 .\===========================================================
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.
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
91 Unix user and group are named
98 The Unix user has logins disabled.
99 The password for MySQL is generated randomly, and printed to the terminal.
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
105 .B /etc/koha/koha-site.conf
106 or alternate config file.
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.
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:
116 .\----------------------------------------------------------------------------------------------------------------------
119 The domain to append to the instance name, for Apache ServerName.
121 The value must begin with a period.
122 .\----------------------------------------------------------------------------------------------------------------------
125 The port for the intranet.
126 If you set this to empty or 80, then you
132 .\----------------------------------------------------------------------------------------------------------------------
135 This is inserted before the instance name when forming Apache ServerName.
136 For subdomains, make sure it ends with a period.
137 .\----------------------------------------------------------------------------------------------------------------------
140 This is inserted after the instance name,
141 but before the domain name,
142 when forming Apache ServerName.
143 .\----------------------------------------------------------------------------------------------------------------------
146 An SQL file (compressed with gzip) that can be fed to
148 to initialize the database after it has been created.
149 Might be created using
150 .BR koha-dump-defaults (8).
151 .\----------------------------------------------------------------------------------------------------------------------
154 Specifies format of MARC records to be indexed by Zebra. Possible values are 'marc21', 'normarc' and 'unimarc'.
155 .\----------------------------------------------------------------------------------------------------------------------
158 Primary language for Zebra indexing. Possible values are 'en', 'fr' and 'nb'.
160 Order of precedence for config options, from lowest to highest:
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
169 .\===========================================================
172 .B /etc/koha/koha-site.conf
173 Configuration variables are read from this file, if it exists.
174 .\===========================================================
177 The program is a bit fragile. If something goes wrong, it does not clean up after itself.
179 Bugs can be reported here: http://bugs.koha-community.org/bugzilla3/
180 .\===========================================================
182 To create a new Koha instance:
185 koha-create hslibrary
188 The public catalog is now at
190 and the librarian interface at
191 .IR http://hslibrary:8080/ .
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
199 DOMAIN=".example.com"
205 This will result in the addresses for the public and intranet interfaces
210 http://hslibrary.example.com/
211 http://hslibrary-intra.example.com/
215 Configuration changes only apply to instances created afterwards.
216 .\===========================================================
220 .B http://koha-community.org/