297d22459f
This commit makes koha-create more flexible by adding a number of command-line and configuration options. The biggest change is to add support for pre-determined MySQL credentials using a file in /etc/koha/passwd (for security reasons, if you use this feature, make sure the file is not world-readable). The configuration file has the following format: instance:user:password:database The database is optional, but the other two are both required if you want to specify MySQL credentials. If no credentials are specified for a given instance, the standard koha_instance username and an auto-generated password are used. The following additional command line options are now available: * --use-db - use a pre-existing database, see also --database * --database - specify the name of the mysql database (still defaults to koha_instance) * --passwdfile - specify a custom (Koha) passwd file for MySQL credentials The following additional variables are now available (for use in koha-sites.conf or a custom config file): * OPACPORT (previously added but not documented) - port on which the OPAC should be served * OPACPREFIX - prefix for the OPAC's virtual host * OPACSUFFIX - suffix for the OPAC's virtual host This commit also adds the --keep-mysql option to koha-remove, which, if specified, will prevent koha-remove from deleting the database or MySQL user when removing an instance. Signed-off-by: Chris Cormack <chrisc@catalyst.net.nz>
350 lines
9.6 KiB
Bash
Executable file
350 lines
9.6 KiB
Bash
Executable file
#!/bin/sh
|
|
#
|
|
# koha-create -- Create a new Koha instance.
|
|
# Copyright 2010 Catalyst IT, Ltd
|
|
#
|
|
# This program is free software: you can redistribute it and/or modify
|
|
# it under the terms of the GNU General Public License as published by
|
|
# the Free Software Foundation, either version 3 of the License, or
|
|
# (at your option) any later version.
|
|
#
|
|
# This program is distributed in the hope that it will be useful,
|
|
# but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
# GNU General Public License for more details.
|
|
#
|
|
# You should have received a copy of the GNU General Public License
|
|
# along with this program. If not, see <http://www.gnu.org/licenses/>.
|
|
|
|
|
|
set -e
|
|
|
|
usage="Usage: $0 [--create-db|--request-db|--populate-db|--use-db] \
|
|
[--marcflavor marc21|normarc|unimarc] \
|
|
[--zebralang en|nb|fr] \
|
|
[--defaultsql /path/to/some.sql] \
|
|
[--configfile /path/to/config] [--passwdfile /path/to/passwd] \
|
|
[--database database] [--adminuser n] instancename"
|
|
|
|
die() {
|
|
echo "$@" 1>&2
|
|
exit 1
|
|
}
|
|
|
|
# UPPER CASE VARIABLES - from configfile or default value
|
|
# lower case variables - generated within this script
|
|
generate_config_file() {
|
|
touch "$2"
|
|
chown "root:$username" "$2"
|
|
chmod 0640 "$2"
|
|
sed -e "s/__KOHASITE__/$name/g" \
|
|
-e "s/__OPACPORT__/$OPACPORT/g" \
|
|
-e "s/__INTRAPORT__/$INTRAPORT/g" \
|
|
-e "s/__OPACSERVER__/$opacdomain/g" \
|
|
-e "s/__INTRASERVER__/$intradomain/g" \
|
|
-e "s/__ZEBRA_PASS__/$zebrapwd/g" \
|
|
-e "s/__ZEBRA_MARC_FORMAT__/$ZEBRA_MARC_FORMAT/g" \
|
|
-e "s/__ZEBRA_LANGUAGE__/$ZEBRA_LANGUAGE/g" \
|
|
-e "s/__DB_NAME__/$mysqldb/g" \
|
|
-e "s/__DB_HOST__/$mysqlhost/g" \
|
|
-e "s/__DB_USER__/$mysqluser/g" \
|
|
-e "s/__DB_PASS__/$mysqlpwd/g" \
|
|
-e "s/__UNIXUSER__/$username/g" \
|
|
-e "s/__UNIXGROUP__/$username/g" \
|
|
"/etc/koha/$1" > "$2"
|
|
}
|
|
|
|
getmysqlhost() {
|
|
awk '
|
|
/^\[/ { inclient = 0 }
|
|
/^\[client\]/ { inclient = 1 }
|
|
inclient && /^ *host *=/ { print $3 }' \
|
|
/etc/mysql/koha-common.cnf
|
|
}
|
|
|
|
getinstancemysqlpassword() {
|
|
xmlstarlet sel -t -v 'yazgfs/config/pass' "/etc/koha/sites/$1/koha-conf.xml"
|
|
}
|
|
|
|
getinstancemysqluser() {
|
|
xmlstarlet sel -t -v 'yazgfs/config/user' "/etc/koha/sites/$1/koha-conf.xml"
|
|
}
|
|
|
|
getinstancemysqldatabase() {
|
|
xmlstarlet sel -t -v 'yazgfs/config/database' "/etc/koha/sites/$1/koha-conf.xml"
|
|
}
|
|
|
|
# Set defaults and read config file, if it exists.
|
|
DOMAIN=""
|
|
OPACPORT="80"
|
|
OPACPREFIX=""
|
|
OPACSUFFIX=""
|
|
INTRAPORT="8080"
|
|
INTRAPREFIX=""
|
|
INTRASUFFIX=""
|
|
DEFAULTSQL=""
|
|
ZEBRA_MARC_FORMAT="marc21"
|
|
ZEBRA_LANGUAGE="en"
|
|
ADMINUSER="1"
|
|
PASSWDFILE="/etc/koha/passwd"
|
|
if [ -e /etc/koha/koha-sites.conf ]
|
|
then
|
|
. /etc/koha/koha-sites.conf
|
|
fi
|
|
|
|
[ $# -ge 2 ] && [ $# -le 16 ] || die $usage
|
|
|
|
TEMP=`getopt -o crpm:l:d:f:a: -l create-db,request-db,populate-db,use-db,marcflavor:,zebralang:,defaultsql:,configfile:,passwdfile:,adminuser: \
|
|
-n "$0" -- "$@"`
|
|
|
|
# Note the quotes around `$TEMP': they are essential!
|
|
eval set -- "$TEMP"
|
|
|
|
# Temporary variables for the command line options
|
|
CLO_ZEBRA_MARC_FORMAT=""
|
|
CLO_ZEBRA_LANGUAGE=""
|
|
CLO_DEFAULTSQL=""
|
|
CLO_ADMINUSER=""
|
|
|
|
while true ; do
|
|
case "$1" in
|
|
-c|--create-db) op=create ; shift ;;
|
|
-r|--request-db) op=request ; shift ;;
|
|
-p|--populate-db) op=populate ; shift ;;
|
|
-u|--use-db) op=use ; shift ;;
|
|
-m|--marcflavor) CLO_ZEBRA_MARC_FORMAT="$2" ; shift 2 ;;
|
|
-l|--zebralang) CLO_ZEBRA_LANGUAGE="$2" ; shift 2 ;;
|
|
-d|--defaultsql) CLO_DEFAULTSQL="$2" ; shift 2 ;;
|
|
-f|--configfile) configfile="$2" ; shift 2 ;;
|
|
-s|--passwdfile) CLO_PASSWDFILE="$2" ; shift 2 ;;
|
|
-b|--database) CLO_DATABASE="$2" ; shift 2 ;;
|
|
-a|--adminuser) CLO_ADMINUSER="$2" ; shift 2 ;;
|
|
--) shift ; break ;;
|
|
*) die "Internal error processing command line arguments" ;;
|
|
esac
|
|
done
|
|
|
|
# Load the configfile given on the command line
|
|
if [ "$configfile" != "" ]
|
|
then
|
|
if [ -e "$configfile" ]
|
|
then
|
|
. "$configfile"
|
|
else
|
|
die "$configfile does not exist.";
|
|
fi
|
|
fi
|
|
|
|
# Make sure options from the command line get the highest precedence
|
|
if [ "$CLO_ZEBRA_MARC_FORMAT" != "" ]
|
|
then
|
|
ZEBRA_MARC_FORMAT="$CLO_ZEBRA_MARC_FORMAT"
|
|
fi
|
|
if [ "$CLO_ZEBRA_LANGUAGE" != "" ]
|
|
then
|
|
ZEBRA_LANGUAGE="$CLO_ZEBRA_LANGUAGE"
|
|
fi
|
|
if [ "$CLO_DEFAULTSQL" != "" ]
|
|
then
|
|
DEFAULTSQL="$CLO_DEFAULTSQL"
|
|
fi
|
|
if [ "$CLO_ADMINUSER" != "" ]
|
|
then
|
|
ADMINUSER="$CLO_ADMINUSER"
|
|
fi
|
|
if [ "$CLO_PASSWDFILE" != "" ]
|
|
then
|
|
PASSWDFILE="$CLO_PASSWDFILE"
|
|
fi
|
|
|
|
name="$1"
|
|
|
|
opacdomain="$OPACPREFIX$name$OPACSUFFIX$DOMAIN"
|
|
intradomain="$INTRAPREFIX$name$INTRASUFFIX$DOMAIN"
|
|
|
|
|
|
if [ `cat $PASSWDFILE | grep "^$name:"` ]
|
|
then
|
|
passwdline=`cat $PASSWDFILE | grep "^$name:"`
|
|
mysqluser=`echo $passwdline | cut -d ":" -f 2`
|
|
mysqlpwd=`echo $passwdline | cut -d ":" -f 3`
|
|
mysqldb=`echo $passwdline | cut -d ":" -f 4`
|
|
fi
|
|
|
|
# The order of precedence for MySQL database name is:
|
|
# default < passwd file < command line
|
|
if [ "$mysqldb" = "" ]
|
|
then
|
|
mysqldb="koha_$name"
|
|
fi
|
|
if [ "$CLO_DATABASE" != "" ]
|
|
then
|
|
mysqldb="$CLO_DATABASE"
|
|
fi
|
|
|
|
if [ "$mysqluser" = "" ]
|
|
then
|
|
mysqluser="koha_$name"
|
|
fi
|
|
mysqlhost="$(getmysqlhost)"
|
|
|
|
if [ "$op" = create ] || [ "$op" = request ] || [ "$op" = use ]
|
|
then
|
|
if [ "$mysqlpwd" = "" ]
|
|
then
|
|
mysqlpwd="$(pwgen -1)"
|
|
fi
|
|
else
|
|
mysqlpwd="$(getinstancemysqlpassword $name)"
|
|
fi
|
|
|
|
|
|
if [ "$op" = create ] || [ "$op" = request ] || [ "$op" = use ]
|
|
then
|
|
# Create new user and group.
|
|
username="$name-koha"
|
|
if getent passwd "$username" > /dev/null
|
|
then
|
|
die "User $username already exists."
|
|
fi
|
|
if getent group "$username" > /dev/null
|
|
then
|
|
die "Group $username already exists."
|
|
fi
|
|
adduser --no-create-home --disabled-login \
|
|
--gecos "Koha instance $username" \
|
|
--home "/var/lib/koha/$name" \
|
|
--quiet "$username"
|
|
|
|
# Create the site-specific directories.
|
|
koha-create-dirs "$name"
|
|
|
|
# Generate Zebra database password.
|
|
zebrapwd="$(pwgen -s 12 1)"
|
|
# Set up MySQL database for this instance.
|
|
if [ "$op" = create ]
|
|
then
|
|
mysql --defaults-extra-file=/etc/mysql/koha-common.cnf <<eof
|
|
CREATE DATABASE \`$mysqldb\`;
|
|
CREATE USER \`$mysqluser\`@'%' IDENTIFIED BY '$mysqlpwd';
|
|
GRANT ALL PRIVILEGES ON \`$mysqldb\`.* TO \`$mysqluser\`;
|
|
FLUSH PRIVILEGES;
|
|
eof
|
|
fi #`
|
|
|
|
if [ "$op" = use ]
|
|
then
|
|
mysql --defaults-extra-file=/etc/mysql/koha-common.cnf --force <<eof
|
|
CREATE USER \`$mysqluser\`@'%' IDENTIFIED BY '$mysqlpwd';
|
|
GRANT ALL PRIVILEGES ON \`$mysqldb\`.* TO \`$mysqluser\`;
|
|
FLUSH PRIVILEGES;
|
|
eof
|
|
fi #`
|
|
|
|
# Generate and install Apache site-available file and log dir.
|
|
generate_config_file apache-site.conf.in \
|
|
"/etc/apache2/sites-available/$name"
|
|
mkdir "/var/log/koha/$name"
|
|
chown "$username:$username" "/var/log/koha/$name"
|
|
|
|
|
|
# Generate and install main Koha config file.
|
|
generate_config_file koha-conf-site.xml.in \
|
|
"/etc/koha/sites/$name/koha-conf.xml"
|
|
|
|
# Generate and install Zebra config files.
|
|
generate_config_file zebra-biblios-site.cfg.in \
|
|
"/etc/koha/sites/$name/zebra-biblios.cfg"
|
|
generate_config_file zebra-authorities-site.cfg.in \
|
|
"/etc/koha/sites/$name/zebra-authorities.cfg"
|
|
generate_config_file zebra-authorities-dom-site.cfg.in \
|
|
"/etc/koha/sites/$name/zebra-authorities-dom.cfg"
|
|
generate_config_file zebra.passwd.in \
|
|
"/etc/koha/sites/$name/zebra.passwd"
|
|
|
|
|
|
# Create a GPG-encrypted file for requesting a DB to be set up.
|
|
if [ "$op" = request ]
|
|
then
|
|
touch "$name-db-request.txt"
|
|
chmod 0600 "$name-db-request.txt"
|
|
cat > "$name-db-request.txt" << eof
|
|
Please create a MySQL database and user on $mysqlhost as follows:
|
|
|
|
database name: $mysqldb
|
|
database user: $mysqluser
|
|
password: $mysqlpwd
|
|
|
|
Thank you.
|
|
eof
|
|
|
|
echo "See $name-db-request.txt for database creation request."
|
|
echo "Please forward it to the right person, and then run"
|
|
echo "$0 --populate-db $name"
|
|
echo "Thanks."
|
|
fi
|
|
fi
|
|
|
|
|
|
if [ "$op" = create ] || [ "$op" = populate ]
|
|
then
|
|
# Re-fetch the passwords from the config we've generated, allows it
|
|
# to be different from what we set, in case the user had to change
|
|
# something.
|
|
mysqluser=$(getinstancemysqluser $name)
|
|
mysqldb=$(getinstancemysqldatabase $name)
|
|
# Use the default database content if that exists.
|
|
if [ -e "$DEFAULTSQL" ]
|
|
then
|
|
# Populate the database with default content.
|
|
zcat "$DEFAULTSQL" |
|
|
sed "s/__KOHASITE__/$name/g" |
|
|
mysql --host="$mysqlhost" --user="$mysqluser" --password="$mysqlpwd" "$mysqldb"
|
|
|
|
|
|
# Change the default user's password.
|
|
staffpass="$(pwgen -1)"
|
|
staffdigest=$(echo -n "$staffpass" |
|
|
perl -e '
|
|
use Digest::MD5 qw(md5_base64);
|
|
while (<>) { print md5_base64($_), "\n"; }')
|
|
mysql --host="$mysqlhost" --user="$mysqluser" \
|
|
--password="$mysqlpwd" <<eof
|
|
USE \`$mysqldb\`;
|
|
UPDATE borrowers
|
|
SET password = '$staffdigest'
|
|
WHERE borrowernumber = $ADMINUSER;
|
|
eof
|
|
#`
|
|
echo "staff user password is '$staffpass' but keep that secret"
|
|
|
|
# Upgrade the database schema, just in case the dump was from an
|
|
# old version.
|
|
koha-upgrade-schema "$name"
|
|
else
|
|
echo "Koha instance is empty, no staff user created."
|
|
fi
|
|
fi
|
|
|
|
|
|
if [ "$op" = create ] || [ "$op" = populate ] || [ "$op" = use ]
|
|
then
|
|
# Reconfigure Apache.
|
|
a2ensite "$name"
|
|
service apache2 restart
|
|
|
|
# Start Zebra.
|
|
koha-start-zebra "$name"
|
|
fi
|
|
|
|
|
|
if [ "$op" = request ]
|
|
then
|
|
koha-disable "$name"
|
|
fi
|
|
|
|
echo <<eoh
|
|
|
|
Email for this instance is disabled. When you're ready to enable it, use:
|
|
koha-email-enable $name
|
|
eoh
|