View | Details | Raw Unified | Return to bug 4877
Collapse All | Expand All

(-)a/debian/scripts/koha-create.8 (-10 / +96 lines)
Lines 12-23 Link Here
12 
.\"
12 
.\"
13 
.\" You should have received a copy of the GNU General Public License
 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/>.
 14 
.\" along with this program.  If not, see <http://www.gnu.org/licenses/>.
15 
.TH KOHA-CREATE 8 2010-05-03 Koha
 15 
.\===========================================================
16 
.TH KOHA-CREATE 8 "2011-08-28" "Koha"
17 
.\===========================================================
16 
.SH NAME
 18 
.SH NAME
17 
koha-create \- create a new Koha instance
 19 
koha-create \(em create a new Koha instance
20 
.\===========================================================
18 
.SH SYNOPSIS
 21 
.SH SYNOPSIS
19 
.B koha-create
 22 
.B koha-create
20 
.IR instance-name
 23 
[
24 
.B \-\^\-create-db|--request-db|--populate-db
25 
]
26 
[
27 
.B \-\^\-marcflavor
28 
]
29 
[
30 
.B \-\^\-zebralang
31 
]
32 
[
33 
.B \-\^\-defaultsql
34 
]
35 
[
36 
.B \-\^\-configfile
37 
]
38 
.IR instancename
39 
.\===========================================================
40 
.SH OPTIONS
41 
.TP \w'\fB\-\^\-populate-db\fP'u+3n
42 
.B \-\^\-create-db
43 
Create a new datbase on localhost. If the database you want to use does
44 
not reside on localhost, you can use --request-db and --populate-db, see below.
45 
.\----------------------------------------------------------------------------------------------------------------------
46 
.TP
47 
.B \-\^\-request-db
48 
This option will create a file called
49 
.IR instancename-db-request.txt
50 
in your current directory that contains information about
51 
how the database needs to be set up.
52 
.\----------------------------------------------------------------------------------------------------------------------
53 
.TP
54 
.B \-\^\-populate-db
55 
When you have run koha-create with the --request-db option, and a database
56 
has been set up, you can finnish your installation by running koha-create
57 
with this option.
58 
.\----------------------------------------------------------------------------------------------------------------------
59 
.TP
60 
.B \-\^\-configfile
61 
Path to an alternative config file. This file can hold the same variables as
62 
the default config file, see below for details.
63 
.\----------------------------------------------------------------------------------------------------------------------
64 
.TP
65 
.B \-\^\-defaultsql
66 
Path to an SQL-file other than the one pointed to in the default or alternative
67 
config file.  Corresponds to the DEFAULTSQL config file variable.
68 
.\----------------------------------------------------------------------------------------------------------------------
69 
.TP
70 
.B \-\^\-marcflavor
71 
Specifies format of MARC records to be indexed by Zebra. Corresponds to the
72 
ZEBRA_MARC_FORMAT config file variable.
73 
.\----------------------------------------------------------------------------------------------------------------------
74 
.TP
75 
.B \-\^\-zebralang
76 
Primary language for Zebra indexing. Corresponds to the ZEBRA_LANGUAGE
77 
config file variable.
78 
.\===========================================================
21 
.SH DESCRIPTION
 79 
.SH DESCRIPTION
22 
.B koha-create
 80 
.B koha-create
23 
creates a new Koha instance.
 81 
creates a new Koha instance.
Lines 25-44 It is meant for a site that provides Koha hosting, Link Here
25 
and serves several sites from the same host.
 83 
and serves several sites from the same host.
26 
.PP
 84 
.PP
27 
The name of the instance is used as the domain name for Apache,
 85 
The name of the instance is used as the domain name for Apache,
28 
and Unix user and group names, and MySQL username and table names
 86 
Unix user and group names, and MySQL username and datbase names
29 
are derived from it.
 87 
are derived from it.
30 
Unix user and group are named
 88 
Unix user and group are named
31 
.IR instance -koha.
 89 
.IR instance -koha.
32 
MySQL username is
90 
MySQL username is
33 
.RI koha_ instance ,
 91 
.RI koha_ instance ,
34 
and table is
 92 
and database is
35 
.RI koha_ instance .
 93 
.RI koha_ instance .
36 
.PP
 94 
.PP
37 
The Unix user has logins disabled.
 95 
The Unix user has logins disabled.
38 
The password for MySQL is generated randomly, and printed to the terminal.
 96 
The password for MySQL is generated randomly, and printed to the terminal.
39 
.PP
 97 
.PP
40 
The instance name is used as the domain name (ServerName) for Apache.
 98 
The instance name is used as the domain name (ServerName) for Apache.
41 
The open catalog (OPAC), for library customers, is on port 80.
 99 
The public catalog (OPAC), for library customers, is on port 80.
42 
The librarian intranet interface is on port 8080.
 100 
The librarian intranet interface is on port 8080.
43 
.PP
 101 
.PP
44 
After the Koha instance is created, it is ready to be used,
102 
After the Koha instance is created, it is ready to be used,
Lines 49-59 The variables are put into Link Here
49 
.B /etc/koha/koha-site.conf .
 107 
.B /etc/koha/koha-site.conf .
50 
The following variables are obeyed:
 108 
The following variables are obeyed:
51 
.PP
 109 
.PP
110 
.\----------------------------------------------------------------------------------------------------------------------
52 
.TP
 111 
.TP
53 
.B DOMAIN
 112 
.B DOMAIN
54 
The domain to append to the instance name, for Apache ServerName.
 113 
The domain to append to the instance name, for Apache ServerName.
55 
Default is empty.
 114 
Default is empty.
56 
The value must begin with a period.
 115 
The value must begin with a period.
116 
.\----------------------------------------------------------------------------------------------------------------------
57 
.TP
 117 
.TP
58 
.B INTRAPORT
 118 
.B INTRAPORT
59 
The port for the intranet.
 119 
The port for the intranet.
Lines 63-91 also define Link Here
63 
.B INTRAPREFIX
 123 
.B INTRAPREFIX
64 
or
 124 
or
65 
.BR INTRASUFFIX .
 125 
.BR INTRASUFFIX .
126 
.\----------------------------------------------------------------------------------------------------------------------
66 
.TP
 127 
.TP
67 
.B INTRAPREFIX
 128 
.B INTRAPREFIX
68 
This is inserted before the instance name when forming Apache ServerName.
 129 
This is inserted before the instance name when forming Apache ServerName.
69 
For subdomains, make sure it ends with a period.
 130 
For subdomains, make sure it ends with a period.
131 
.\----------------------------------------------------------------------------------------------------------------------
70 
.TP
 132 
.TP
71 
.B INTRASUFFIX
 133 
.B INTRASUFFIX
72 
This is inserted after the instance name,
 134 
This is inserted after the instance name,
73 
but before the domain name,
 135 
but before the domain name,
74 
when forming Apache ServerName.
 136 
when forming Apache ServerName.
137 
.\----------------------------------------------------------------------------------------------------------------------
75 
.TP
 138 
.TP
76 
.B DEFAULTSQL
 139 
.B DEFAULTSQL
77 
An SQL file (possibly compressed with gzip) that can be fed to
 140 
An SQL file (compressed with gzip) that can be fed to
78 
.BR mysql (1)
 141 
.BR mysql (1)
79 
to initialize the database after it has been created.
 142 
to initialize the database after it has been created.
80 
Might be created using
 143 
Might be created using
81 
.BR koha-dump-defaults (8).
 144 
.BR koha-dump-defaults (8).
145 
.\----------------------------------------------------------------------------------------------------------------------
146 
.TP
147 
.B ZEBRA_MARC_FORMAT
148 
Specifies format of MARC records to be indexed by Zebra. Possible values are 'marc21', 'normarc' and 'unimarc'.
149 
.\----------------------------------------------------------------------------------------------------------------------
150 
.TP
151 
.B ZEBRA_LANGUAGE
152 
Primary language for Zebra indexing. Possible values are 'en', 'fr' and 'nb'.
153 
.TP
154 
Order of precedence for config options, from lowest to highest:
155 
.RS
156 
.nf
157 
1. The defaults set in the code of koha-create
158 
2. /etc/koha/koha-sites.conf
159 
3. Config file specified with --configfile
160 
4. Individual command line options
161 
.fi
162 
.RE
163 
.\===========================================================
82 
.SH FILES
 164 
.SH FILES
83 
.TP
 165 
.TP
84 
.B /etc/koha/koha-site.conf
 166 
.B /etc/koha/koha-site.conf
85 
Configuration variables are read from this file, if it exists.
 167 
Configuration variables are read from this file, if it exists.
168 
.\===========================================================
86 
.SH BUGS
 169 
.SH BUGS
87 
The program is a bit fragile.
 170 
.TP
88 
If something goes wrong, it does not clean up after itself.
 171 
The program is a bit fragile. If something goes wrong, it does not clean up after itself.
172 
.TP
173 
Bugs can be reported here: http://bugs.koha-community.org/bugzilla3/
174 
.\===========================================================
89 
.SH EXAMPLE
 175 
.SH EXAMPLE
90 
To create a new Koha instance:
 176 
To create a new Koha instance:
91 
.PP
 177 
.PP
Lines 121-126 http://hslibrary-intra.example.com/ Link Here
121 
.fi
 207 
.fi
122 
.PP
 208 
.PP
123 
Configuration changes only apply to instances created afterwards.
 209 
Configuration changes only apply to instances created afterwards.
210 
.\===========================================================
124 
.SH "SEE ALSO"
 211 
.SH "SEE ALSO"
125 
.BR koha-remove (8).
 212 
.BR koha-remove (8).
126 
.PP
 213 
.PP
127 
-

Return to bug 4877