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