b21e472a60afb432da12f68ed628036defe45c00
[srvgit] / debian / scripts / koha-create
1 #!/bin/bash
2 #
3 # koha-create -- Create a new Koha instance.
4 # Copyright 2010  Catalyst IT, Ltd
5
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.
10
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.
15
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/>.
18
19 # Read configuration variable file if it is present
20 [ -r /etc/default/koha-common ] && . /etc/default/koha-common
21
22 set -e
23
24 # include helper functions
25 if [ -f "/usr/share/koha/bin/koha-functions.sh" ]; then
26     . "/usr/share/koha/bin/koha-functions.sh"
27 else
28     echo "Error: /usr/share/koha/bin/koha-functions.sh not present." 1>&2
29     exit 1
30 fi
31
32 usage()
33 {
34     local scriptname=$0
35     cat <<EOF
36
37 Creates new Koha instances.
38
39 Usage:
40
41   $scriptname [DB usage mode] [options] instancename
42
43 DB usage mode:
44   --create-db               Create a new database on localhost. (default).
45   --request-db              Creates a instancename-db-request.txt file where
46                             you adjust your DB settings and re-run with --populate-db.
47   --populate-db             Finish the installation you started with --request-db after
48                             you adjusted the instancename-db-request.txt file.
49   --use-db                  Use this option if you already created and populated your DB.
50
51 Options:
52   --marcflavor flavor       Set the MARC flavor. Valid values are marc21 (default),
53                             normarc and unimarc.
54   --zebralang lang          Choose the primary language for Zebra indexing. Valid
55                             values are cs, en (default), es, fr, gr, nb, ru and uk.
56   --auth-idx idx_mode       Set the indexing mode for authority records. Valid
57                             values are dom (default) and grs1.
58   --biblio-idx idx_mode     Set the indexing mode for bibliographic records.
59                             Valid values are dom (default) and grs1.
60   --use-memcached           Set the instance to make use of memcache.
61   --memcached-servers str   Set a comma-separated list of host:port memcached servers.
62   --memcached-prefix str    Set the desired prefix for the instance memcached namespace.
63   --enable-sru              Enable the Z39.50/SRU server (default: disabled).
64   --sru-port                Specifiy a TCP port number for the Z39.50/SRU server
65                             to listen on. (default: 7090).
66   --defaultsql some.sql     Specify a default SQL file to be loaded on the DB.
67   --configfile cfg_file     Specify an alternate config file for reading default values.
68   --passwdfile passwd       Specify an alternate passwd file.
69   --database dbname         Enforce the use of the specified DB name (64 char limit)
70   --adminuser n             Explicit the admin user ID in the DB. Relevant in
71                             conjunction with --defaultsql and --populate-db.
72   --upload-path dir         Set a user defined upload_path. It defaults to
73                             /var/lib/koha/<instance>/uploads
74   --letsencrypt             Set up a https-only site with letsencrypt certificates
75   --help,-h                 Show this help.
76
77 Note: the instance name cannot be longer that 11 chars.
78
79 EOF
80 }
81
82 # UPPER CASE VARIABLES - from configfile or default value
83 # lower case variables - generated within this script
84 generate_config_file() {
85     touch "$2"
86     chown "root:$username" "$2"
87     chmod 0640 "$2"
88     sed -e "s/__KOHA_CONF_DIR__/\/etc\/koha\/sites\/$name/g" \
89         -e "s/__KOHASITE__/$name/g" \
90         -e "s/__OPACPORT__/$OPACPORT/g" \
91         -e "s/__INTRAPORT__/$INTRAPORT/g" \
92         -e "s/__OPACSERVER__/$opacdomain/g" \
93         -e "s/__INTRASERVER__/$intradomain/g" \
94         -e "s/__ZEBRA_PASS__/$zebrapwd/g" \
95         -e "s/__ZEBRA_MARC_FORMAT__/$ZEBRA_MARC_FORMAT/g" \
96         -e "s/__ZEBRA_LANGUAGE__/$ZEBRA_LANGUAGE/g" \
97         -e "s/__SRU_BIBLIOS_PORT__/$SRU_SERVER_PORT/g" \
98         -e "s/__START_SRU_PUBLICSERVER__/$START_SRU_PUBLICSERVER/g" \
99         -e "s/__END_SRU_PUBLICSERVER__/$END_SRU_PUBLICSERVER/g" \
100         -e "s/__BIBLIOS_INDEXING_MODE__/$BIBLIOS_INDEXING_MODE/g" \
101         -e "s/__AUTHORITIES_INDEXING_MODE__/$AUTHORITIES_INDEXING_MODE/g" \
102         -e "s/__ZEBRA_BIBLIOS_CFG__/$ZEBRA_BIBLIOS_CFG/g" \
103         -e "s/__ZEBRA_AUTHORITIES_CFG__/$ZEBRA_AUTHORITIES_CFG/g" \
104         -e "s/__START_BIBLIOS_RETRIEVAL_INFO__/`echo $START_BIBLIOS_RETRIEVAL_INFO`/g" \
105         -e "s/__END_BIBLIOS_RETRIEVAL_INFO__/`echo $END_BIBLIOS_RETRIEVAL_INFO`/g" \
106         -e "s/__START_AUTHORITIES_RETRIEVAL_INFO__/`echo $START_AUTHORITIES_RETRIEVAL_INFO`/g" \
107         -e "s/__END_AUTHORITIES_RETRIEVAL_INFO__/`echo $END_AUTHORITIES_RETRIEVAL_INFO`/g" \
108         -e "s/__API_SECRET__/$API_SECRET/g" \
109         -e "s/__DB_NAME__/$mysqldb/g" \
110         -e "s/__DB_HOST__/$mysqlhost/g" \
111         -e "s/__DB_USER__/$mysqluser/g" \
112         -e "s/__DB_PASS__/$mysqlpwd/g" \
113         -e "s/__UNIXUSER__/$username/g" \
114         -e "s/__UNIXGROUP__/$username/g" \
115         -e "s#__UPLOAD_PATH__#$UPLOAD_PATH#g" \
116         -e "s/__LOG_DIR__/\/var\/log\/koha\/$name/g" \
117         -e "s/__PLUGINS_DIR__/\/var\/lib\/koha\/$name\/plugins/g" \
118         -e "s/__MEMCACHED_NAMESPACE__/$MEMCACHED_NAMESPACE/g" \
119         -e "s/__MEMCACHED_SERVERS__/$MEMCACHED_SERVERS/g" \
120         "/etc/koha/$1" > "$2"
121
122 }
123
124 getmysqlhost() {
125     awk '
126         /^\[/ { inclient = 0 }
127         /^\[client\]/ { inclient = 1 }
128         inclient && /^ *host *=/ { print $3 }' \
129         /etc/mysql/koha-common.cnf
130 }
131
132 getinstancemysqlpassword() {
133     xmlstarlet sel -t -v 'yazgfs/config/pass' "/etc/koha/sites/$1/koha-conf.xml"
134 }
135
136 getinstancemysqluser() {
137     xmlstarlet sel -t -v 'yazgfs/config/user' "/etc/koha/sites/$1/koha-conf.xml"
138 }
139
140 getinstancemysqldatabase() {
141     xmlstarlet sel -t -v 'yazgfs/config/database' "/etc/koha/sites/$1/koha-conf.xml"
142 }
143
144 check_apache_config()
145 {
146
147     # Check that mpm_itk is installed and enabled
148     if ! /usr/sbin/apachectl -M 2> /dev/null | grep -q 'mpm_itk'; then
149         # Check Apache version
150         APACHE_DISABLE_MPM_MSG=""
151         if /usr/sbin/apache2ctl -v | grep -q "Server version: Apache/2.4"; then
152             # mpm_event or mpm_worker need to be disabled first. mpm_itk depends
153             # on mpm_prefork, which is enabled if needed. See
154             # https://bugs.debian.org/cgi-bin/bugreport.cgi?bug=734865
155             if /usr/sbin/apachectl -M 2> /dev/null | grep -q 'mpm_event'; then
156                 APACHE_DISABLE_MPM_MSG=" sudo a2dismod mpm_event ;"
157             elif /usr/sbin/apachectl -M 2> /dev/null | grep -q 'mpm_worker'; then
158                 APACHE_DISABLE_MPM_MSG=" sudo a2dismod mpm_worker ;"
159             # else mpm_prefork: a2enmod mpm_itk works
160             fi
161         # else Apache 2.2: a2enmod mpm_itk works
162         fi
163
164         cat 1>&2  <<EOM
165
166 Koha requires mpm_itk to be enabled within Apache in order to run.
167 Typically this can be enabled with:
168
169    $APACHE_DISABLE_MPM_MSG sudo a2enmod mpm_itk
170 EOM
171
172         die
173     fi
174
175     # Check that mod_rewrite is installed and enabled.
176     if ! /usr/sbin/apachectl -M 2> /dev/null | grep -q 'rewrite_module'; then
177         cat 1>&2  <<EOM
178
179 Koha requires mod_rewrite to be enabled within Apache in order to run.
180 Typically this can be enabled with:
181
182     sudo a2enmod rewrite
183 EOM
184         die
185     fi
186
187     # Check that the CGI module is installed and enabled
188     # (Apache 2.4 may not have it by default.)
189     if ! /usr/sbin/apachectl -M 2> /dev/null | grep -q 'cgi_module'; then
190         cat 1>&2 << EOM
191 Koha requires mod_cgi to be enabled within Apache in order to run.
192 Typically this can be enabled with:
193
194     sudo a2enmod cgi
195 EOM
196         die
197     fi
198
199     # Check that mod_ssl is installed and enabled.
200     if [ "$CLO_LETSENCRYPT" = "yes" ]; then
201         if ! /usr/sbin/apachectl -M 2> /dev/null | grep -q 'ssl_module'; then
202             cat 1>&2  <<EOM
203
204 Koha requires mod_ssl to be enabled within Apache in order to run with --letsencrypt.
205 Typically this can be enabled with:
206
207     sudo a2enmod ssl
208 EOM
209             die
210         fi
211     fi
212
213 }
214
215 set_biblios_indexing_mode()
216 {
217     local indexing_mode=$1
218     local marc_format=$2
219
220     case $indexing_mode in
221         "dom")
222             START_BIBLIOS_RETRIEVAL_INFO=`cat <<EOF
223     <xi:include href="\/etc\/koha\/$marc_format-retrieval-info-bib-dom.xml"\n
224                 xmlns:xi="http:\/\/www.w3.org\/2001\/XInclude">\n
225      <xi:fallback>\n
226       <retrievalinfo>
227 EOF`
228
229             END_BIBLIOS_RETRIEVAL_INFO=`cat <<EOF
230       <\/retrievalinfo>\n
231      <\/xi:fallback>\n
232     <\/xi:include>
233 EOF`
234             BIBLIOS_INDEXING_MODE="dom"
235             ZEBRA_BIBLIOS_CFG="zebra-biblios-dom.cfg"
236             ;;
237         "grs1")
238             START_BIBLIOS_RETRIEVAL_INFO="    <retrievalinfo>"
239             END_BIBLIOS_RETRIEVAL_INFO="    <\/retrievalinfo>"
240             BIBLIOS_INDEXING_MODE="grs1"
241             ZEBRA_BIBLIOS_CFG="zebra-biblios.cfg"
242             ;;
243         *)
244             die "Error: '$indexing_mode' is not a valid indexing mode for bibliographic records."
245             ;;
246     esac
247 }
248
249
250 set_authorities_indexing_mode()
251 {
252     local indexing_mode=$1
253     local marc_format=$2
254
255     case $indexing_mode in
256         "dom")
257             START_AUTHORITIES_RETRIEVAL_INFO=`cat <<EOF
258     <xi:include href="\/etc\/koha\/$marc_format-retrieval-info-auth-dom.xml"\n
259                 xmlns:xi="http:\/\/www.w3.org\/2001\/XInclude">\n
260      <xi:fallback>\n
261       <retrievalinfo>
262 EOF`
263
264             END_AUTHORITIES_RETRIEVAL_INFO=`cat <<EOF
265       <\/retrievalinfo>\n
266      <\/xi:fallback>\n
267     <\/xi:include>\n
268 EOF`
269             AUTHORITIES_INDEXING_MODE="dom"
270             ZEBRA_AUTHORITIES_CFG="zebra-authorities-dom.cfg"
271             ;;
272         "grs1")
273             START_AUTHORITIES_RETRIEVAL_INFO="    <retrievalinfo>"
274             END_AUTHORITIES_RETRIEVAL_INFO="    <\/retrievalinfo>"
275             AUTHORITIES_INDEXING_MODE="grs1"
276             ZEBRA_AUTHORITIES_CFG="zebra-authorities.cfg"
277             ;;
278         *)
279             die "Error: '$indexing_mode' is not a valid indexing mode for authority records."
280             ;;
281     esac
282 }
283
284
285 set_memcached()
286 {
287     local instance="$1"
288
289     if [ "$CLO_MEMCACHED_SERVERS" != "" ]; then
290         MEMCACHED_SERVERS=$CLO_MEMCACHED_SERVERS
291     else
292         if [ "$MEMCACHED_SERVERS" = "" ]; then
293             MEMCACHED_SERVERS=$DEFAULT_MEMCACHED_SERVERS
294         # else: was set by the koha-sites.conf file
295         fi
296     fi
297
298     if [ "$CLO_MEMCACHED_PREFIX" != "" ]; then
299         MEMCACHED_NAMESPACE="$CLO_MEMCACHED_PREFIX$instance"
300     else
301         if [ "$MEMCACHED_PREFIX" != "" ]; then
302             MEMCACHED_NAMESPACE="$MEMCACHED_PREFIX$instance"
303         else
304             MEMCACHED_NAMESPACE="$DEFAULT_MEMCACHED_PREFIX$instance"
305         fi
306     fi
307
308 }
309
310 set_upload_path()
311 {
312     local instance="$1"
313
314     if [ "$CLO_UPLOAD_PATH" != "" ]; then
315         UPLOAD_PATH=$CLO_UPLOAD_PATH
316     else
317         UPLOAD_PATH="$UPLOAD_PATH_BASE/$instance/$UPLOAD_DIR"
318     fi
319 }
320
321 enable_sru_server()
322 {
323     # remove the commenting symbols
324     START_SRU_PUBLICSERVER=""
325     END_SRU_PUBLICSERVER=""
326     if [ "$SRU_SERVER_PORT" = "" ]; then
327         # --sru-port not passed, use the default
328         SRU_SERVER_PORT=$DEFAULT_SRU_SERVER_PORT
329     fi
330 }
331
332 check_letsencrypt()
333 {
334     if [ $(dpkg-query -W -f='${Status}' letsencrypt 2>/dev/null | grep -c "ok installed") -eq 0 ]; then
335         set +e
336         apt-cache show letsencrypt &>/dev/null
337         local aptcacheshow=$?
338         set -e
339         if [ $aptcacheshow -eq 0 ]; then
340                 read -r -p "The letsencrypt package is not installed. Do it now?  [y/N] " response
341                 if [[ $response =~ ^([yY][eE][sS]|[yY])$ ]]; then
342                     local debrelease="$(lsb_release -c -s)"
343                     if [ $debrelease = "jessie" ]; then
344                         apt-get install -y -t jessie-backports letsencrypt
345                     else
346                         apt-get install -y letsencrypt
347                     fi
348                 else
349                     die "You have to install letsencrypt to use the --letsencrypt parameter."
350                 fi
351         else
352             echo "No installation candidate available for package letsencrypt."
353             if [[ -f /usr/bin/letsencrypt ]]; then
354                 read -r -p "If you have a symlink from /usr/bin/letsencrypt to letsencrypt-auto, it should work. [y/N] " response
355                 if [[ ! $response =~ ^([yY][eE][sS]|[yY])$ ]]; then
356                     die "You have to install letsencrypt to use the --letsencrypt parameter."
357                 fi
358             else
359                 die "You can create a symlink from /usr/bin/letsencrypt to letsencrypt-auto."
360             fi
361         fi
362     fi
363 }
364
365 letsencrypt_instance()
366 {
367     # Get letsencrypt certificates
368     letsencrypt --agree-tos --renew-by-default --webroot certonly \
369         -w /usr/share/koha/opac/htdocs/ -d $opacdomain -w /usr/share/koha/intranet/htdocs/ -d $intradomain
370     # enable all ssl settings (apache won't start with these before certs are present)
371     sed -i "s:^\s*#\(\s*SSL.*\)$:\1:" "/etc/apache2/sites-available/$name.conf"
372     # change port from 80 to 443. (apache won't start if it is 443 without certs present)
373     sed -i "s:^\s*\(<VirtualHost \*\:\)80> #https$:\1443>:" "/etc/apache2/sites-available/$name.conf"
374     # enable redirect from http to https on port 80
375     sed -i "s:^\s*#\(.*\)#nohttps$:\1:" "/etc/apache2/sites-available/$name.conf"
376     # make koha-list --letsencrypt aware of this instance # could be done by checking apache conf instead
377     echo -e "opacdomain=\"$opacdomain\"\nintradomain=\"$intradomain\"" > /var/lib/koha/$name/letsencrypt.enabled
378     # restart apache with working certs
379     service apache2 restart
380 }
381
382 # Set defaults and read config file, if it exists.
383 DOMAIN=""
384 OPACPORT="80"
385 OPACPREFIX=""
386 OPACSUFFIX=""
387 INTRAPORT="8080"
388 INTRAPREFIX=""
389 INTRASUFFIX=""
390 DEFAULTSQL=""
391 ZEBRA_MARC_FORMAT="marc21"
392 ZEBRA_LANGUAGE="en"
393 ADMINUSER="1"
394 PASSWDFILE="/etc/koha/passwd"
395
396 # memcached variables
397 USE_MEMCACHED="no"
398 MEMCACHED_SERVERS=""
399 MEMCACHED_PREFIX=""
400 # hardcoded memcached defaults
401 DEFAULT_MEMCACHED_SERVERS="127.0.0.1:11211"
402 DEFAULT_MEMCACHED_PREFIX="koha_"
403 # hardcoded upload_path
404 UPLOAD_PATH_BASE="/var/lib/koha"
405 UPLOAD_DIR="uploads"
406 UPLOAD_PATH=""
407 # Generate a randomizaed API secret
408 API_SECRET="$(pwgen -s 64 1)"
409 # SRU server variables
410 ENABLE_SRU="no"
411 SRU_SERVER_PORT=""
412 # hardcoded default SRU server port
413 DEFAULT_SRU_SERVER_PORT="7090"
414 START_SRU_PUBLICSERVER="<!--"
415 END_SRU_PUBLICSERVER="-->"
416
417 # Indexing mode variables (default is DOM)
418 BIBLIOS_INDEXING_MODE="dom"
419 AUTHORITIES_INDEXING_MODE="dom"
420
421 START_BIBLIOS_RETRIEVAL_INFO=""
422 END_BIBLIOS_RETRIEVAL_INFO=""
423 START_AUTHORITIES_RETRIEVAL_INFO=""
424 END_AUTHORITIES_RETRIEVAL_INFO=""
425
426 APACHE_CONFIGFILE=""
427
428 if [ -e /etc/koha/koha-sites.conf ]
429 then
430     . /etc/koha/koha-sites.conf
431 fi
432
433 [ $# -ge 1 ] && [ $# -le 16 ] || ( usage ; die "Error: wrong parameters" )
434
435 TEMP=`getopt -o chrpm:l:d:f:b:a: -l create-db,request-db,populate-db,use-db,use-memcached,enable-sru,sru-port:,help,marcflavor:,auth-idx:,biblio-idx:,zebralang:,defaultsql:,configfile:,passwdfile:,database:,adminuser:,memcached-servers:,memcached-prefix:,upload-path:,letsencrypt, \
436      -n "$0" -- "$@"`
437
438 # Note the quotes around `$TEMP': they are essential!
439 eval set -- "$TEMP"
440
441 # Temporary variables for the command line options
442 CLO_ZEBRA_MARC_FORMAT=""
443 CLO_ZEBRA_LANGUAGE=""
444 CLO_DEFAULTSQL=""
445 CLO_ADMINUSER=""
446 CLO_BIBLIOS_INDEXING_MODE=""
447 CLO_AUTHORITIES_INDEXING_MODE=""
448 CLO_MEMCACHED_SERVERS=""
449 CLO_MEMCACHED_PREFIX=""
450 CLO_UPLOAD_PATH=""
451 CLO_LETSENCRYPT=""
452
453 while true ; do
454     case "$1" in
455         -c|--create-db)
456             op=create ; shift ;;
457         -r|--request-db)
458             op=request ; shift ;;
459         -p|--populate-db)
460             op=populate ; shift ;;
461         -u|--use-db)
462             op=use ; shift ;;
463         --use-memcached)
464             USE_MEMCACHED="yes" ; shift ;;
465         --memcached-servers)
466             CLO_MEMCACHED_SERVERS="$2" ; shift 2 ;;
467         --memcached-prefix)
468             CLO_MEMCACHED_PREFIX="$2" ; shift 2;;
469         -m|--marcflavor)
470             CLO_ZEBRA_MARC_FORMAT="$2" ; shift 2 ;;
471         -l|--zebralang)
472             CLO_ZEBRA_LANGUAGE="$2" ; shift 2 ;;
473         --auth-idx)
474             CLO_AUTHORITIES_INDEXING_MODE="$2" ; shift 2 ;;
475         --biblio-idx)
476             CLO_BIBLIOS_INDEXING_MODE="$2" ; shift 2 ;;
477         -d|--defaultsql)
478             CLO_DEFAULTSQL="$2" ; shift 2 ;;
479         -f|--configfile)
480             configfile="$2" ; shift 2 ;;
481         -s|--passwdfile)
482             CLO_PASSWDFILE="$2" ; shift 2 ;;
483         -b|--database)
484             CLO_DATABASE="$2" ; shift 2 ;;
485         -a|--adminuser)
486             CLO_ADMINUSER="$2" ; shift 2 ;;
487         --enable-sru)
488             ENABLE_SRU="yes" ; shift ;;
489         --sru-port)
490             SRU_SERVER_PORT="$2" ; shift 2 ;;
491         --upload-path)
492             CLO_UPLOAD_PATH="$2" ; shift 2 ;;
493         --letsencrypt)
494             CLO_LETSENCRYPT="yes" ; shift ;;
495         -h|--help)
496             usage ; exit 0 ;;
497         --)
498             shift ; break ;;
499         *)
500             die "Internal error processing command line arguments" ;;
501     esac
502 done
503
504 # Load the configfile given on the command line
505 if [ "$configfile" != "" ]
506 then
507     if [ -e "$configfile" ]
508     then
509         . "$configfile"
510     else
511         die "$configfile does not exist.";
512     fi
513 fi
514
515 # Make sure options from the command line get the highest precedence
516 if [ "$CLO_ZEBRA_MARC_FORMAT" != "" ]
517 then
518     ZEBRA_MARC_FORMAT="$CLO_ZEBRA_MARC_FORMAT"
519 fi
520 if [ "$CLO_ZEBRA_LANGUAGE" != "" ]
521 then
522     ZEBRA_LANGUAGE="$CLO_ZEBRA_LANGUAGE"
523 fi
524 if [ "$CLO_DEFAULTSQL" != "" ]
525 then
526     DEFAULTSQL="$CLO_DEFAULTSQL"
527 fi
528 if [ "$CLO_ADMINUSER" != "" ]
529 then
530     ADMINUSER="$CLO_ADMINUSER"
531 fi
532 if [ "$CLO_PASSWDFILE" != "" ]
533 then
534     PASSWDFILE="$CLO_PASSWDFILE"
535 fi
536
537 if [ "$CLO_BIBLIOS_INDEXING_MODE" !=  "" ]; then
538     BIBLIOS_INDEXING_MODE=$CLO_BIBLIOS_INDEXING_MODE
539 fi
540
541 set_biblios_indexing_mode $BIBLIOS_INDEXING_MODE $ZEBRA_MARC_FORMAT
542
543 if [ "$ENABLE_SRU" != "no" ]; then
544     enable_sru_server
545 fi
546
547 if [ "$CLO_AUTHORITIES_INDEXING_MODE" !=  "" ]; then
548     AUTHORITIES_INDEXING_MODE=$CLO_AUTHORITIES_INDEXING_MODE
549 fi
550
551 set_authorities_indexing_mode $AUTHORITIES_INDEXING_MODE $ZEBRA_MARC_FORMAT
552
553 name="$1"
554
555 set_upload_path $name
556
557 if [ "$USE_MEMCACHED" = "yes" ]; then
558     set_memcached $name
559 elif [ "$CLO_MEMCACHED_SERVERS" != "" ] || \
560      [ "$CLO_MEMCACHED_PREFIX" != "" ]; then
561
562     MSG=`cat <<EOF
563
564 Error: you provided memcached configuration switches but memcached is not enabled.
565 Please set USE_MEMCACHED="yes" on /etc/koha/koha-sites.conf or use the
566 --use-memcached option switch to enable it.
567
568 EOF`
569
570     usage ; die $MSG
571 else
572     # Unset memcached-related variables
573     MEMCACHED_SERVERS=""
574     MEMCACHED_PREFIX=""
575 fi
576
577 # Are we root? If not, the mod_rewrite check will fail and be confusing, so
578 # we look into this first.
579 if [[ $UID -ne 0 ]]
580 then
581     die "This script must be run with root privileges."
582 fi
583
584 # Check everything is ok with Apache, die otherwise
585 check_apache_config
586
587 opacdomain="$OPACPREFIX$name$OPACSUFFIX$DOMAIN"
588 intradomain="$INTRAPREFIX$name$INTRASUFFIX$DOMAIN"
589
590 # Check everything is ok with letsencrypt, die otherwise
591 if [ "$CLO_LETSENCRYPT" = "yes" ]; then
592     check_letsencrypt
593 fi
594
595 if [ -f $PASSWDFILE ] && [ `cat $PASSWDFILE | grep "^$name:"` ]
596 then
597     passwdline=`cat $PASSWDFILE | grep "^$name:"`
598     mysqluser=`echo $passwdline | cut -d ":" -f 2`
599     mysqlpwd=`echo $passwdline | cut -d ":" -f 3`
600     mysqldb=`echo $passwdline | cut -d ":" -f 4`
601 fi
602
603 # The order of precedence for MySQL database name is:
604 # default < passwd file < command line
605 if [ "$mysqldb" = "" ]
606 then
607     mysqldb="koha_$name"
608 fi
609 if [ "$CLO_DATABASE" != "" ]
610 then
611     mysqldb="$CLO_DATABASE"
612 fi
613
614 if [ "$mysqluser" = "" ]
615 then
616     mysqluser="koha_$name"
617 fi
618 mysqlhost="$(getmysqlhost)"
619
620 if [ "$op" = create ] || [ "$op" = request ] || [ "$op" = use ]
621 then
622     if [ "$mysqlpwd" = "" ]
623     then
624         mysqlpwd="$(pwgen -s 16 1)"
625     fi
626 else
627     mysqlpwd="$(getinstancemysqlpassword $name)"
628 fi
629
630
631 if [ "$op" = create ] || [ "$op" = request ] || [ "$op" = use ]
632 then
633     # Create new user and group.
634     username="$name-koha"
635     if getent passwd "$username" > /dev/null
636     then
637         die "User $username already exists."
638     fi
639     if getent group "$username" > /dev/null
640     then
641         die "Group $username already exists."
642     fi
643     adduser --no-create-home --disabled-login \
644         --gecos "Koha instance $username" \
645         --home "/var/lib/koha/$name" \
646         --quiet "$username"
647
648     # Create the site-specific directories.
649     koha-create-dirs "$name"
650
651     # Generate Zebra database password.
652     zebrapwd="$(pwgen -s 16 1)"
653     # Future enhancement: make this configurable for when your db is on
654     # another server.
655     mysql_hostname="localhost"
656     # Set up MySQL database for this instance.
657     if [ "$op" = create ]
658     then
659         mysql --defaults-extra-file=/etc/mysql/koha-common.cnf <<eof
660 CREATE DATABASE \`$mysqldb\`;
661 CREATE USER \`$mysqluser\`@'$mysql_hostname' IDENTIFIED BY '$mysqlpwd';
662 CREATE USER \`$mysqluser\`@'%' IDENTIFIED BY '$mysqlpwd';
663 GRANT ALL PRIVILEGES ON \`$mysqldb\`.* TO \`$mysqluser\`;
664 GRANT ALL PRIVILEGES ON \`$mysqldb\`.* TO \`$mysqluser\`@'$mysql_hostname';
665 FLUSH PRIVILEGES;
666 eof
667     fi #`
668
669     if [ "$op" = use ]
670     then
671         mysql --defaults-extra-file=/etc/mysql/koha-common.cnf --force <<eof
672 CREATE USER \`$mysqluser\`@'$mysql_hostname' IDENTIFIED BY '$mysqlpwd';
673 CREATE USER \`$mysqluser\`@'%' IDENTIFIED BY '$mysqlpwd';
674 GRANT ALL PRIVILEGES ON \`$mysqldb\`.* TO \`$mysqluser\`;
675 GRANT ALL PRIVILEGES ON \`$mysqldb\`.* TO \`$mysqluser\`@'$mysql_hostname';
676 FLUSH PRIVILEGES;
677 eof
678     fi #`
679
680     if [ "$CLO_LETSENCRYPT" = "yes" ]; then
681         APACHE_CONFIGFILE="apache-site-https.conf.in"
682     else
683         APACHE_CONFIGFILE="apache-site.conf.in"
684     fi
685     # Generate and install Apache site-available file and log dir.
686     generate_config_file $APACHE_CONFIGFILE \
687         "/etc/apache2/sites-available/$name.conf"
688     mkdir "/var/log/koha/$name"
689     chown "$username:$username" "/var/log/koha/$name"
690
691
692     # Generate and install main Koha config file.
693     generate_config_file koha-conf-site.xml.in \
694         "/etc/koha/sites/$name/koha-conf.xml"
695
696     # Generate and install the log4perl config file.
697     generate_config_file log4perl-site.conf.in \
698         "/etc/koha/sites/$name/log4perl.conf"
699
700     # Generate and install Zebra config files.
701     generate_config_file zebra-biblios-site.cfg.in \
702         "/etc/koha/sites/$name/zebra-biblios.cfg"
703     generate_config_file zebra-biblios-dom-site.cfg.in \
704         "/etc/koha/sites/$name/zebra-biblios-dom.cfg"
705     generate_config_file zebra-authorities-site.cfg.in \
706         "/etc/koha/sites/$name/zebra-authorities.cfg"
707     generate_config_file zebra-authorities-dom-site.cfg.in \
708         "/etc/koha/sites/$name/zebra-authorities-dom.cfg"
709     generate_config_file zebra.passwd.in \
710         "/etc/koha/sites/$name/zebra.passwd"
711
712
713     # Create a GPG-encrypted file for requesting a DB to be set up.
714     if [ "$op" = request ]
715     then
716         touch "$name-db-request.txt"
717         chmod 0600 "$name-db-request.txt"
718         cat > "$name-db-request.txt" << eof
719 Please create a MySQL database and user on $mysqlhost as follows:
720
721 database name: $mysqldb
722 database user: $mysqluser
723      password: $mysqlpwd
724
725 Thank you.
726 eof
727
728         echo "See $name-db-request.txt for database creation request."
729         echo "Please forward it to the right person, and then run"
730         echo "$0 --populate-db $name"
731         echo "Thanks."
732     fi
733 fi
734
735
736 if [ "$op" = create ] || [ "$op" = populate ]
737 then
738     # Re-fetch the passwords from the config we've generated, allows it
739     # to be different from what we set, in case the user had to change
740     # something.
741     mysqluser=$(getinstancemysqluser $name)
742     mysqldb=$(getinstancemysqldatabase $name)
743     # Use the default database content if that exists.
744     if [ -e "$DEFAULTSQL" ]
745     then
746         # Populate the database with default content.
747         zcat "$DEFAULTSQL" |
748         sed "s/__KOHASITE__/koha_$name/g" |
749         mysql --host="$mysqlhost" --user="$mysqluser" --password="$mysqlpwd" "$mysqldb"
750
751
752         # Change the default user's password.
753         staffpass="$(pwgen 12 1)"
754         staffdigest=$(echo -n "$staffpass" |
755                       perl -e '
756                             use Digest::MD5 qw(md5_base64); 
757                             while (<>) { print md5_base64($_), "\n"; }')
758         mysql --host="$mysqlhost" --user="$mysqluser" \
759 --password="$mysqlpwd" <<eof
760 USE \`$mysqldb\`;
761 UPDATE borrowers 
762 SET password = '$staffdigest' 
763 WHERE borrowernumber = $ADMINUSER;
764 eof
765         #`
766         echo "staff user password is '$staffpass' but keep that secret"
767
768         # Upgrade the database schema, just in case the dump was from an 
769         # old version.
770         koha-upgrade-schema "$name"
771     else
772         echo "Koha instance is empty, no staff user created."
773     fi
774 fi
775
776
777 if [ "$op" = create ] || [ "$op" = populate ] || [ "$op" = use ]
778 then
779     # Reconfigure Apache.
780     if ! {
781         a2ensite "$name" > /dev/null 2>&1 ||
782             a2ensite "${name}.conf" > /dev/null 2>&1
783     }; then
784         echo "Warning: problem enabling $name in Apache" >&2
785     fi
786     service apache2 restart
787
788     # Start Zebra.
789     koha-start-zebra "$name"
790
791     if [ "$USE_INDEXER_DAEMON" = "yes" ]; then
792         # Start Indexer daemon
793         koha-indexer --start "$name"
794     fi
795
796     if [ "$CLO_LETSENCRYPT" = "yes" ]; then
797         # Get letsencrypt certificates
798         letsencrypt_instance
799     fi
800 fi
801
802
803 if [ "$op" = request ]
804 then
805     koha-disable "$name"
806 fi
807
808 echo <<eoh
809
810 Email for this instance is disabled. When you're ready to enable it, use:
811 koha-email-enable $name
812 eoh