3 # koha-create -- Create a new Koha instance.
4 # Copyright 2010 Catalyst IT, Ltd
6 # This program is free software: you can redistribute it and/or modify
7 # it under the terms of the GNU General Public License as published by
8 # the Free Software Foundation, either version 3 of the License, or
9 # (at your option) any later version.
11 # This program is distributed in the hope that it will be useful,
12 # but WITHOUT ANY WARRANTY; without even the implied warranty of
13 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 # GNU General Public License for more details.
16 # You should have received a copy of the GNU General Public License
17 # along with this program. If not, see <http://www.gnu.org/licenses/>.
27 Creates new Koha instances.
31 $scriptname [DB usage mode] [options] instancename
34 --create-db Create a new database on localhost. (default).
35 --request-db Creates a instancename-db-request.txt file where
36 you adjust your DB settings and re-run with --populate-db.
37 --populate-db Finish the installation you started with --request-db after
38 you adjusted the instancename-db-request.txt file.
39 --use-db Use this option if you already created and populated your DB.
42 --marcflavor flavor Set the MARC flavor. Valid values are marc21 (default),
44 --zebralang lang Choose the primary language for Zebra indexing. Valid
45 values are en (default), es, fr, nb, ru and uk.
46 --auth-idx idx_mode Set the indexing mode for authority records. Valid
47 values are dom (default) and grs1.
48 --biblio-idx idx_mode Set the indexing mode for bibliographic records.
49 Valid values are dom (default) and grs1.
50 --use-memcached Set the instance to make use of memcache.
51 --memcached-servers str Set a comma-separated list of host:port memcached servers.
52 --memcached-prefix str Set the desired prefix for the instance memcached namespace.
53 --defaultsql some.sql Specify a default SQL file to be loaded on the DB.
54 --configfile cfg_file Specify an alternate config file for reading default values.
55 --passwdfile passwd Specify an alternate passwd file.
56 --database dbname Enforce the use of the specified DB name (64 char limit)
57 --adminuser n Explicit the admin user ID in the DB. Relevant in
58 conjunction with --defaultsql and --populate-db.
59 --help,-h Show this help.
61 Note: the instance name cannot be longer that 11 chars.
71 # UPPER CASE VARIABLES - from configfile or default value
72 # lower case variables - generated within this script
73 generate_config_file() {
75 chown "root:$username" "$2"
77 sed -e "s/__KOHASITE__/$name/g" \
78 -e "s/__OPACPORT__/$OPACPORT/g" \
79 -e "s/__INTRAPORT__/$INTRAPORT/g" \
80 -e "s/__OPACSERVER__/$opacdomain/g" \
81 -e "s/__INTRASERVER__/$intradomain/g" \
82 -e "s/__ZEBRA_PASS__/$zebrapwd/g" \
83 -e "s/__ZEBRA_MARC_FORMAT__/$ZEBRA_MARC_FORMAT/g" \
84 -e "s/__ZEBRA_LANGUAGE__/$ZEBRA_LANGUAGE/g" \
85 -e "s/__BIBLIOS_INDEXING_MODE__/$BIBLIOS_INDEXING_MODE/g" \
86 -e "s/__AUTHORITIES_INDEXING_MODE__/$AUTHORITIES_INDEXING_MODE/g" \
87 -e "s/__ZEBRA_BIBLIOS_CFG__/$ZEBRA_BIBLIOS_CFG/g" \
88 -e "s/__ZEBRA_AUTHORITIES_CFG__/$ZEBRA_AUTHORITIES_CFG/g" \
89 -e "s/__START_BIBLIOS_RETRIEVAL_INFO__/`echo $START_BIBLIOS_RETRIEVAL_INFO`/g" \
90 -e "s/__END_BIBLIOS_RETRIEVAL_INFO__/`echo $END_BIBLIOS_RETRIEVAL_INFO`/g" \
91 -e "s/__START_AUTHORITIES_RETRIEVAL_INFO__/`echo $START_AUTHORITIES_RETRIEVAL_INFO`/g" \
92 -e "s/__END_AUTHORITIES_RETRIEVAL_INFO__/`echo $END_AUTHORITIES_RETRIEVAL_INFO`/g" \
93 -e "s/__DB_NAME__/$mysqldb/g" \
94 -e "s/__DB_HOST__/$mysqlhost/g" \
95 -e "s/__DB_USER__/$mysqluser/g" \
96 -e "s/__DB_PASS__/$mysqlpwd/g" \
97 -e "s/__UNIXUSER__/$username/g" \
98 -e "s/__UNIXGROUP__/$username/g" \
99 -e "s/__PLUGINS_DIR__/\/var\/lib\/koha\/$name\/plugins/g" \
100 -e "s/__MEMCACHED_NAMESPACE__/$MEMCACHED_NAMESPACE/g" \
101 -e "s/__MEMCACHED_SERVERS__/$MEMCACHED_SERVERS/g" \
102 "/etc/koha/$1" > "$2"
108 /^\[/ { inclient = 0 }
109 /^\[client\]/ { inclient = 1 }
110 inclient && /^ *host *=/ { print $3 }' \
111 /etc/mysql/koha-common.cnf
114 getinstancemysqlpassword() {
115 xmlstarlet sel -t -v 'yazgfs/config/pass' "/etc/koha/sites/$1/koha-conf.xml"
118 getinstancemysqluser() {
119 xmlstarlet sel -t -v 'yazgfs/config/user' "/etc/koha/sites/$1/koha-conf.xml"
122 getinstancemysqldatabase() {
123 xmlstarlet sel -t -v 'yazgfs/config/database' "/etc/koha/sites/$1/koha-conf.xml"
126 check_apache_config()
129 # Check that mpm_itk is installed and enabled
130 if ! /usr/sbin/apachectl -M 2> /dev/null | grep -q 'mpm_itk'; then
131 # Check Apache version
132 APACHE_DISABLE_MPM_MSG=""
133 if /usr/sbin/apache2ctl -v | grep -q "Server version: Apache/2.4"; then
134 # mpm_event or mpm_worker need to be disabled first. mpm_itk depends
135 # on mpm_prefork, which is enabled if needed. See
136 # https://bugs.debian.org/cgi-bin/bugreport.cgi?bug=734865
137 if /usr/sbin/apachectl -M 2> /dev/null | grep -q 'mpm_event'; then
138 APACHE_DISABLE_MPM_MSG=" sudo a2dismod mpm_event ;"
139 elif /usr/sbin/apachectl -M 2> /dev/null | grep -q 'mpm_worker'; then
140 APACHE_DISABLE_MPM_MSG=" sudo a2dismod mpm_worker ;"
141 # else mpm_prefork: a2enmod mpm_itk works
143 # else Apache 2.2: a2enmod mpm_itk works
148 Koha requires mpm_itk to be enabled within Apache in order to run.
149 Typically this can be enabled with:
151 $APACHE_DISABLE_MPM_MSG sudo a2enmod mpm_itk
157 # Check that mod_rewrite is installed and enabled.
158 if ! /usr/sbin/apachectl -M 2> /dev/null | grep -q 'rewrite_module'; then
161 Koha requires mod_rewrite to be enabled within Apache in order to run.
162 Typically this can be enabled with:
170 set_biblios_indexing_mode()
172 local indexing_mode=$1
175 case $indexing_mode in
177 START_BIBLIOS_RETRIEVAL_INFO=`cat <<EOF
178 <xi:include href="\/etc\/koha\/$marc_format-retrieval-info-bib-dom.xml"\n
179 xmlns:xi="http:\/\/www.w3.org\/2001\/XInclude">\n
184 END_BIBLIOS_RETRIEVAL_INFO=`cat <<EOF
189 BIBLIOS_INDEXING_MODE="dom"
190 ZEBRA_BIBLIOS_CFG="zebra-biblios-dom.cfg"
193 START_BIBLIOS_RETRIEVAL_INFO=" <retrievalinfo>"
194 END_BIBLIOS_RETRIEVAL_INFO=" <\/retrievalinfo>"
195 BIBLIOS_INDEXING_MODE="grs1"
196 ZEBRA_BIBLIOS_CFG="zebra-biblios.cfg"
199 die "Error: '$indexing_mode' is not a valid indexing mode for bibliographic records."
205 set_authorities_indexing_mode()
207 local indexing_mode=$1
210 case $indexing_mode in
212 START_AUTHORITIES_RETRIEVAL_INFO=`cat <<EOF
213 <xi:include href="\/etc\/koha\/$marc_format-retrieval-info-auth-dom.xml"\n
214 xmlns:xi="http:\/\/www.w3.org\/2001\/XInclude">\n
219 END_AUTHORITIES_RETRIEVAL_INFO=`cat <<EOF
224 AUTHORITIES_INDEXING_MODE="dom"
225 ZEBRA_AUTHORITIES_CFG="zebra-authorities-dom.cfg"
228 START_AUTHORITIES_RETRIEVAL_INFO=" <retrievalinfo>"
229 END_AUTHORITIES_RETRIEVAL_INFO=" <\/retrievalinfo>"
230 AUTHORITIES_INDEXING_MODE="grs1"
231 ZEBRA_AUTHORITIES_CFG="zebra-authorities.cfg"
234 die "Error: '$indexing_mode' is not a valid indexing mode for authority records."
244 if [ "$CLO_MEMCACHED_SERVERS" != "" ]; then
245 MEMCACHED_SERVERS=$CLO_MEMCACHED_SERVERS
247 if [ "$MEMCACHED_SERVERS" = "" ]; then
248 MEMCACHED_SERVERS=$DEFAULT_MEMCACHED_SERVERS
249 # else: was set by the koha-sites.conf file
253 if [ "$CLO_MEMCACHED_PREFIX" != "" ]; then
254 MEMCACHED_NAMESPACE="$CLO_MEMCACHED_PREFIX$instance"
256 if [ "$MEMCACHED_PREFIX" != "" ]; then
257 MEMCACHED_NAMESPACE="$MEMCACHED_PREFIX$instance"
259 MEMCACHED_NAMESPACE="$DEFAULT_MEMCACHED_PREFIX$instance"
265 # Set defaults and read config file, if it exists.
274 ZEBRA_MARC_FORMAT="marc21"
277 PASSWDFILE="/etc/koha/passwd"
279 # memcached variables
283 # hardcoded memcached defaults
284 DEFAULT_MEMCACHED_SERVERS="127.0.0.1:11211"
285 DEFAULT_MEMCACHED_PREFIX="koha_"
287 # Indexing mode variables (default is DOM)
288 BIBLIOS_INDEXING_MODE="dom"
289 AUTHORITIES_INDEXING_MODE="dom"
291 START_BIBLIOS_RETRIEVAL_INFO=""
292 END_BIBLIOS_RETRIEVAL_INFO=""
293 START_AUTHORITIES_RETRIEVAL_INFO=""
294 END_AUTHORITIES_RETRIEVAL_INFO=""
296 if [ -e /etc/koha/koha-sites.conf ]
298 . /etc/koha/koha-sites.conf
301 [ $# -ge 1 ] && [ $# -le 16 ] || ( usage ; die "Error: wrong parameters" )
303 TEMP=`getopt -o chrpm:l:d:f:b:a: -l create-db,request-db,populate-db,use-db,use-memcached,help,marcflavor:,auth-idx:,biblio-idx:,zebralang:,defaultsql:,configfile:,passwdfile:,database:,adminuser:,memcached-servers:,memcached-prefix:, \
306 # Note the quotes around `$TEMP': they are essential!
309 # Temporary variables for the command line options
310 CLO_ZEBRA_MARC_FORMAT=""
311 CLO_ZEBRA_LANGUAGE=""
314 CLO_BIBLIOS_INDEXING_MODE=""
315 CLO_AUTHORITIES_INDEXING_MODE=""
316 CLO_MEMCACHED_SERVERS=""
317 CLO_MEMCACHED_PREFIX=""
325 op=request ; shift ;;
327 op=populate ; shift ;;
331 USE_MEMCACHED="yes" ; shift ;;
333 CLO_MEMCACHED_SERVERS="$2" ; shift 2 ;;
335 CLO_MEMCACHED_PREFIX="$2" ; shift 2;;
337 CLO_ZEBRA_MARC_FORMAT="$2" ; shift 2 ;;
339 CLO_ZEBRA_LANGUAGE="$2" ; shift 2 ;;
341 CLO_AUTHORITIES_INDEXING_MODE="$2" ; shift 2 ;;
343 CLO_BIBLIOS_INDEXING_MODE="$2" ; shift 2 ;;
345 CLO_DEFAULTSQL="$2" ; shift 2 ;;
347 configfile="$2" ; shift 2 ;;
349 CLO_PASSWDFILE="$2" ; shift 2 ;;
351 CLO_DATABASE="$2" ; shift 2 ;;
353 CLO_ADMINUSER="$2" ; shift 2 ;;
359 die "Internal error processing command line arguments" ;;
363 # Load the configfile given on the command line
364 if [ "$configfile" != "" ]
366 if [ -e "$configfile" ]
370 die "$configfile does not exist.";
374 # Make sure options from the command line get the highest precedence
375 if [ "$CLO_ZEBRA_MARC_FORMAT" != "" ]
377 ZEBRA_MARC_FORMAT="$CLO_ZEBRA_MARC_FORMAT"
379 if [ "$CLO_ZEBRA_LANGUAGE" != "" ]
381 ZEBRA_LANGUAGE="$CLO_ZEBRA_LANGUAGE"
383 if [ "$CLO_DEFAULTSQL" != "" ]
385 DEFAULTSQL="$CLO_DEFAULTSQL"
387 if [ "$CLO_ADMINUSER" != "" ]
389 ADMINUSER="$CLO_ADMINUSER"
391 if [ "$CLO_PASSWDFILE" != "" ]
393 PASSWDFILE="$CLO_PASSWDFILE"
396 if [ "$CLO_BIBLIOS_INDEXING_MODE" != "" ]; then
397 BIBLIOS_INDEXING_MODE=$CLO_BIBLIOS_INDEXING_MODE
400 set_biblios_indexing_mode $BIBLIOS_INDEXING_MODE $ZEBRA_MARC_FORMAT
403 if [ "$CLO_AUTHORITIES_INDEXING_MODE" != "" ]; then
404 AUTHORITIES_INDEXING_MODE=$CLO_AUTHORITIES_INDEXING_MODE
407 set_authorities_indexing_mode $AUTHORITIES_INDEXING_MODE $ZEBRA_MARC_FORMAT
411 if [ "$USE_MEMCACHED" = "yes" ]; then
413 elif [ "$CLO_MEMCACHED_SERVERS" != "" ] || \
414 [ "$CLO_MEMCACHED_PREFIX" != "" ]; then
418 Error: you provided memcached configuration switches but memcached is not enabled.
419 Please set USE_MEMCACHED="yes" on /etc/koha/koha-sites.conf or use the
420 --use-memcached option switch to enable it.
426 # Unset memcached-related variables
431 # Are we root? If not, the mod_rewrite check will fail and be confusing, so
432 # we look into this first.
435 die "This script must be run with root privileges."
438 # Check everything is ok with Apache, die otherwise
441 opacdomain="$OPACPREFIX$name$OPACSUFFIX$DOMAIN"
442 intradomain="$INTRAPREFIX$name$INTRASUFFIX$DOMAIN"
445 if [ -f $PASSWDFILE ] && [ `cat $PASSWDFILE | grep "^$name:"` ]
447 passwdline=`cat $PASSWDFILE | grep "^$name:"`
448 mysqluser=`echo $passwdline | cut -d ":" -f 2`
449 mysqlpwd=`echo $passwdline | cut -d ":" -f 3`
450 mysqldb=`echo $passwdline | cut -d ":" -f 4`
453 # The order of precedence for MySQL database name is:
454 # default < passwd file < command line
455 if [ "$mysqldb" = "" ]
459 if [ "$CLO_DATABASE" != "" ]
461 mysqldb="$CLO_DATABASE"
464 if [ "$mysqluser" = "" ]
466 mysqluser="koha_$name"
468 mysqlhost="$(getmysqlhost)"
470 if [ "$op" = create ] || [ "$op" = request ] || [ "$op" = use ]
472 if [ "$mysqlpwd" = "" ]
474 mysqlpwd="$(pwgen -s 16 1)"
477 mysqlpwd="$(getinstancemysqlpassword $name)"
481 if [ "$op" = create ] || [ "$op" = request ] || [ "$op" = use ]
483 # Create new user and group.
484 username="$name-koha"
485 if getent passwd "$username" > /dev/null
487 die "User $username already exists."
489 if getent group "$username" > /dev/null
491 die "Group $username already exists."
493 adduser --no-create-home --disabled-login \
494 --gecos "Koha instance $username" \
495 --home "/var/lib/koha/$name" \
498 # Create the site-specific directories.
499 koha-create-dirs "$name"
501 # Generate Zebra database password.
502 zebrapwd="$(pwgen -s 16 1)"
503 # Future enhancement: make this configurable for when your db is on
505 mysql_hostname="localhost"
506 # Set up MySQL database for this instance.
507 if [ "$op" = create ]
509 mysql --defaults-extra-file=/etc/mysql/koha-common.cnf <<eof
510 CREATE DATABASE \`$mysqldb\`;
511 CREATE USER \`$mysqluser\`@'$mysql_hostname' IDENTIFIED BY '$mysqlpwd';
512 CREATE USER \`$mysqluser\`@'%' IDENTIFIED BY '$mysqlpwd';
513 GRANT ALL PRIVILEGES ON \`$mysqldb\`.* TO \`$mysqluser\`;
520 mysql --defaults-extra-file=/etc/mysql/koha-common.cnf --force <<eof
521 CREATE USER \`$mysqluser\`@'$mysql_hostname' IDENTIFIED BY '$mysqlpwd';
522 CREATE USER \`$mysqluser\`@'%' IDENTIFIED BY '$mysqlpwd';
523 GRANT ALL PRIVILEGES ON \`$mysqldb\`.* TO \`$mysqluser\`;
528 # Generate and install Apache site-available file and log dir.
529 generate_config_file apache-site.conf.in \
530 "/etc/apache2/sites-available/$name.conf"
531 mkdir "/var/log/koha/$name"
532 chown "$username:$username" "/var/log/koha/$name"
535 # Generate and install main Koha config file.
536 generate_config_file koha-conf-site.xml.in \
537 "/etc/koha/sites/$name/koha-conf.xml"
539 # Generate and install Zebra config files.
540 generate_config_file zebra-biblios-site.cfg.in \
541 "/etc/koha/sites/$name/zebra-biblios.cfg"
542 generate_config_file zebra-biblios-dom-site.cfg.in \
543 "/etc/koha/sites/$name/zebra-biblios-dom.cfg"
544 generate_config_file zebra-authorities-site.cfg.in \
545 "/etc/koha/sites/$name/zebra-authorities.cfg"
546 generate_config_file zebra-authorities-dom-site.cfg.in \
547 "/etc/koha/sites/$name/zebra-authorities-dom.cfg"
548 generate_config_file zebra.passwd.in \
549 "/etc/koha/sites/$name/zebra.passwd"
552 # Create a GPG-encrypted file for requesting a DB to be set up.
553 if [ "$op" = request ]
555 touch "$name-db-request.txt"
556 chmod 0600 "$name-db-request.txt"
557 cat > "$name-db-request.txt" << eof
558 Please create a MySQL database and user on $mysqlhost as follows:
560 database name: $mysqldb
561 database user: $mysqluser
567 echo "See $name-db-request.txt for database creation request."
568 echo "Please forward it to the right person, and then run"
569 echo "$0 --populate-db $name"
575 if [ "$op" = create ] || [ "$op" = populate ]
577 # Re-fetch the passwords from the config we've generated, allows it
578 # to be different from what we set, in case the user had to change
580 mysqluser=$(getinstancemysqluser $name)
581 mysqldb=$(getinstancemysqldatabase $name)
582 # Use the default database content if that exists.
583 if [ -e "$DEFAULTSQL" ]
585 # Populate the database with default content.
587 sed "s/__KOHASITE__/$name/g" |
588 mysql --host="$mysqlhost" --user="$mysqluser" --password="$mysqlpwd" "$mysqldb"
591 # Change the default user's password.
592 staffpass="$(pwgen 12 1)"
593 staffdigest=$(echo -n "$staffpass" |
595 use Digest::MD5 qw(md5_base64);
596 while (<>) { print md5_base64($_), "\n"; }')
597 mysql --host="$mysqlhost" --user="$mysqluser" \
598 --password="$mysqlpwd" <<eof
601 SET password = '$staffdigest'
602 WHERE borrowernumber = $ADMINUSER;
605 echo "staff user password is '$staffpass' but keep that secret"
607 # Upgrade the database schema, just in case the dump was from an
609 koha-upgrade-schema "$name"
611 echo "Koha instance is empty, no staff user created."
616 if [ "$op" = create ] || [ "$op" = populate ] || [ "$op" = use ]
618 # Reconfigure Apache.
620 service apache2 restart
623 koha-start-zebra "$name"
627 if [ "$op" = request ]
634 Email for this instance is disabled. When you're ready to enable it, use:
635 koha-email-enable $name