Attachment #5197 for bug #4877

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




.\" Copyright 2010  Catalyst IT, Ltd
.\"
.\" This program is free software: you can redistribute it and/or modify
.\" it under the terms of the GNU General Public License as published by
.\" the Free Software Foundation, either version 3 of the License, or
.\" (at your option) any later version.
.\"
.\" This program is distributed in the hope that it will be useful,
.\" but WITHOUT ANY WARRANTY; without even the implied warranty of
.\" MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
.\" GNU General Public License for more details.
.\"
.\" You should have received a copy of the GNU General Public License
.\" along with this program.  If not, see <http://www.gnu.org/licenses/>.
.\===========================================================

[
.B \-\^\-create-db|--request-db|--populate-db
]
.br
[
.B \-\^\-marcflavor \fImarc21|normarc|unimarc\fP
]
.br
[
.B \-\^\-zebralang \fIen|nb|fr\fP
]
[
.B \-\^\-defaultsql \fIsql-file\fP
]
.br
[
.B \-\^\-configfile \fIconfig-file\fP
]
.IR instancename
.\===========================================================
.SH OPTIONS
.TP \w'\fB\-\^\-populate-db\fP'u+3n
.B \-\^\-create-db
Create a new datbase on localhost. If the database you want to use does
not reside on localhost, you can use --request-db and --populate-db, see below.
.\----------------------------------------------------------------------------------------------------------------------
.TP
.B \-\^\-request-db
This option will create a file called
.IR instancename-db-request.txt
in your current directory that contains information about
how the database needs to be set up.
.\----------------------------------------------------------------------------------------------------------------------
.TP
.B \-\^\-populate-db
When you have run koha-create with the --request-db option, and a database
has been set up, you can finnish your installation by running koha-create
with this option.
.\----------------------------------------------------------------------------------------------------------------------
.TP
.B \-\^\-configfile

.\----------------------------------------------------------------------------------------------------------------------
.TP
.B \-\^\-defaultsql
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.
.\----------------------------------------------------------------------------------------------------------------------
.TP
.B \-\^\-marcflavor
Specifies format of MARC records to be indexed by Zebra. Corresponds to the
ZEBRA_MARC_FORMAT config file variable.
.\----------------------------------------------------------------------------------------------------------------------
.TP
.B \-\^\-zebralang
Primary language for Zebra indexing. Corresponds to the ZEBRA_LANGUAGE
config file variable.
.\===========================================================
.SH DESCRIPTION
.B koha-create

and serves several sites from the same host.
.PP
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
.IR instance -koha.
MySQL username is
.RI koha_ instance ,
and database is
.RI koha_ instance .

The password for MySQL is generated randomly, and printed to the terminal.
.PP
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
.B /etc/koha/koha-site.conf
or alternate config file.
.PP
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.
.PP
Several configuration variables are available for adjusting this behavior.
The variables are put into
.BR /etc/koha/koha-site.conf .
The following variables are obeyed:
.PP
.\----------------------------------------------------------------------------------------------------------------------

Order of precedence for config options, from lowest to highest:
.RS
.nf
1. The defaults set in the code of koha-create
2. /etc/koha/koha-sites.conf
3. Config file specified with --configfile
4. Individual command line options
.fi
.RE
.\===========================================================

koha-create hslibrary
.RE
.PP
The public catalog is now at
.I http://hslibrary/
and the librarian interface at
.IR http://hslibrary:8080/ .
- 

Return to bug 4877

Lines 1-15 Link Here

(-)a/debian/scripts/koha-create.8 (-28 / +33 lines)
1	.\" Copyright 2010 Catalyst IT, Ltd	1	.\" Copyright 2010 Catalyst IT, Ltd
2	.\"	2	.\"
3	.\" This program is free software: you can redistribute it and/or modify	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	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	5	.\" the Free Software Foundation, either version 3 of the License, or
6	.\" (at your option) any later version.	6	.\" (at your option) any later version.
7	.\"	7	.\"
8	.\" This program is distributed in the hope that it will be useful,	8	.\" This program is distributed in the hope that it will be useful,
9	.\" but WITHOUT ANY WARRANTY; without even the implied warranty of	9	.\" but WITHOUT ANY WARRANTY; without even the implied warranty of
10	.\" MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the	10	.\" MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11	.\" GNU General Public License for more details.	11	.\" GNU General Public License for more details.
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	.\===========================================================	15	.\===========================================================
Lines 23-60 koha-create \(em create a new Koha instance Link Here
23	[	23	[
24	.B \-\^\-create-db\|--request-db\|--populate-db	24	.B \-\^\-create-db\|--request-db\|--populate-db
25	]	25	]
		26	.br
26	[	27	[
27	.B \-\^\-marcflavor	28	.B \-\^\-marcflavor \fImarc21\|normarc\|unimarc\fP
28	]	29	]
		30	.br
29	[	31	[
30	.B \-\^\-zebralang	32	.B \-\^\-zebralang \fIen\|nb\|fr\fP
31	]	33	]
32	[	34	[
33	.B \-\^\-defaultsql	35	.B \-\^\-defaultsql \fIsql-file\fP
34	]	36	]
		37	.br
35	[	38	[
36	.B \-\^\-configfile	39	.B \-\^\-configfile \fIconfig-file\fP
37	]	40	]
38	.IR instancename	41	.IR instancename
39	.\===========================================================	42	.\===========================================================
40	.SH OPTIONS	43	.SH OPTIONS
41	.TP \w'\fB\-\^\-populate-db\fP'u+3n	44	.TP \w'\fB\-\^\-populate-db\fP'u+3n
42	.B \-\^\-create-db	45	.B \-\^\-create-db
43	Create a new datbase on localhost. If the database you want to use does	46	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.	47	not reside on localhost, you can use --request-db and --populate-db, see below.
45	.\----------------------------------------------------------------------------------------------------------------------	48	.\----------------------------------------------------------------------------------------------------------------------
46	.TP	49	.TP
47	.B \-\^\-request-db	50	.B \-\^\-request-db
48	This option will create a file called	51	This option will create a file called
49	.IR instancename-db-request.txt	52	.IR instancename-db-request.txt
50	in your current directory that contains information about	53	in your current directory that contains information about
51	how the database needs to be set up.	54	how the database needs to be set up.
52	.\----------------------------------------------------------------------------------------------------------------------	55	.\----------------------------------------------------------------------------------------------------------------------
53	.TP	56	.TP
54	.B \-\^\-populate-db	57	.B \-\^\-populate-db
55	When you have run koha-create with the --request-db option, and a database	58	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	59	has been set up, you can finnish your installation by running koha-create
57	with this option.	60	with this option.
58	.\----------------------------------------------------------------------------------------------------------------------	61	.\----------------------------------------------------------------------------------------------------------------------
59	.TP	62	.TP
60	.B \-\^\-configfile	63	.B \-\^\-configfile
Lines 63-80 the default config file, see below for details. Link Here
63	.\----------------------------------------------------------------------------------------------------------------------	66	.\----------------------------------------------------------------------------------------------------------------------
64	.TP	67	.TP
65	.B \-\^\-defaultsql	68	.B \-\^\-defaultsql
66	Path to an SQL-file other than the one pointed to in the default or alternative	69	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.	70	config file. Corresponds to the DEFAULTSQL config file variable.
68	.\----------------------------------------------------------------------------------------------------------------------	71	.\----------------------------------------------------------------------------------------------------------------------
69	.TP	72	.TP
70	.B \-\^\-marcflavor	73	.B \-\^\-marcflavor
71	Specifies format of MARC records to be indexed by Zebra. Corresponds to the	74	Specifies format of MARC records to be indexed by Zebra. Corresponds to the
72	ZEBRA_MARC_FORMAT config file variable.	75	ZEBRA_MARC_FORMAT config file variable.
73	.\----------------------------------------------------------------------------------------------------------------------	76	.\----------------------------------------------------------------------------------------------------------------------
74	.TP	77	.TP
75	.B \-\^\-zebralang	78	.B \-\^\-zebralang
76	Primary language for Zebra indexing. Corresponds to the ZEBRA_LANGUAGE	79	Primary language for Zebra indexing. Corresponds to the ZEBRA_LANGUAGE
77	config file variable.	80	config file variable.
78	.\===========================================================	81	.\===========================================================
79	.SH DESCRIPTION	82	.SH DESCRIPTION
80	.B koha-create	83	.B koha-create
Lines 83-93 It is meant for a site that provides Koha hosting, Link Here
83	and serves several sites from the same host.	86	and serves several sites from the same host.
84	.PP	87	.PP
85	The name of the instance is used as the domain name for Apache,	88	The name of the instance is used as the domain name for Apache,
86	Unix user and group names, and MySQL username and datbase names	89	Unix user and group names, and MySQL username and database names
87	are derived from it.	90	are derived from it.
88	Unix user and group are named	91	Unix user and group are named
89	.IR instance -koha.	92	.IR instance -koha.
90	MySQL username is	93	MySQL username is
91	.RI koha_ instance ,	94	.RI koha_ instance ,
92	and database is	95	and database is
93	.RI koha_ instance .	96	.RI koha_ instance .
Lines 96-110 The Unix user has logins disabled. Link Here
96	The password for MySQL is generated randomly, and printed to the terminal.	99	The password for MySQL is generated randomly, and printed to the terminal.
97	.PP	100	.PP
98	The instance name is used as the domain name (ServerName) for Apache.	101	The instance name is used as the domain name (ServerName) for Apache.
99	The public catalog (OPAC), for library customers, is on port 80.	102	The public catalogue (OPAC), for library customers, is on port 80.
100	The librarian intranet interface is on port 8080.	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.
101	.PP	107	.PP
102	After the Koha instance is created, it is ready to be used,	108	After the Koha instance is created, it is ready to be used,
103	but the librarian needs to log in via the intranet and configure things.	109	but the librarian needs to log in via the intranet and configure things.
104	.PP	110	.PP
105	Several configuration variables are available for adjusting this behavior.	111	Several configuration variables are available for adjusting this behavior.
106	The variables are put into	112	The variables are put into
107	.B /etc/koha/koha-site.conf .	113	.BR /etc/koha/koha-site.conf .
108	The following variables are obeyed:	114	The following variables are obeyed:
109	.PP	115	.PP
110	.\----------------------------------------------------------------------------------------------------------------------	116	.\----------------------------------------------------------------------------------------------------------------------
Lines 154-163 Primary language for Zebra indexing. Possible values are 'en', 'fr' and 'nb'. Link Here
154	Order of precedence for config options, from lowest to highest:	160	Order of precedence for config options, from lowest to highest:
155	.RS	161	.RS
156	.nf	162	.nf
157	1. The defaults set in the code of koha-create	163	1. The defaults set in the code of koha-create
158	2. /etc/koha/koha-sites.conf	164	2. /etc/koha/koha-sites.conf
159	3. Config file specified with --configfile	165	3. Config file specified with --configfile
160	4. Individual command line options	166	4. Individual command line options
161	.fi	167	.fi
162	.RE	168	.RE
163	.\===========================================================	169	.\===========================================================
Lines 179-185 To create a new Koha instance: Link Here
179	koha-create hslibrary	185	koha-create hslibrary
180	.RE	186	.RE
181	.PP	187	.PP
182	The public catalog is now at	188	The public catalog is now at
183	.I http://hslibrary/	189	.I http://hslibrary/
184	and the librarian interface at	190	and the librarian interface at
185	.IR http://hslibrary:8080/ .	191	.IR http://hslibrary:8080/ .
186	-