scripts/system/add_apache_site.sh

   1 #!/bin/bash
   2
   3 # creates a new apache website for a specified domain.
   4
   5 # auto-find the scripts, since we might want to run this as sudo.
   6 export WORKDIR="$( \cd "$(\dirname "$0")" && /bin/pwd )"  # obtain the script's working directory.
   7 export FEISTY_MEOW_APEX="$( \cd "$WORKDIR/../.." && \pwd )"
   8
   9 source "$FEISTY_MEOW_APEX/scripts/core/launch_feisty_meow.sh"
  10
  11 # some convenient defaults for our current usage.
  12
  13 BASE_PATH="$HOME/apps"
  14 STORAGE_SUFFIX="/public"
  15
  16 # this function writes out the new configuration file for the site.
  17 function write_apache_config()
  18 {
  19   local appname="$1"; shift
  20   local sitename="$1"; shift
  21   local site_path="$1"; shift
  22
  23   local site_config="/etc/apache2/sites-available/${sitename}.conf"
  24
  25   # check if config file already exists and bail if so.
  26   if [ -f "$site_config" ]; then
  27     echo "The apache configuration file already exists at:"
  28     echo "  $site_config"
  29     echo "Since apache configuration files can get very complex, we do not want to"
  30     echo "assume that this file is removable.  Calling the site addition done."
  31     exit 0
  32   fi
  33
  34   echo "Creating a new apache2 site for $sitename with config file:"
  35   echo "  $site_config"
  36
  37   # if no path, then we default to our standard app storage location.  otherwise, we
  38   # put the site where they told us to.
  39   if [ -z "$site_path" ]; then
  40     # path where site gets checked out, in some arcane manner, and which happens to be
  41     # above the path where we put webroot (in the storage suffix, if defined).
  42     local path_above="${BASE_PATH}/${appname}"
  43     # no slash between appname and suffix, in case suffix is empty.
  44     local full_path="${path_above}${STORAGE_SUFFIX}"
  45 #echo really full path is $full_path
  46   else
  47     # we'll go with their specification for the site storage.
  48     local full_path="$site_path"
  49   fi
  50
  51   echo "
  52 # set up the user's web folder as an apache user web directory.
  53
  54 # set permissions on the actual app folder.
  55 <Directory \"$full_path\">
  56   Options +ExecCGI +Indexes +FollowSymLinks +Includes +MultiViews
  57   Require all granted
  58 </Directory>
  59
  60 <VirtualHost *:80>
  61     ServerName ${sitename}
  62     DocumentRoot ${full_path}
  63     ErrorLog \${APACHE_LOG_DIR}/${sitename}-error.log
  64     CustomLog \${APACHE_LOG_DIR}/${sitename}-access.log combined
  65     Include /etc/apache2/conf-library/basic-options.conf
  66     Include /etc/apache2/conf-library/rewrite-enabling.conf
  67 </VirtualHost>
  68 " >"$site_config"
  69 }
  70
  71 # turns on the config file we create above for apache.
  72 function enable_site()
  73 {
  74   local sitename="$1"; shift
  75   local site_config="/etc/apache2/sites-available/${sitename}.conf"
  76
  77   outfile="$TMP/apacheout.$RANDOM"
  78   a2ensite "$(basename $site_config)" &>$outfile
  79   if [ $? -ne 0 ]; then
  80     # an error happened, so we show the command's output at least.
  81     cat $outfile
  82     echo
  83     echo "There was a problem enabling the apache config file in:"
  84     echo "  $site_config"
  85     echo "Please consult the apache error logs for more details."
  86     exit 1
  87   fi
  88   \rm "$outfile"
  89 }
  90
  91 # restarts the apache2 service.
  92 function restart_apache()
  93 {
  94   service apache2 restart
  95   if [ $? -ne 0 ]; then
  96     echo "There was a problem restarting the apache2 service."
  97     echo "Please consult the apache error logs for more details."
  98     exit 1
  99   fi
 100 }
 101
 102 # sets up the serverpilot storage location for a user hosted web site.
 103 function maybe_create_site_storage()
 104 {
 105   local our_app="$1"; shift
 106   # make sure the base path for storage of all the apps for this user exists.
 107   local full_path="$BASE_PATH/$our_app"
 108   if [ ! -d "$full_path" ]; then
 109     mkdir -p $full_path
 110     test_or_die "The app storage path could not be created.\n  Path in question is: $full_path"
 111   fi
 112
 113   # now give the web server some access to the folder.  this is crucial since the folders
 114   # can be hosted in any user folder, and the group permissions will not necessarily be correct already.
 115   local chow_path="$full_path"
 116   # only the first chmod is recursive; the rest just apply to the specific folder of interest.
 117   chmod -R g+rx "$chow_path"
 118   # walk backwards up the path and fix perms.
 119   while [[ $chow_path != $HOME ]]; do
 120 echo chow path is now $chow_path
 121     chmod g+rx "$chow_path"
 122     test_or_die "Failed to add group permissions on the path: $chow_path"
 123     # reassert the user's ownership of any directories we might have just created.
 124     chown $(logname) "$chow_path"
 125     test_or_die "changing ownership to user failed on the path: $chow_path"
 126     chow_path="$(dirname "$chow_path")"
 127   done
 128 }
 129
 130 # main body of script.
 131
 132 if [[ $EUID != 0 ]]; then
 133   echo "This script must be run as root or sudo."
 134   exit 1
 135 fi
 136
 137 appname="$1"; shift
 138 site="$1"; shift
 139 site_path="$1"; shift
 140
 141 if [ -z "$appname" -o -z "$site" ]; then
 142 #hmmm: move to a print_instructions function.
 143   echo "
 144 $(basename $0): {app name} {dns name} [site path]
 145
 146 This script needs to know (1) the application name for the new site and
 147 (2) the DNS name for the apache virtual host.  The appname should be an
 148 appropriate name for a file-system compatible folder name.  There is an
 149 optional third parameter (3) the path for site storage.  If the site path
 150 is not provided, we'll use this path:
 151   $BASE_PATH/{app name}/$STORAGE_SUFFIX"
 152   exit 1
 153 fi
 154
 155 maybe_create_site_storage "$appname"
 156 write_apache_config "$appname" "$site" "$site_path"
 157 enable_site "$site"
 158 restart_apache
 159