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/>.
22 # include helper functions
23 if [ -f "/usr/share/koha/bin/koha-functions.sh" ]; then
24 . "/usr/share/koha/bin/koha-functions.sh"
26 echo "Error: /usr/share/koha/bin/koha-functions.sh not present." 1>&2
35 Creates new Koha instances.
39 $scriptname [DB usage mode] [options] instancename
42 --create-db Create a new database on localhost. (default).
43 --request-db Creates a instancename-db-request.txt file where
44 you adjust your DB settings and re-run with --populate-db.
45 --populate-db Finish the installation you started with --request-db after
46 you adjusted the instancename-db-request.txt file.
47 --use-db Use this option if you already created and populated your DB.
50 --marcflavor flavor Set the MARC flavor. Valid values are marc21 (default),
52 --zebralang lang Choose the primary language for Zebra indexing. Valid
53 values are en (default), es, fr, nb, ru and uk.
54 --auth-idx idx_mode Set the indexing mode for authority records. Valid
55 values are dom (default) and grs1.
56 --biblio-idx idx_mode Set the indexing mode for bibliographic records.
57 Valid values are dom (default) and grs1.
58 --use-memcached Set the instance to make use of memcache.
59 --memcached-servers str Set a comma-separated list of host:port memcached servers.
60 --memcached-prefix str Set the desired prefix for the instance memcached namespace.
61 --defaultsql some.sql Specify a default SQL file to be loaded on the DB.
62 --configfile cfg_file Specify an alternate config file for reading default values.
63 --passwdfile passwd Specify an alternate passwd file.
64 --database dbname Enforce the use of the specified DB name (64 char limit)
65 --adminuser n Explicit the admin user ID in the DB. Relevant in
66 conjunction with --defaultsql and --populate-db.
67 --help,-h Show this help.
69 Note: the instance name cannot be longer that 11 chars.
74 # UPPER CASE VARIABLES - from configfile or default value
75 # lower case variables - generated within this script
76 generate_config_file() {
78 chown "root:$username" "$2"
80 sed -e "s/__KOHASITE__/$name/g" \
81 -e "s/__OPACPORT__/$OPACPORT/g" \
82 -e "s/__INTRAPORT__/$INTRAPORT/g" \
83 -e "s/__OPACSERVER__/$opacdomain/g" \
84 -e "s/__INTRASERVER__/$intradomain/g" \
85 -e "s/__ZEBRA_PASS__/$zebrapwd/g" \
86 -e "s/__ZEBRA_MARC_FORMAT__/$ZEBRA_MARC_FORMAT/g" \
87 -e "s/__ZEBRA_LANGUAGE__/$ZEBRA_LANGUAGE/g" \
88 -e "s/__BIBLIOS_INDEXING_MODE__/$BIBLIOS_INDEXING_MODE/g" \
89 -e "s/__AUTHORITIES_INDEXING_MODE__/$AUTHORITIES_INDEXING_MODE/g" \
90 -e "s/__ZEBRA_BIBLIOS_CFG__/$ZEBRA_BIBLIOS_CFG/g" \
91 -e "s/__ZEBRA_AUTHORITIES_CFG__/$ZEBRA_AUTHORITIES_CFG/g" \
92 -e "s/__START_BIBLIOS_RETRIEVAL_INFO__/`echo $START_BIBLIOS_RETRIEVAL_INFO`/g" \
93 -e "s/__END_BIBLIOS_RETRIEVAL_INFO__/`echo $END_BIBLIOS_RETRIEVAL_INFO`/g" \
94 -e "s/__START_AUTHORITIES_RETRIEVAL_INFO__/`echo $START_AUTHORITIES_RETRIEVAL_INFO`/g" \
95 -e "s/__END_AUTHORITIES_RETRIEVAL_INFO__/`echo $END_AUTHORITIES_RETRIEVAL_INFO`/g" \
96 -e "s/__DB_NAME__/$mysqldb/g" \
97 -e "s/__DB_HOST__/$mysqlhost/g" \
98 -e "s/__DB_USER__/$mysqluser/g" \
99 -e "s/__DB_PASS__/$mysqlpwd/g" \
100 -e "s/__UNIXUSER__/$username/g" \
101 -e "s/__UNIXGROUP__/$username/g" \
102 -e "s/__PLUGINS_DIR__/\/var\/lib\/koha\/$name\/plugins/g" \
103 -e "s/__MEMCACHED_NAMESPACE__/$MEMCACHED_NAMESPACE/g" \
104 -e "s/__MEMCACHED_SERVERS__/$MEMCACHED_SERVERS/g" \
105 "/etc/koha/$1" > "$2"
111 /^\[/ { inclient = 0 }
112 /^\[client\]/ { inclient = 1 }
113 inclient && /^ *host *=/ { print $3 }' \
114 /etc/mysql/koha-common.cnf
117 getinstancemysqlpassword() {
118 xmlstarlet sel -t -v 'yazgfs/config/pass' "/etc/koha/sites/$1/koha-conf.xml"
121 getinstancemysqluser() {
122 xmlstarlet sel -t -v 'yazgfs/config/user' "/etc/koha/sites/$1/koha-conf.xml"
125 getinstancemysqldatabase() {
126 xmlstarlet sel -t -v 'yazgfs/config/database' "/etc/koha/sites/$1/koha-conf.xml"
129 check_apache_config()
132 # Check that mpm_itk is installed and enabled
133 if ! /usr/sbin/apachectl -M 2> /dev/null | grep -q 'mpm_itk'; then
134 # Check Apache version
135 APACHE_DISABLE_MPM_MSG=""
136 if /usr/sbin/apache2ctl -v | grep -q "Server version: Apache/2.4"; then
137 # mpm_event or mpm_worker need to be disabled first. mpm_itk depends
138 # on mpm_prefork, which is enabled if needed. See
139 # https://bugs.debian.org/cgi-bin/bugreport.cgi?bug=734865
140 if /usr/sbin/apachectl -M 2> /dev/null | grep -q 'mpm_event'; then
141 APACHE_DISABLE_MPM_MSG=" sudo a2dismod mpm_event ;"
142 elif /usr/sbin/apachectl -M 2> /dev/null | grep -q 'mpm_worker'; then
143 APACHE_DISABLE_MPM_MSG=" sudo a2dismod mpm_worker ;"
144 # else mpm_prefork: a2enmod mpm_itk works
146 # else Apache 2.2: a2enmod mpm_itk works
151 Koha requires mpm_itk to be enabled within Apache in order to run.
152 Typically this can be enabled with:
154 $APACHE_DISABLE_MPM_MSG sudo a2enmod mpm_itk
160 # Check that mod_rewrite is installed and enabled.
161 if ! /usr/sbin/apachectl -M 2> /dev/null | grep -q 'rewrite_module'; then
164 Koha requires mod_rewrite to be enabled within Apache in order to run.
165 Typically this can be enabled with:
173 set_biblios_indexing_mode()
175 local indexing_mode=$1
178 case $indexing_mode in
180 START_BIBLIOS_RETRIEVAL_INFO=`cat <<EOF
181 <xi:include href="\/etc\/koha\/$marc_format-retrieval-info-bib-dom.xml"\n
182 xmlns:xi="http:\/\/www.w3.org\/2001\/XInclude">\n
187 END_BIBLIOS_RETRIEVAL_INFO=`cat <<EOF
192 BIBLIOS_INDEXING_MODE="dom"
193 ZEBRA_BIBLIOS_CFG="zebra-biblios-dom.cfg"
196 START_BIBLIOS_RETRIEVAL_INFO=" <retrievalinfo>"
197 END_BIBLIOS_RETRIEVAL_INFO=" <\/retrievalinfo>"
198 BIBLIOS_INDEXING_MODE="grs1"
199 ZEBRA_BIBLIOS_CFG="zebra-biblios.cfg"
202 die "Error: '$indexing_mode' is not a valid indexing mode for bibliographic records."
208 set_authorities_indexing_mode()
210 local indexing_mode=$1
213 case $indexing_mode in
215 START_AUTHORITIES_RETRIEVAL_INFO=`cat <<EOF
216 <xi:include href="\/etc\/koha\/$marc_format-retrieval-info-auth-dom.xml"\n
217 xmlns:xi="http:\/\/www.w3.org\/2001\/XInclude">\n
222 END_AUTHORITIES_RETRIEVAL_INFO=`cat <<EOF
227 AUTHORITIES_INDEXING_MODE="dom"
228 ZEBRA_AUTHORITIES_CFG="zebra-authorities-dom.cfg"
231 START_AUTHORITIES_RETRIEVAL_INFO=" <retrievalinfo>"
232 END_AUTHORITIES_RETRIEVAL_INFO=" <\/retrievalinfo>"
233 AUTHORITIES_INDEXING_MODE="grs1"
234 ZEBRA_AUTHORITIES_CFG="zebra-authorities.cfg"
237 die "Error: '$indexing_mode' is not a valid indexing mode for authority records."
247 if [ "$CLO_MEMCACHED_SERVERS" != "" ]; then
248 MEMCACHED_SERVERS=$CLO_MEMCACHED_SERVERS
250 if [ "$MEMCACHED_SERVERS" = "" ]; then
251 MEMCACHED_SERVERS=$DEFAULT_MEMCACHED_SERVERS
252 # else: was set by the koha-sites.conf file
256 if [ "$CLO_MEMCACHED_PREFIX" != "" ]; then
257 MEMCACHED_NAMESPACE="$CLO_MEMCACHED_PREFIX$instance"
259 if [ "$MEMCACHED_PREFIX" != "" ]; then
260 MEMCACHED_NAMESPACE="$MEMCACHED_PREFIX$instance"
262 MEMCACHED_NAMESPACE="$DEFAULT_MEMCACHED_PREFIX$instance"
268 # Set defaults and read config file, if it exists.
277 ZEBRA_MARC_FORMAT="marc21"
280 PASSWDFILE="/etc/koha/passwd"
282 # memcached variables
286 # hardcoded memcached defaults
287 DEFAULT_MEMCACHED_SERVERS="127.0.0.1:11211"
288 DEFAULT_MEMCACHED_PREFIX="koha_"
290 # Indexing mode variables (default is DOM)
291 BIBLIOS_INDEXING_MODE="dom"
292 AUTHORITIES_INDEXING_MODE="dom"
294 START_BIBLIOS_RETRIEVAL_INFO=""
295 END_BIBLIOS_RETRIEVAL_INFO=""
296 START_AUTHORITIES_RETRIEVAL_INFO=""
297 END_AUTHORITIES_RETRIEVAL_INFO=""
299 if [ -e /etc/koha/koha-sites.conf ]
301 . /etc/koha/koha-sites.conf
304 [ $# -ge 1 ] && [ $# -le 16 ] || ( usage ; die "Error: wrong parameters" )
306 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:, \
309 # Note the quotes around `$TEMP': they are essential!
312 # Temporary variables for the command line options
313 CLO_ZEBRA_MARC_FORMAT=""
314 CLO_ZEBRA_LANGUAGE=""
317 CLO_BIBLIOS_INDEXING_MODE=""
318 CLO_AUTHORITIES_INDEXING_MODE=""
319 CLO_MEMCACHED_SERVERS=""
320 CLO_MEMCACHED_PREFIX=""
328 op=request ; shift ;;
330 op=populate ; shift ;;
334 USE_MEMCACHED="yes" ; shift ;;
336 CLO_MEMCACHED_SERVERS="$2" ; shift 2 ;;
338 CLO_MEMCACHED_PREFIX="$2" ; shift 2;;
340 CLO_ZEBRA_MARC_FORMAT="$2" ; shift 2 ;;
342 CLO_ZEBRA_LANGUAGE="$2" ; shift 2 ;;
344 CLO_AUTHORITIES_INDEXING_MODE="$2" ; shift 2 ;;
346 CLO_BIBLIOS_INDEXING_MODE="$2" ; shift 2 ;;
348 CLO_DEFAULTSQL="$2" ; shift 2 ;;
350 configfile="$2" ; shift 2 ;;
352 CLO_PASSWDFILE="$2" ; shift 2 ;;
354 CLO_DATABASE="$2" ; shift 2 ;;
356 CLO_ADMINUSER="$2" ; shift 2 ;;
362 die "Internal error processing command line arguments" ;;
366 # Load the configfile given on the command line
367 if [ "$configfile" != "" ]
369 if [ -e "$configfile" ]
373 die "$configfile does not exist.";
377 # Make sure options from the command line get the highest precedence
378 if [ "$CLO_ZEBRA_MARC_FORMAT" != "" ]
380 ZEBRA_MARC_FORMAT="$CLO_ZEBRA_MARC_FORMAT"
382 if [ "$CLO_ZEBRA_LANGUAGE" != "" ]
384 ZEBRA_LANGUAGE="$CLO_ZEBRA_LANGUAGE"
386 if [ "$CLO_DEFAULTSQL" != "" ]
388 DEFAULTSQL="$CLO_DEFAULTSQL"
390 if [ "$CLO_ADMINUSER" != "" ]
392 ADMINUSER="$CLO_ADMINUSER"
394 if [ "$CLO_PASSWDFILE" != "" ]
396 PASSWDFILE="$CLO_PASSWDFILE"
399 if [ "$CLO_BIBLIOS_INDEXING_MODE" != "" ]; then
400 BIBLIOS_INDEXING_MODE=$CLO_BIBLIOS_INDEXING_MODE
403 set_biblios_indexing_mode $BIBLIOS_INDEXING_MODE $ZEBRA_MARC_FORMAT
406 if [ "$CLO_AUTHORITIES_INDEXING_MODE" != "" ]; then
407 AUTHORITIES_INDEXING_MODE=$CLO_AUTHORITIES_INDEXING_MODE
410 set_authorities_indexing_mode $AUTHORITIES_INDEXING_MODE $ZEBRA_MARC_FORMAT
414 if [ "$USE_MEMCACHED" = "yes" ]; then
416 elif [ "$CLO_MEMCACHED_SERVERS" != "" ] || \
417 [ "$CLO_MEMCACHED_PREFIX" != "" ]; then
421 Error: you provided memcached configuration switches but memcached is not enabled.
422 Please set USE_MEMCACHED="yes" on /etc/koha/koha-sites.conf or use the
423 --use-memcached option switch to enable it.
429 # Unset memcached-related variables
434 # Are we root? If not, the mod_rewrite check will fail and be confusing, so
435 # we look into this first.
438 die "This script must be run with root privileges."
441 # Check everything is ok with Apache, die otherwise
444 opacdomain="$OPACPREFIX$name$OPACSUFFIX$DOMAIN"
445 intradomain="$INTRAPREFIX$name$INTRASUFFIX$DOMAIN"
448 if [ -f $PASSWDFILE ] && [ `cat $PASSWDFILE | grep "^$name:"` ]
450 passwdline=`cat $PASSWDFILE | grep "^$name:"`
451 mysqluser=`echo $passwdline | cut -d ":" -f 2`
452 mysqlpwd=`echo $passwdline | cut -d ":" -f 3`
453 mysqldb=`echo $passwdline | cut -d ":" -f 4`
456 # The order of precedence for MySQL database name is:
457 # default < passwd file < command line
458 if [ "$mysqldb" = "" ]
462 if [ "$CLO_DATABASE" != "" ]
464 mysqldb="$CLO_DATABASE"
467 if [ "$mysqluser" = "" ]
469 mysqluser="koha_$name"
471 mysqlhost="$(getmysqlhost)"
473 if [ "$op" = create ] || [ "$op" = request ] || [ "$op" = use ]
475 if [ "$mysqlpwd" = "" ]
477 mysqlpwd="$(pwgen -s 16 1)"
480 mysqlpwd="$(getinstancemysqlpassword $name)"
484 if [ "$op" = create ] || [ "$op" = request ] || [ "$op" = use ]
486 # Create new user and group.
487 username="$name-koha"
488 if getent passwd "$username" > /dev/null
490 die "User $username already exists."
492 if getent group "$username" > /dev/null
494 die "Group $username already exists."
496 adduser --no-create-home --disabled-login \
497 --gecos "Koha instance $username" \
498 --home "/var/lib/koha/$name" \
501 # Create the site-specific directories.
502 koha-create-dirs "$name"
504 # Generate Zebra database password.
505 zebrapwd="$(pwgen -s 16 1)"
506 # Future enhancement: make this configurable for when your db is on
508 mysql_hostname="localhost"
509 # Set up MySQL database for this instance.
510 if [ "$op" = create ]
512 mysql --defaults-extra-file=/etc/mysql/koha-common.cnf <<eof
513 CREATE DATABASE \`$mysqldb\`;
514 CREATE USER \`$mysqluser\`@'$mysql_hostname' IDENTIFIED BY '$mysqlpwd';
515 CREATE USER \`$mysqluser\`@'%' IDENTIFIED BY '$mysqlpwd';
516 GRANT ALL PRIVILEGES ON \`$mysqldb\`.* TO \`$mysqluser\`;
523 mysql --defaults-extra-file=/etc/mysql/koha-common.cnf --force <<eof
524 CREATE USER \`$mysqluser\`@'$mysql_hostname' IDENTIFIED BY '$mysqlpwd';
525 CREATE USER \`$mysqluser\`@'%' IDENTIFIED BY '$mysqlpwd';
526 GRANT ALL PRIVILEGES ON \`$mysqldb\`.* TO \`$mysqluser\`;
531 # Generate and install Apache site-available file and log dir.
532 generate_config_file apache-site.conf.in \
533 "/etc/apache2/sites-available/$name.conf"
534 mkdir "/var/log/koha/$name"
535 chown "$username:$username" "/var/log/koha/$name"
538 # Generate and install main Koha config file.
539 generate_config_file koha-conf-site.xml.in \
540 "/etc/koha/sites/$name/koha-conf.xml"
542 # Generate and install Zebra config files.
543 generate_config_file zebra-biblios-site.cfg.in \
544 "/etc/koha/sites/$name/zebra-biblios.cfg"
545 generate_config_file zebra-biblios-dom-site.cfg.in \
546 "/etc/koha/sites/$name/zebra-biblios-dom.cfg"
547 generate_config_file zebra-authorities-site.cfg.in \
548 "/etc/koha/sites/$name/zebra-authorities.cfg"
549 generate_config_file zebra-authorities-dom-site.cfg.in \
550 "/etc/koha/sites/$name/zebra-authorities-dom.cfg"
551 generate_config_file zebra.passwd.in \
552 "/etc/koha/sites/$name/zebra.passwd"
555 # Create a GPG-encrypted file for requesting a DB to be set up.
556 if [ "$op" = request ]
558 touch "$name-db-request.txt"
559 chmod 0600 "$name-db-request.txt"
560 cat > "$name-db-request.txt" << eof
561 Please create a MySQL database and user on $mysqlhost as follows:
563 database name: $mysqldb
564 database user: $mysqluser
570 echo "See $name-db-request.txt for database creation request."
571 echo "Please forward it to the right person, and then run"
572 echo "$0 --populate-db $name"
578 if [ "$op" = create ] || [ "$op" = populate ]
580 # Re-fetch the passwords from the config we've generated, allows it
581 # to be different from what we set, in case the user had to change
583 mysqluser=$(getinstancemysqluser $name)
584 mysqldb=$(getinstancemysqldatabase $name)
585 # Use the default database content if that exists.
586 if [ -e "$DEFAULTSQL" ]
588 # Populate the database with default content.
590 sed "s/__KOHASITE__/$name/g" |
591 mysql --host="$mysqlhost" --user="$mysqluser" --password="$mysqlpwd" "$mysqldb"
594 # Change the default user's password.
595 staffpass="$(pwgen 12 1)"
596 staffdigest=$(echo -n "$staffpass" |
598 use Digest::MD5 qw(md5_base64);
599 while (<>) { print md5_base64($_), "\n"; }')
600 mysql --host="$mysqlhost" --user="$mysqluser" \
601 --password="$mysqlpwd" <<eof
604 SET password = '$staffdigest'
605 WHERE borrowernumber = $ADMINUSER;
608 echo "staff user password is '$staffpass' but keep that secret"
610 # Upgrade the database schema, just in case the dump was from an
612 koha-upgrade-schema "$name"
614 echo "Koha instance is empty, no staff user created."
619 if [ "$op" = create ] || [ "$op" = populate ] || [ "$op" = use ]
621 # Reconfigure Apache.
623 a2ensite "$name" > /dev/null 2>&1 ||
624 a2ensite "${name}.conf" > /dev/null 2>&1
626 echo "Warning: problem enabling $name in Apache" >&2
628 service apache2 restart
631 koha-start-zebra "$name"
635 if [ "$op" = request ]
642 Email for this instance is disabled. When you're ready to enable it, use:
643 koha-email-enable $name