citadel/newinstall.sh

   1 #!/bin/sh
   2 # $Id$
   3 #
   4 #   Automatic script to install Citadel on a target system.
   5 #   Copyright (C) 2004 Michael Hampton <error@citadel.org>
   6 #   Copyright (C) 2004 Art Cancro <ajc@uncensored.citadel.org>
   7 #
   8 #   This program is free software; you can redistribute it and/or modify
   9 #   it under the terms of the GNU General Public License as published by
  10 #   the Free Software Foundation, version 2.
  11 #
  12 #   This program is distributed in the hope that it will be useful,
  13 #   but WITHOUT ANY WARRANTY; without even the implied warranty of
  14 #   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  15 #   GNU General Public License for more details.
  16 #
  17 #   You should have received a copy of the GNU General Public License
  18 #   along with this program; if not, write to the Free Software
  19 #   Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
  20 #
  21 # Reading this script?  Here's some helpful hints:
  22 #
  23 # If you're seeing this in your browser, it's probably not what you want.
  24 # You can either save it to disk and run it, or do it the easy way:
  25 #
  26 # curl http://easyinstall.citadel.org/install | sh
  27 #
  28 # Note that this script installs software on your system and so it requires
  29 # root privileges.  Feel free to inspect the script to make sure we didn't
  30 # do anything stupid...
  31 #
  32 # We have provided you the source code according to the terms of the respective
  33 # software licenses included in the source code packages, even if you choose
  34 # not to keep the source code around.  You can always download it again later.
  35 #
  36 # We install the following versions in this release:
  37 # Package                    Status
  38 # Citadel                    Latest
  39 # WebCit                     Latest
  40 # libical                    Latest
  41 # Berkeley DB                Stable
  42
  43
  44 ###############################################################################
  45 #
  46 # This is the general stuff we're going to do, in order:
  47 #
  48 # 1. Gather information about the target system
  49 # 2. Present the installation steps (from 1 above) to the user
  50 # 3. Present any pre-install customizations to the user
  51 # 4. Do the installation
  52 #    A. Download any source code files or binary packages required
  53 #    B. For native packaging, call the native packaging system to install
  54 #    C. If we build our own, compile and install prerequisites then Citadel
  55 # 5. Do post-installation setup
  56 #
  57 # Then call it a day.
  58 #
  59 ###############################################################################
  60
  61
  62 # Begin user customization area
  63 #
  64 # These two directories specify where Citadel and its private support
  65 # libraries will be installed.  This keeps them safely tucked away from
  66 # the rest of your system.  The defaults should be fine for most people.
  67 # NB: When binary packages are installed, these settings are ignored!
  68 SUPPORT=/usr/local/ctdlsupport
  69 CITADEL=/usr/local/citadel
  70 WEBCIT=/usr/local/webcit
  71 WORKDIR=/tmp
  72 BUILD=$WORKDIR/citadel-build.$$
  73 LOG=$WORKDIR/citadel-install-log.txt
  74 export SUPPORT CITADEL WEBCIT
  75
  76 MAKEOPTS=""
  77
  78 # End user customization area
  79
  80 # We're now exporting a bunch of environment variables, and here's a list:
  81 # CITADEL_INSTALLER     Set to "web" to indicate this script
  82 # CITADEL               Directory where Citadel is installed
  83 # WEBCIT                Directory where WebCit is installed
  84 # SUPPORT               Directory where support programs are installed
  85 # SLAPD_BINARY          Location of the slapd binary
  86 # DISTRO_MAJOR          Linux distribution name, if applicable
  87 # DISTRO_MINOR          Linux distribution name, if applicable
  88 # DISTRO_VERSION        Linux distribution version (major digit) if applicable
  89 # CC                    C compiler being used
  90 # MAKE                  Make program being used
  91 # CFLAGS                C compiler flags
  92 # LDFLAGS               Linker flags
  93 # IS_UPGRADE            Set to "yes" if upgrading an existing Citadel
  94 # IS_AUTOLOGIN          Set to "yes" to force enabling autologin
  95 # CTDL_DIALOG           Where (if at all) the "dialog" program may be found
  96
  97 # Let Citadel setup recognize the Citadel installer
  98 CITADEL_INSTALLER=web
  99 export CITADEL_INSTALLER
 100
 101 DOWNLOAD_SITE=http://easyinstall.citadel.org
 102
 103 # Original source code packages.
 104 DB_SOURCE=db-4.3.29.NC.tar.gz
 105 # DB_PATCHES=db-x.x.x.patches
 106 ICAL_SOURCE=libical-0.26-6.aurore.tar.gz
 107 CITADEL_SOURCE=citadel-easyinstall.tar.gz
 108 WEBCIT_SOURCE=webcit-easyinstall.tar.gz
 109
 110 SETUP="Citadel Easy Install"
 111
 112
 113 ##### BEGIN Functions #####
 114
 115 die () {
 116         echo Easy Install is aborting.
 117         echo Please report this problem to the Citadel developers.
 118         echo Log file: $LOG
 119         rm -fr $BUILD
 120         exit 1
 121 }
 122
 123
 124
 125 download_this () {
 126         if [ -x `which wget` ] ; then
 127                 wget $FILENAME >/dev/null 2>>$LOG || die
 128         else
 129                 if [ -x `which curl` ] ; then
 130                         curl $FILENAME >$FILENAME 2>>$LOG || die
 131                 else
 132                         echo Unable to find a wget or curl command.
 133                         echo Easy Install cannot continue.
 134                         die;
 135                 fi
 136         fi
 137 }
 138
 139
 140
 141
 142 determine_distribution () {
 143         # First look for Red Hat in general
 144         if [ -x /bin/rpm ]; then
 145                 RELEASE_FILE=/dev/null
 146                 if /bin/rpm -q redhat-release >/dev/null 2>&1; then
 147                         DISTRO_MAJOR=RedHat
 148                         RELEASE_FILE=/etc/redhat-release
 149                 fi
 150                 if /bin/rpm -q whitebox-release >/dev/null 2>&1; then
 151                         DISTRO_MAJOR=WhiteBox
 152                         RELEASE_FILE=/etc/whitebox-release
 153                 fi
 154                 if /bin/rpm -q fedora-release >/dev/null 2>&1; then
 155                         DISTRO_MAJOR=RedHat
 156                         DISTRO_MINOR=Fedora
 157                         RELEASE_FILE=/etc/fedora-release
 158                 fi
 159                 # Then look for specific version
 160                 ( cat $RELEASE_FILE | grep Enterprise ) >/dev/null 2>&1 && \
 161                         DISTRO_MINOR=Enterprise
 162                 DISTRO_VERSION=`tr -cd "[^0-9.]" < $RELEASE_FILE | cut -c 1`
 163         fi
 164
 165         # Check for Gentoo
 166         if [ -f /etc/gentoo-release ]; then
 167                 DISTRO_MAJOR=Gentoo
 168         fi
 169
 170         # Check for Debian
 171         # TODO: check for Debian
 172 }
 173
 174 install_ical () {
 175         cd $BUILD 2>&1 >>$LOG || die
 176         FILENAME=$DOWNLOAD_SITE/libical-easyinstall.sum ; download_this
 177         SUM=`cat libical-easyinstall.sum`
 178         SUMFILE=$SUPPORT/etc/libical-easyinstall.sum
 179         if [ -r $SUMFILE ] ; then
 180                 OLDSUM=`cat $SUMFILE`
 181                 if [ $SUM = $OLDSUM ] ; then
 182                         echo "* libical does not need updating."
 183                         return
 184                 fi
 185         fi
 186         echo "* Downloading libical..."
 187         FILENAME=$DOWNLOAD_SITE/$ICAL_SOURCE ; download_this
 188         echo "* Installing libical..."
 189         ( gzip -dc $ICAL_SOURCE | tar -xf - ) 2>&1 >>$LOG || die
 190         cd $BUILD/libical-0.26 2>&1 >>$LOG || die
 191         ./configure --prefix=$SUPPORT 2>&1 >>$LOG || die
 192         $MAKE $MAKEOPTS 2>&1 >>$LOG || die
 193         $MAKE install 2>&1 >>$LOG || die
 194         echo "  Complete."
 195         echo $SUM >$SUMFILE
 196         rm -f $CITADEL/citadel-easyinstall.sum 2>/dev/null
 197         rm -f $WEBCIT/webcit-easyinstall.sum 2>/dev/null
 198 }
 199
 200 install_db () {
 201         cd $BUILD 2>&1 >>$LOG || die
 202         FILENAME=$DOWNLOAD_SITE/db-easyinstall.sum ; download_this
 203         SUM=`cat db-easyinstall.sum`
 204         SUMFILE=$SUPPORT/etc/db-easyinstall.sum
 205         if [ -r $SUMFILE ] ; then
 206                 OLDSUM=`cat $SUMFILE`
 207                 if [ $SUM = $OLDSUM ] ; then
 208                         echo "* Berkeley DB does not need updating."
 209                         return
 210                 fi
 211         fi
 212         echo "* Downloading Berkeley DB..."
 213         FILENAME=$DOWNLOAD_SITE/$DB_SOURCE ; download_this
 214         echo "* Installing Berkeley DB..."
 215         ( gzip -dc $DB_SOURCE | tar -xf - ) 2>&1 >>$LOG || die
 216         cd $BUILD/db-4.3.29.NC 2>&1 >>$LOG || die
 217         #patch -p0 < ../$DB_PATCHES 2>&1 >>$LOG || die
 218         cd $BUILD/db-4.3.29.NC/build_unix 2>&1 >>$LOG || die
 219         ../dist/configure --prefix=$SUPPORT --disable-compat185 --disable-cxx --disable-debug --disable-dump185 --disable-java --disable-rpc --disable-tcl --disable-test --without-rpm 2>&1 >>$LOG || die
 220         $MAKE $MAKEOPTS 2>&1 >>$LOG || die
 221         $MAKE install 2>&1 >>$LOG || die
 222         echo "  Complete."
 223         echo $SUM >$SUMFILE
 224         rm -f $CITADEL/citadel-easyinstall.sum 2>/dev/null
 225 }
 226
 227 install_prerequisites () {
 228
 229         # Create the support directories if they don't already exist
 230
 231         mkdir $SUPPORT          2>/dev/null
 232         mkdir $SUPPORT/bin      2>/dev/null
 233         mkdir $SUPPORT/sbin     2>/dev/null
 234         mkdir $SUPPORT/lib      2>/dev/null
 235         mkdir $SUPPORT/libexec  2>/dev/null
 236         mkdir $SUPPORT/include  2>/dev/null
 237         mkdir $SUPPORT/etc      2>/dev/null
 238
 239         # Now have phun!
 240
 241         if [ -z "$OK_ICAL" ]
 242         then
 243                 install_ical
 244         fi
 245         if [ -z "$OK_DB" ]
 246         then
 247                 install_db
 248         fi
 249 }
 250
 251 install_sources () {
 252         cd $BUILD 2>&1 >>$LOG || die
 253         if [ -f $CITADEL/citadel.config ]
 254         then
 255                 IS_UPGRADE=yes
 256                 echo "* Upgrading your existing Citadel installation."
 257         else
 258                 IS_UPGRADE=no
 259         fi
 260
 261         CFLAGS="-I${SUPPORT}/include"
 262         CPPFLAGS="${CFLAGS}"
 263         LDFLAGS="-L${SUPPORT}/lib -Wl,--rpath -Wl,${SUPPORT}/lib"
 264         export CFLAGS CPPFLAGS LDFLAGS
 265
 266         DO_INSTALL_CITADEL=yes
 267         FILENAME=$DOWNLOAD_SITE/citadel-easyinstall.sum ; download_this
 268         SUM=`cat citadel-easyinstall.sum`
 269         SUMFILE=$CITADEL/citadel-easyinstall.sum
 270         if [ -r $SUMFILE ] ; then
 271                 OLDSUM=`cat $SUMFILE`
 272                 if [ $SUM = $OLDSUM ] ; then
 273                         echo "* Citadel does not need updating."
 274                         DO_INSTALL_CITADEL=no
 275                 fi
 276         fi
 277
 278         if [ $DO_INSTALL_CITADEL = yes ] ; then
 279                 echo "* Downloading Citadel..."
 280                 FILENAME=$DOWNLOAD_SITE/$CITADEL_SOURCE ; download_this
 281                 echo "* Installing Citadel..."
 282                 cd $BUILD 2>&1 >>$LOG || die
 283                 ( gzip -dc $CITADEL_SOURCE | tar -xf - ) 2>&1 >>$LOG || die
 284                 cd $BUILD/citadel 2>&1 >>$LOG || die
 285                 if [ x$IS_AUTOLOGIN = xyes ] ; then
 286                         AL="--enable-autologin"
 287                 else
 288                         AL=""
 289                 fi
 290                 if [ -z "$OK_DB" ]
 291                 then
 292                         ./configure --prefix=$CITADEL --with-db=$SUPPORT --with-pam $AL --with-libical --disable-threaded-client 2>&1 >>$LOG || die
 293                 else
 294                         ./configure --prefix=$CITADEL --with-db=$OK_DB --with-pam $AL --with-libical --disable-threaded-client 2>&1 >>$LOG || die
 295                 fi
 296                 $MAKE $MAKEOPTS 2>&1 >>$LOG || die
 297                 if [ $IS_UPGRADE = yes ]
 298                 then
 299                         echo "* Performing Citadel upgrade..."
 300                         $MAKE upgrade 2>&1 >>$LOG || die
 301                 else
 302                         echo "* Performing Citadel install..."
 303                         $MAKE install 2>&1 >>$LOG || die
 304                         useradd -c "Citadel service account" -d $CITADEL -s $CITADEL/citadel citadel 2>&1 >>$LOG
 305                 fi
 306                 echo $SUM >$SUMFILE
 307         fi
 308
 309         cd $BUILD 2>&1 >>$LOG || die
 310         DO_INSTALL_WEBCIT=yes
 311         FILENAME=$DOWNLOAD_SITE/webcit-easyinstall.sum ; download_this
 312         SUM=`cat webcit-easyinstall.sum`
 313         SUMFILE=$WEBCIT/webcit-easyinstall.sum
 314         if [ -r $SUMFILE ] ; then
 315                 OLDSUM=`cat $SUMFILE`
 316                 if [ $SUM = $OLDSUM ] ; then
 317                         echo "* WebCit does not need updating."
 318                         DO_INSTALL_WEBCIT=no
 319                 fi
 320         fi
 321
 322         if [ $DO_INSTALL_WEBCIT = yes ] ; then
 323                 echo "* Downloading WebCit..."
 324                 FILENAME=$DOWNLOAD_SITE/$WEBCIT_SOURCE ; download_this
 325                 echo "* Installing WebCit..."
 326                 cd $BUILD 2>&1 >>$LOG || die
 327                 ( gzip -dc $WEBCIT_SOURCE | tar -xf - ) 2>&1 >>$LOG || die
 328                 cd $BUILD/webcit 2>&1 >>$LOG || die
 329                 ./configure --prefix=$WEBCIT --with-libical 2>&1 >>$LOG || die
 330                 $MAKE $MAKEOPTS 2>&1 >>$LOG || die
 331                 $MAKE install 2>&1 >>$LOG || die
 332                 echo "  Complete."
 333                 echo $SUM >$SUMFILE
 334         fi
 335 }
 336
 337
 338 do_config () {
 339         echo "* Configuring your system ..."
 340
 341         if [ x$IS_UPGRADE == xyes ] ; then
 342                 echo Upgrading your existing Citadel installation.
 343                 $CITADEL/setup </dev/tty || die
 344         else
 345                 echo This is a new Citadel installation.
 346                 $CITADEL/setup </dev/tty || die
 347         fi
 348
 349         $WEBCIT/setup </dev/tty || die
 350 }
 351
 352
 353
 354 ##### END Functions #####
 355
 356 ##### BEGIN main #####
 357
 358 # 1. Gather information about the target system
 359
 360 # Non-GNU make does not work.
 361 # This probably ought to be fixed, but for now we will simply require GNU make.
 362
 363 MAKE=xx
 364 if gmake -v 2>&1 | grep -i GNU ; then
 365         MAKE=`which gmake`
 366 else
 367         if make -v 2>&1 | grep -i GNU ; then
 368                 MAKE=`which make`
 369         fi
 370 fi
 371
 372 if [ $MAKE == xx ] ; then
 373         echo
 374         echo 'Easy Install requires GNU Make (gmake), which was not found.'
 375         echo 'Please install gmake and try again.'
 376         echo
 377         exit 1
 378 fi
 379
 380 export MAKE
 381
 382 clear
 383
 384 os=`uname`
 385
 386
 387 echo MAKE is $MAKE
 388 export MAKE
 389
 390 # 1A. Do we use the native packaging system or build our own copy of Citadel?
 391
 392 if [ "$os" = "Linux" ]; then
 393         determine_distribution
 394 elif [ "$os" = "FreeBSD" ]; then
 395         # TODO: We detect FreeBSD but the port is still out of date...
 396         DISTRO_MAJOR=FreeBSD
 397 elif [ "$os" = "Darwin" ]; then
 398         # TODO: Deal with Apple weirdness
 399         DISTRO_MAJOR=Darwin
 400 fi
 401
 402
 403 rm -rf $BUILD
 404 mkdir -p $BUILD
 405 cd $BUILD
 406
 407
 408
 409 # 2. Present the installation steps (from 1 above) to the user
 410 clear
 411 if dialog 2>&1 </dev/tty | grep gauge >/dev/null 2>&1 ; then
 412         CTDL_DIALOG=`which dialog`
 413         export CTDL_DIALOG
 414 elif cdialog 2>&1 </dev/tty | grep gauge >/dev/null 2>&1 ; then
 415         CTDL_DIALOG=`which cdialog`
 416         export CTDL_DIALOG
 417 fi
 418 clear
 419
 420 echo "$SETUP will perform the following actions:"
 421 echo ""
 422 echo "Installation:"
 423 echo "* Download/install supporting libraries (if needed)"
 424 echo "* Download/install Citadel (if needed)"
 425 echo "* Download/install WebCit (if needed)"
 426 echo ""
 427 echo "Configuration:"
 428 echo "* Configure Citadel"
 429 echo "* Configure WebCit"
 430 if [ x$IS_AUTOLOGIN = xyes ] ; then
 431         echo 'NOTE: this is an autologin installation.'
 432         echo '      Authentication against user accounts on the host system is enabled.'
 433 fi
 434 echo ""
 435 echo -n "Perform the above installation steps now? "
 436 read yesno </dev/tty
 437
 438 if [ "`echo $yesno | cut -c 1 | tr N n`" = "n" ]; then
 439         exit 2
 440 fi
 441
 442 echo ""
 443 echo "Command output will not be sent to the terminal."
 444 echo "To view progress, see the $LOG file."
 445 echo ""
 446
 447 # 3. Present any pre-install customizations to the user
 448
 449 # TODO: enter in the configuration dialogs
 450
 451 # Configure Citadel
 452
 453 # Configure WebCit
 454
 455 # 4. Do the installation
 456
 457 # 4A. Download any source code files or binary packages required
 458
 459 if [ "$prepackaged" ]; then
 460         download_packages
 461
 462 # 4B. For native packaging, call the native packaging system to install
 463
 464         install_packages
 465 else
 466
 467 # 4C. If we build our own, compile and install prerequisites then Citadel
 468
 469         install_prerequisites
 470         install_sources
 471 fi
 472
 473 # 5. Do post-installation setup
 474         rm -fr $BUILD
 475         do_config
 476 ##### END main #####