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