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                     local debrelease="$(lsb_release -c -s)"
 342                     if [ $debrelease = "jessie" ]; then
 343                         apt-get install -y -t jessie-backports letsencrypt
 344                     else
 345                         apt-get install -y letsencrypt
 346                     fi
 347                 else
 348                     die "You have to install letsencrypt to use the --letsencrypt parameter."
 349                 fi
 350         else
 351             echo "No installation candidate available for package letsencrypt."
 352             if [[ -f /usr/bin/letsencrypt ]]; then
 353                 read -r -p "If you have a symlink from /usr/bin/letsencrypt to letsencrypt-auto, it should work. [y/N] " response
 354                 if [[ ! $response =~ ^([yY][eE][sS]|[yY])$ ]]; then
 355                     die "You have to install letsencrypt to use the --letsencrypt parameter."
 356                 fi
 357             else
 358                 die "You can create a symlink from /usr/bin/letsencrypt to letsencrypt-auto."
 359             fi
 360         fi
 361     fi
 362 }
 363
 364 letsencrypt_instance()
 365 {
 366     # Get letsencrypt certificates
 367     letsencrypt --agree-tos --renew-by-default --webroot certonly \
 368         -w /usr/share/koha/opac/htdocs/ -d $opacdomain -w /usr/share/koha/intranet/htdocs/ -d $intradomain
 369     # enable all ssl settings (apache won't start with these before certs are present)
 370     sed -i "s:^\s*#\(\s*SSL.*\)$:\1:" "/etc/apache2/sites-available/$name.conf"
 371     # change port from 80 to 443. (apache won't start if it is 443 without certs present)
 372     sed -i "s:^\s*\(<VirtualHost \*\:\)80> #https$:\1443>:" "/etc/apache2/sites-available/$name.conf"
 373     # enable redirect from http to https on port 80
 374     sed -i "s:^\s*#\(.*\)#nohttps$:\1:" "/etc/apache2/sites-available/$name.conf"
 375     # make koha-list --letsencrypt aware of this instance # could be done by checking apache conf instead
 376     echo -e "opacdomain=\"$opacdomain\"\nintradomain=\"$intradomain\"" > /var/lib/koha/$name/letsencrypt.enabled
 377     # restart apache with working certs
 378     service apache2 restart
 379 }
 380
 381 # Set defaults and read config file, if it exists.
 382 DOMAIN=""
 383 OPACPORT="80"
 384 OPACPREFIX=""
 385 OPACSUFFIX=""
 386 INTRAPORT="8080"
 387 INTRAPREFIX=""
 388 INTRASUFFIX=""
 389 DEFAULTSQL=""
 390 ZEBRA_MARC_FORMAT="marc21"
 391 ZEBRA_LANGUAGE="en"
 392 ADMINUSER="1"
 393 PASSWDFILE="/etc/koha/passwd"
 394
 395 # memcached variables
 396 USE_MEMCACHED="no"
 397 MEMCACHED_SERVERS=""
 398 MEMCACHED_PREFIX=""
 399 # hardcoded memcached defaults
 400 DEFAULT_MEMCACHED_SERVERS="127.0.0.1:11211"
 401 DEFAULT_MEMCACHED_PREFIX="koha_"
 402 # hardcoded upload_path
 403 UPLOAD_PATH_BASE="/var/lib/koha"
 404 UPLOAD_DIR="uploads"
 405 UPLOAD_PATH=""
 406
 407 # SRU server variables
 408 ENABLE_SRU="no"
 409 SRU_SERVER_PORT=""
 410 # hardcoded default SRU server port
 411 DEFAULT_SRU_SERVER_PORT="7090"
 412 START_SRU_PUBLICSERVER="<!--"
 413 END_SRU_PUBLICSERVER="-->"
 414
 415 # Indexing mode variables (default is DOM)
 416 BIBLIOS_INDEXING_MODE="dom"
 417 AUTHORITIES_INDEXING_MODE="dom"
 418
 419 START_BIBLIOS_RETRIEVAL_INFO=""
 420 END_BIBLIOS_RETRIEVAL_INFO=""
 421 START_AUTHORITIES_RETRIEVAL_INFO=""
 422 END_AUTHORITIES_RETRIEVAL_INFO=""
 423
 424 APACHE_CONFIGFILE=""
 425
 426 if [ -e /etc/koha/koha-sites.conf ]
 427 then
 428     . /etc/koha/koha-sites.conf
 429 fi
 430
 431 [ $# -ge 1 ] && [ $# -le 16 ] || ( usage ; die "Error: wrong parameters" )
 432
 433 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, \
 434      -n "$0" -- "$@"`
 435
 436 # Note the quotes around `$TEMP': they are essential!
 437 eval set -- "$TEMP"
 438
 439 # Temporary variables for the command line options
 440 CLO_ZEBRA_MARC_FORMAT=""
 441 CLO_ZEBRA_LANGUAGE=""
 442 CLO_DEFAULTSQL=""
 443 CLO_ADMINUSER=""
 444 CLO_BIBLIOS_INDEXING_MODE=""
 445 CLO_AUTHORITIES_INDEXING_MODE=""
 446 CLO_MEMCACHED_SERVERS=""
 447 CLO_MEMCACHED_PREFIX=""
 448 CLO_UPLOAD_PATH=""
 449 CLO_LETSENCRYPT=""
 450
 451 while true ; do
 452     case "$1" in
 453         -c|--create-db)
 454             op=create ; shift ;;
 455         -r|--request-db)
 456             op=request ; shift ;;
 457         -p|--populate-db)
 458             op=populate ; shift ;;
 459         -u|--use-db)
 460             op=use ; shift ;;
 461         --use-memcached)
 462             USE_MEMCACHED="yes" ; shift ;;
 463         --memcached-servers)
 464             CLO_MEMCACHED_SERVERS="$2" ; shift 2 ;;
 465         --memcached-prefix)
 466             CLO_MEMCACHED_PREFIX="$2" ; shift 2;;
 467         -m|--marcflavor)
 468             CLO_ZEBRA_MARC_FORMAT="$2" ; shift 2 ;;
 469         -l|--zebralang)
 470             CLO_ZEBRA_LANGUAGE="$2" ; shift 2 ;;
 471         --auth-idx)
 472             CLO_AUTHORITIES_INDEXING_MODE="$2" ; shift 2 ;;
 473         --biblio-idx)
 474             CLO_BIBLIOS_INDEXING_MODE="$2" ; shift 2 ;;
 475         -d|--defaultsql)
 476             CLO_DEFAULTSQL="$2" ; shift 2 ;;
 477         -f|--configfile)
 478             configfile="$2" ; shift 2 ;;
 479         -s|--passwdfile)
 480             CLO_PASSWDFILE="$2" ; shift 2 ;;
 481         -b|--database)
 482             CLO_DATABASE="$2" ; shift 2 ;;
 483         -a|--adminuser)
 484             CLO_ADMINUSER="$2" ; shift 2 ;;
 485         --enable-sru)
 486             ENABLE_SRU="yes" ; shift ;;
 487         --sru-port)
 488             SRU_SERVER_PORT="$2" ; shift 2 ;;
 489         --upload-path)
 490             CLO_UPLOAD_PATH="$2" ; shift 2 ;;
 491         --letsencrypt)
 492             CLO_LETSENCRYPT="yes" ; shift ;;
 493         -h|--help)
 494             usage ; exit 0 ;;
 495         --)
 496             shift ; break ;;
 497         *)
 498             die "Internal error processing command line arguments" ;;
 499     esac
 500 done
 501
 502 # Load the configfile given on the command line
 503 if [ "$configfile" != "" ]
 504 then
 505     if [ -e "$configfile" ]
 506     then
 507         . "$configfile"
 508     else
 509         die "$configfile does not exist.";
 510     fi
 511 fi
 512
 513 # Make sure options from the command line get the highest precedence
 514 if [ "$CLO_ZEBRA_MARC_FORMAT" != "" ]
 515 then
 516     ZEBRA_MARC_FORMAT="$CLO_ZEBRA_MARC_FORMAT"
 517 fi
 518 if [ "$CLO_ZEBRA_LANGUAGE" != "" ]
 519 then
 520     ZEBRA_LANGUAGE="$CLO_ZEBRA_LANGUAGE"
 521 fi
 522 if [ "$CLO_DEFAULTSQL" != "" ]
 523 then
 524     DEFAULTSQL="$CLO_DEFAULTSQL"
 525 fi
 526 if [ "$CLO_ADMINUSER" != "" ]
 527 then
 528     ADMINUSER="$CLO_ADMINUSER"
 529 fi
 530 if [ "$CLO_PASSWDFILE" != "" ]
 531 then
 532     PASSWDFILE="$CLO_PASSWDFILE"
 533 fi
 534
 535 if [ "$CLO_BIBLIOS_INDEXING_MODE" !=  "" ]; then
 536     BIBLIOS_INDEXING_MODE=$CLO_BIBLIOS_INDEXING_MODE
 537 fi
 538
 539 set_biblios_indexing_mode $BIBLIOS_INDEXING_MODE $ZEBRA_MARC_FORMAT
 540
 541 if [ "$ENABLE_SRU" != "no" ]; then
 542     enable_sru_server
 543 fi
 544
 545 if [ "$CLO_AUTHORITIES_INDEXING_MODE" !=  "" ]; then
 546     AUTHORITIES_INDEXING_MODE=$CLO_AUTHORITIES_INDEXING_MODE
 547 fi
 548
 549 set_authorities_indexing_mode $AUTHORITIES_INDEXING_MODE $ZEBRA_MARC_FORMAT
 550
 551 name="$1"
 552
 553 set_upload_path $name
 554
 555 if [ "$USE_MEMCACHED" = "yes" ]; then
 556     set_memcached $name
 557 elif [ "$CLO_MEMCACHED_SERVERS" != "" ] || \
 558      [ "$CLO_MEMCACHED_PREFIX" != "" ]; then
 559
 560     MSG=`cat <<EOF
 561
 562 Error: you provided memcached configuration switches but memcached is not enabled.
 563 Please set USE_MEMCACHED="yes" on /etc/koha/koha-sites.conf or use the
 564 --use-memcached option switch to enable it.
 565
 566 EOF`
 567
 568     usage ; die $MSG
 569 else
 570     # Unset memcached-related variables
 571     MEMCACHED_SERVERS=""
 572     MEMCACHED_PREFIX=""
 573 fi
 574
 575 # Are we root? If not, the mod_rewrite check will fail and be confusing, so
 576 # we look into this first.
 577 if [[ $UID -ne 0 ]]
 578 then
 579     die "This script must be run with root privileges."
 580 fi
 581
 582 # Check everything is ok with Apache, die otherwise
 583 check_apache_config
 584
 585 opacdomain="$OPACPREFIX$name$OPACSUFFIX$DOMAIN"
 586 intradomain="$INTRAPREFIX$name$INTRASUFFIX$DOMAIN"
 587
 588 # Check everything is ok with letsencrypt, die otherwise
 589 if [ "$CLO_LETSENCRYPT" = "yes" ]; then
 590     check_letsencrypt
 591 fi
 592
 593 if [ -f $PASSWDFILE ] && [ `cat $PASSWDFILE | grep "^$name:"` ]
 594 then
 595     passwdline=`cat $PASSWDFILE | grep "^$name:"`
 596     mysqluser=`echo $passwdline | cut -d ":" -f 2`
 597     mysqlpwd=`echo $passwdline | cut -d ":" -f 3`
 598     mysqldb=`echo $passwdline | cut -d ":" -f 4`
 599 fi
 600
 601 # The order of precedence for MySQL database name is:
 602 # default < passwd file < command line
 603 if [ "$mysqldb" = "" ]
 604 then
 605     mysqldb="koha_$name"
 606 fi
 607 if [ "$CLO_DATABASE" != "" ]
 608 then
 609     mysqldb="$CLO_DATABASE"
 610 fi
 611
 612 if [ "$mysqluser" = "" ]
 613 then
 614     mysqluser="koha_$name"
 615 fi
 616 mysqlhost="$(getmysqlhost)"
 617
 618 if [ "$op" = create ] || [ "$op" = request ] || [ "$op" = use ]
 619 then
 620     if [ "$mysqlpwd" = "" ]
 621     then
 622         mysqlpwd="$(pwgen -s 16 1)"
 623     fi
 624 else
 625     mysqlpwd="$(getinstancemysqlpassword $name)"
 626 fi
 627
 628
 629 if [ "$op" = create ] || [ "$op" = request ] || [ "$op" = use ]
 630 then
 631     # Create new user and group.
 632     username="$name-koha"
 633     if getent passwd "$username" > /dev/null
 634     then
 635         die "User $username already exists."
 636     fi
 637     if getent group "$username" > /dev/null
 638     then
 639         die "Group $username already exists."
 640     fi
 641     adduser --no-create-home --disabled-login \
 642         --gecos "Koha instance $username" \
 643         --home "/var/lib/koha/$name" \
 644         --quiet "$username"
 645
 646     # Create the site-specific directories.
 647     koha-create-dirs "$name"
 648
 649     # Generate Zebra database password.
 650     zebrapwd="$(pwgen -s 16 1)"
 651     # Future enhancement: make this configurable for when your db is on
 652     # another server.
 653     mysql_hostname="localhost"
 654     # Set up MySQL database for this instance.
 655     if [ "$op" = create ]
 656     then
 657         mysql --defaults-extra-file=/etc/mysql/koha-common.cnf <<eof
 658 CREATE DATABASE \`$mysqldb\`;
 659 CREATE USER \`$mysqluser\`@'$mysql_hostname' IDENTIFIED BY '$mysqlpwd';
 660 CREATE USER \`$mysqluser\`@'%' IDENTIFIED BY '$mysqlpwd';
 661 GRANT ALL PRIVILEGES ON \`$mysqldb\`.* TO \`$mysqluser\`;
 662 FLUSH PRIVILEGES;
 663 eof
 664     fi #`
 665
 666     if [ "$op" = use ]
 667     then
 668         mysql --defaults-extra-file=/etc/mysql/koha-common.cnf --force <<eof
 669 CREATE USER \`$mysqluser\`@'$mysql_hostname' IDENTIFIED BY '$mysqlpwd';
 670 CREATE USER \`$mysqluser\`@'%' IDENTIFIED BY '$mysqlpwd';
 671 GRANT ALL PRIVILEGES ON \`$mysqldb\`.* TO \`$mysqluser\`;
 672 FLUSH PRIVILEGES;
 673 eof
 674     fi #`
 675
 676     if [ "$CLO_LETSENCRYPT" = "yes" ]; then
 677         APACHE_CONFIGFILE="apache-site-https.conf.in"
 678     else
 679         APACHE_CONFIGFILE="apache-site.conf.in"
 680     fi
 681     # Generate and install Apache site-available file and log dir.
 682     generate_config_file $APACHE_CONFIGFILE \
 683         "/etc/apache2/sites-available/$name.conf"
 684     mkdir "/var/log/koha/$name"
 685     chown "$username:$username" "/var/log/koha/$name"
 686
 687
 688     # Generate and install main Koha config file.
 689     generate_config_file koha-conf-site.xml.in \
 690         "/etc/koha/sites/$name/koha-conf.xml"
 691
 692     # Generate and install the log4perl config file.
 693     generate_config_file log4perl-site.conf.in \
 694         "/etc/koha/sites/$name/log4perl.conf"
 695
 696     # Generate and install Zebra config files.
 697     generate_config_file zebra-biblios-site.cfg.in \
 698         "/etc/koha/sites/$name/zebra-biblios.cfg"
 699     generate_config_file zebra-biblios-dom-site.cfg.in \
 700         "/etc/koha/sites/$name/zebra-biblios-dom.cfg"
 701     generate_config_file zebra-authorities-site.cfg.in \
 702         "/etc/koha/sites/$name/zebra-authorities.cfg"
 703     generate_config_file zebra-authorities-dom-site.cfg.in \
 704         "/etc/koha/sites/$name/zebra-authorities-dom.cfg"
 705     generate_config_file zebra.passwd.in \
 706         "/etc/koha/sites/$name/zebra.passwd"
 707
 708
 709     # Create a GPG-encrypted file for requesting a DB to be set up.
 710     if [ "$op" = request ]
 711     then
 712         touch "$name-db-request.txt"
 713         chmod 0600 "$name-db-request.txt"
 714         cat > "$name-db-request.txt" << eof
 715 Please create a MySQL database and user on $mysqlhost as follows:
 716
 717 database name: $mysqldb
 718 database user: $mysqluser
 719      password: $mysqlpwd
 720
 721 Thank you.
 722 eof
 723
 724         echo "See $name-db-request.txt for database creation request."
 725         echo "Please forward it to the right person, and then run"
 726         echo "$0 --populate-db $name"
 727         echo "Thanks."
 728     fi
 729 fi
 730
 731
 732 if [ "$op" = create ] || [ "$op" = populate ]
 733 then
 734     # Re-fetch the passwords from the config we've generated, allows it
 735     # to be different from what we set, in case the user had to change
 736     # something.
 737     mysqluser=$(getinstancemysqluser $name)
 738     mysqldb=$(getinstancemysqldatabase $name)
 739     # Use the default database content if that exists.
 740     if [ -e "$DEFAULTSQL" ]
 741     then
 742         # Populate the database with default content.
 743         zcat "$DEFAULTSQL" |
 744         sed "s/__KOHASITE__/$name/g" |
 745         mysql --host="$mysqlhost" --user="$mysqluser" --password="$mysqlpwd" "$mysqldb"
 746
 747
 748         # Change the default user's password.
 749         staffpass="$(pwgen 12 1)"
 750         staffdigest=$(echo -n "$staffpass" |
 751                       perl -e '
 752                             use Digest::MD5 qw(md5_base64);
 753                             while (<>) { print md5_base64($_), "\n"; }')
 754         mysql --host="$mysqlhost" --user="$mysqluser" \
 755 --password="$mysqlpwd" <<eof
 756 USE \`$mysqldb\`;
 757 UPDATE borrowers
 758 SET password = '$staffdigest'
 759 WHERE borrowernumber = $ADMINUSER;
 760 eof
 761         #`
 762         echo "staff user password is '$staffpass' but keep that secret"
 763
 764         # Upgrade the database schema, just in case the dump was from an
 765         # old version.
 766         koha-upgrade-schema "$name"
 767     else
 768         echo "Koha instance is empty, no staff user created."
 769     fi
 770 fi
 771
 772
 773 if [ "$op" = create ] || [ "$op" = populate ] || [ "$op" = use ]
 774 then
 775     # Reconfigure Apache.
 776     if ! {
 777         a2ensite "$name" > /dev/null 2>&1 ||
 778             a2ensite "${name}.conf" > /dev/null 2>&1
 779     }; then
 780         echo "Warning: problem enabling $name in Apache" >&2
 781     fi
 782     service apache2 restart
 783
 784     # Start Zebra.
 785     koha-start-zebra "$name"
 786
 787     if [ "$USE_INDEXER_DAEMON" = "yes" ]; then
 788         # Start Indexer daemon
 789         koha-indexer --start "$name"
 790     fi
 791
 792     if [ "$CLO_LETSENCRYPT" = "yes" ]; then
 793         # Get letsencrypt certificates
 794         letsencrypt_instance
 795     fi
 796 fi
 797
 798
 799 if [ "$op" = request ]
 800 then
 801     koha-disable "$name"
 802 fi
 803
 804 echo <<eoh
 805
 806 Email for this instance is disabled. When you're ready to enable it, use:
 807 koha-email-enable $name
 808 eoh