From: Dan Brown Date: Tue, 19 Apr 2022 18:42:46 +0000 (+0100) Subject: Changed output of ubuntu 22.04 script, added checks X-Git-Url: http://source.bookstackapp.com/devops/commitdiff_plain/dfd4005a9903d3ddbb06fe682a6675332ad9d950?ds=sidebyside Changed output of ubuntu 22.04 script, added checks - Added checks for existing apache/mysql usage before run. - Segmented script into functions and added custom output handling to capture core output into log file while showing simpler, pretty messages to the user. - Changed final output into a cleaner table. --- diff --git a/scripts/installation-ubuntu-22.04.sh b/scripts/installation-ubuntu-22.04.sh index 8576dbf..9510cba 100644 --- a/scripts/installation-ubuntu-22.04.sh +++ b/scripts/installation-ubuntu-22.04.sh @@ -4,12 +4,8 @@ echo "This script installs a new BookStack instance on a fresh Ubuntu 22.04 serv echo "This script does not ensure system security." echo "" -# Check we're running as root and exit if not -if [[ $EUID -gt 0 ]] -then - >&2 echo "ERROR: This script must be ran with root/sudo privileges" - exit 1 -fi +# Generate a path for a log file to output into for debugging +LOGPATH=$(realpath "bookstack_install_log_$(date +%s).log") # Get the current user running the script SCRIPT_USER="${SUDO_USER:-$USER}" @@ -17,102 +13,163 @@ SCRIPT_USER="${SUDO_USER:-$USER}" # Get the current machine IP address CURRENT_IP=$(ip addr | grep 'state UP' -A4 | grep 'inet ' | awk '{print $2}' | cut -f1 -d'/') -# Fetch domain to use from first provided parameter, -# Otherwise request the user to input their domain +# Generate a password for the database +DB_PASS="$(head /dev/urandom | tr -dc A-Za-z0-9 | head -c 13)" + +# The directory to install BookStack into +BOOKSTACK_DIR="/var/www/bookstack" + +# Get the domain from the arguments (Requested later if not set) DOMAIN=$1 -if [ -z "$1" ] -then - echo "" - echo "Enter the domain (or IP if not using a domain) you want to host BookStack on and press [ENTER]." - echo "Examples: my-site.com or docs.my-site.com or ${CURRENT_IP}" - read -r DOMAIN -fi - -# Ensure a domain was provided otherwise display -# an error message and stop the script -if [ -z "$DOMAIN" ] -then - >&2 echo 'ERROR: A domain must be provided to run this script' + +# Prevent interactive prompts in applications +export DEBIAN_FRONTEND=noninteractive + +# Echo out an error message to the command line and exit the program +# Also logs the message to the log file +function error_out() { + echo "ERROR: $1" | tee -a "$LOGPATH" 1>&2 exit 1 -fi +} + +# Echo out an information message to both the command line and log file +function info_msg() { + echo "$1" | tee -a "$LOGPATH" +} + +# Run some checks before installation to help prevent messing up an existing +# web-server setup. +function run_pre_install_checks() { + # Check we're running as root and exit if not + if [[ $EUID -gt 0 ]] + then + error_out "This script must be ran with root/sudo privileges" + fi + + # Check if Apache appears to be installed and exit if so + if [ -d "/etc/apache2/sites-enabled" ] + then + error_out "This script is intended for a fresh server install, existing apache config found, aborting install" + fi + + # Check if MySQL appears to be installed and exit if so + if [ -d "/var/lib/mysql" ] + then + error_out "This script is intended for a fresh server install, existing MySQL data found, aborting install" + fi +} + +# Fetch domain to use from first provided parameter, +# Otherwise request the user to input their domain +function run_prompt_for_domain_if_required() { + if [ -z "$DOMAIN" ] + then + info_msg "" + info_msg "Enter the domain (or IP if not using a domain) you want to host BookStack on and press [ENTER]." + info_msg "Examples: my-site.com or docs.my-site.com or ${CURRENT_IP}" + read -r DOMAIN + fi + + # Error out if no domain was provided + if [ -z "$DOMAIN" ] + then + error_out "A domain must be provided to run this script" + fi +} # Install core system packages -export DEBIAN_FRONTEND=noninteractive -apt update -apt install -y git unzip apache2 php8.1 curl php8.1-curl php8.1-mbstring php8.1-ldap \ -php8.1-xml php8.1-zip php8.1-gd php8.1-mysql mysql-server-8.0 libapache2-mod-php8.1 +function run_package_installs() { + apt update + apt install -y git unzip apache2 php8.1 curl php8.1-curl php8.1-mbstring php8.1-ldap \ + php8.1-xml php8.1-zip php8.1-gd php8.1-mysql mysql-server-8.0 libapache2-mod-php8.1 +} # Set up database -DB_PASS="$(head /dev/urandom | tr -dc A-Za-z0-9 | head -c 13)" -mysql -u root --execute="CREATE DATABASE bookstack;" -mysql -u root --execute="CREATE USER 'bookstack'@'localhost' IDENTIFIED WITH mysql_native_password BY '$DB_PASS';" -mysql -u root --execute="GRANT ALL ON bookstack.* TO 'bookstack'@'localhost';FLUSH PRIVILEGES;" +function run_database_setup() { + mysql -u root --execute="CREATE DATABASE bookstack;" + mysql -u root --execute="CREATE USER 'bookstack'@'localhost' IDENTIFIED WITH mysql_native_password BY '$DB_PASS';" + mysql -u root --execute="GRANT ALL ON bookstack.* TO 'bookstack'@'localhost';FLUSH PRIVILEGES;" +} # Download BookStack -cd /var/www || exit -git clone https://github.com/BookStackApp/BookStack.git --branch release --single-branch bookstack -BOOKSTACK_DIR="/var/www/bookstack" - -# Move into the BookStack install directory -cd $BOOKSTACK_DIR || exit +function run_bookstack_download() { + cd /var/www || exit + git clone https://github.com/BookStackApp/BookStack.git --branch release --single-branch bookstack +} # Install composer -EXPECTED_CHECKSUM="$(php -r 'copy("https://composer.github.io/installer.sig", "php://stdout");')" -php -r "copy('https://getcomposer.org/installer', 'composer-setup.php');" -ACTUAL_CHECKSUM="$(php -r "echo hash_file('sha384', 'composer-setup.php');")" +function run_install_composer() { + EXPECTED_CHECKSUM="$(php -r 'copy("https://composer.github.io/installer.sig", "php://stdout");')" + php -r "copy('https://getcomposer.org/installer', 'composer-setup.php');" + ACTUAL_CHECKSUM="$(php -r "echo hash_file('sha384', 'composer-setup.php');")" -if [ "$EXPECTED_CHECKSUM" != "$ACTUAL_CHECKSUM" ] -then - >&2 echo 'ERROR: Invalid composer installer checksum' - rm composer-setup.php - exit 1 -fi + if [ "$EXPECTED_CHECKSUM" != "$ACTUAL_CHECKSUM" ] + then + >&2 echo 'ERROR: Invalid composer installer checksum' + rm composer-setup.php + exit 1 + fi -php composer-setup.php --quiet -rm composer-setup.php + php composer-setup.php --quiet + rm composer-setup.php -# Move composer to global installation -mv composer.phar /usr/local/bin/composer + # Move composer to global installation + mv composer.phar /usr/local/bin/composer +} # Install BookStack composer dependencies -export COMPOSER_ALLOW_SUPERUSER=1 -php /usr/local/bin/composer install --no-dev --no-plugins +function run_install_bookstack_composer_deps() { + cd "$BOOKSTACK_DIR" || exit + export COMPOSER_ALLOW_SUPERUSER=1 + php /usr/local/bin/composer install --no-dev --no-plugins +} # Copy and update BookStack environment variables -cp .env.example .env -sed -i.bak "s@APP_URL=.*\$@APP_URL=http://$DOMAIN@" .env -sed -i.bak 's/DB_DATABASE=.*$/DB_DATABASE=bookstack/' .env -sed -i.bak 's/DB_USERNAME=.*$/DB_USERNAME=bookstack/' .env -sed -i.bak "s/DB_PASSWORD=.*\$/DB_PASSWORD=$DB_PASS/" .env - -# Generate the application key -php artisan key:generate --no-interaction --force -# Migrate the databases -php artisan migrate --no-interaction --force +function run_update_bookstack_env() { + cd "$BOOKSTACK_DIR" || exit + cp .env.example .env + sed -i.bak "s@APP_URL=.*\$@APP_URL=http://$DOMAIN@" .env + sed -i.bak 's/DB_DATABASE=.*$/DB_DATABASE=bookstack/' .env + sed -i.bak 's/DB_USERNAME=.*$/DB_USERNAME=bookstack/' .env + sed -i.bak "s/DB_PASSWORD=.*\$/DB_PASSWORD=$DB_PASS/" .env + # Generate the application key + php artisan key:generate --no-interaction --force +} + +# Run the BookStack database migrations for the first time +function run_bookstack_database_migrations() { + cd "$BOOKSTACK_DIR" || exit + php artisan migrate --no-interaction --force +} # Set file and folder permissions # Sets current user as owner user and www-data as owner group then # provides group write access only to required directories. # Hides the `.env` file so it's not visible to other users on the system. -chown -R "$SCRIPT_USER":www-data ./ -chmod -R 755 ./ -chmod -R 775 bootstrap/cache public/uploads storage -chmod 740 .env - -# Tell git to ignore permission changes -git config core.fileMode false - -# Enable required apache modules -a2enmod rewrite -a2enmod php8.1 - -# Set-up the required BookStack apache config -cat >/etc/apache2/sites-available/bookstack.conf </etc/apache2/sites-available/bookstack.conf < - ServerName ${DOMAIN} + ServerName ${DOMAIN} - ServerAdmin webmaster@localhost - DocumentRoot /var/www/bookstack/public/ + ServerAdmin webmaster@localhost + DocumentRoot /var/www/bookstack/public/ Options -Indexes +FollowSymLinks @@ -141,22 +198,62 @@ cat >/etc/apache2/sites-available/bookstack.conf < - ErrorLog \${APACHE_LOG_DIR}/error.log - CustomLog \${APACHE_LOG_DIR}/access.log combined + ErrorLog \${APACHE_LOG_DIR}/error.log + CustomLog \${APACHE_LOG_DIR}/access.log combined EOL -# Disable the default apache site and enable BookStack -a2dissite 000-default.conf -a2ensite bookstack.conf + # Disable the default apache site and enable BookStack + a2dissite 000-default.conf + a2ensite bookstack.conf -# Restart apache to load new config -systemctl restart apache2 + # Restart apache to load new config + systemctl restart apache2 +} -echo "" -echo "Setup Finished, Your BookStack instance should now be installed." -echo "You can login with the email 'admin@admin.com' and password of 'password'" -echo "MySQL was installed without a root password, It is recommended that you set a root MySQL password." -echo "" -echo "You can access your BookStack instance at: http://$CURRENT_IP/ or http://$DOMAIN/" +info_msg "This script logs full output to $LOGPATH which may help upon issues." +sleep 1 + +run_pre_install_checks +run_prompt_for_domain_if_required +info_msg "" +info_msg "Installing using the domain/IP \"$DOMAIN\"" +info_msg "" +sleep 1 + +info_msg "[1/9] Installing required system packages... (This may take several minutes)" +run_package_installs >> "$LOGPATH" 2>&1 + +info_msg "[2/9] Preparing MySQL database..." +run_database_setup >> "$LOGPATH" 2>&1 + +info_msg "[3/9] Downloading BookStack to ${BOOKSTACK_DIR}..." +run_bookstack_download >> "$LOGPATH" 2>&1 + +info_msg "[4/9] Installing Composer (PHP dependency manager)..." +run_install_composer >> "$LOGPATH" 2>&1 + +info_msg "[5/9] Installing PHP dependencies using composer..." +run_install_bookstack_composer_deps >> "$LOGPATH" 2>&1 + +info_msg "[6/9] Creating and populating BookStack .env file..." +run_update_bookstack_env >> "$LOGPATH" 2>&1 + +info_msg "[7/9] Running initial BookStack database migrations..." +run_bookstack_database_migrations >> "$LOGPATH" 2>&1 + +info_msg "[8/9] Setting BookStack file & folder permissions..." +run_set_application_file_permissions >> "$LOGPATH" 2>&1 + +info_msg "[9/9] Configuring apache server..." +run_configure_apache >> "$LOGPATH" 2>&1 + +info_msg "----------------------------------------------------------------" +info_msg "Setup finished, your BookStack instance should now be installed!" +info_msg "Default login email: admin@admin.com" +info_msg "Default login password: password" +info_msg "Access URL: http://$CURRENT_IP/ or http://$DOMAIN/" +info_msg "BookStack Install Directory: $BOOKSTACK_DIR" +info_msg "Install Script Log: $LOGPATH" +info_msg "---------------------------------------------------------------"