3 # creates a new apache website for a specified domain.
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 )"
9 source "$FEISTY_MEOW_APEX/scripts/core/launch_feisty_meow.sh"
11 # some convenient defaults for our current usage.
13 if [ -z "$BASE_APPLICATION_PATH" ]; then
14 BASE_APPLICATION_PATH="$HOME/apps"
16 if [ -z "$STORAGE_SUFFIX" ]; then
17 STORAGE_SUFFIX="/public"
20 # this function writes out the new configuration file for the site.
21 function write_apache_config()
23 local appname="$1"; shift
24 local sitename="$1"; shift
25 local site_path="$1"; shift
27 local site_config="/etc/apache2/sites-available/${sitename}.conf"
29 # check if config file already exists and bail if so.
30 if [ -f "$site_config" ]; then
31 echo "The apache configuration file already exists at:"
33 echo "Since apache configuration files can get very complex, we do not want to"
34 echo "assume that this file is removable. Calling the site addition done."
38 echo "Creating a new apache2 site for $sitename with config file:"
41 # if no path, then we default to our standard app storage location. otherwise, we
42 # put the site where they told us to.
43 if [ -z "$site_path" ]; then
44 # path where site gets checked out, in some arcane manner, and which happens to be
45 # above the path where we put webroot (in the storage suffix, if defined).
46 local path_above="${BASE_APPLICATION_PATH}/${appname}"
47 # no slash between appname and suffix, in case suffix is empty.
48 local full_path="${path_above}${STORAGE_SUFFIX}"
49 #echo really full path is $full_path
51 # we'll go with their specification for the site storage.
52 local full_path="$site_path"
56 # set up the user's web folder as an apache user web directory.
58 # set permissions on the actual app folder.
59 <Directory \"$full_path\">
60 Options +ExecCGI +Indexes +FollowSymLinks +Includes +MultiViews
65 ServerName ${sitename}
66 DocumentRoot ${full_path}
67 ErrorLog \${APACHE_LOG_DIR}/${sitename}-error.log
68 CustomLog \${APACHE_LOG_DIR}/${sitename}-access.log combined
69 Include /etc/apache2/conf-library/basic-options.conf
70 Include /etc/apache2/conf-library/rewrite-enabling.conf
74 chown "$(logname):$(logname)" "$site_config"
75 test_or_die "setting ownership on: $site_config"
78 # turns on the config file we create above for apache.
79 function enable_site()
81 local sitename="$1"; shift
82 local site_config="/etc/apache2/sites-available/${sitename}.conf"
84 outfile="$TMP/apacheout.$RANDOM"
85 a2ensite "$(basename $site_config)" &>$outfile
87 # an error happened, so we show the command's output at least.
90 echo "There was a problem enabling the apache config file in:"
92 echo "Please consult the apache error logs for more details."
98 # restarts the apache2 service.
99 function restart_apache()
101 service apache2 restart
102 if [ $? -ne 0 ]; then
103 echo "There was a problem restarting the apache2 service."
104 echo "Please consult the apache error logs for more details."
109 # sets up the serverpilot storage location for a user hosted web site.
110 function maybe_create_site_storage()
112 local our_app="$1"; shift
113 # make sure the path for storage this app exists for the user.
114 local full_path="$BASE_APPLICATION_PATH/$our_app"
115 if [ ! -d "$full_path" ]; then
117 test_or_die "The app storage path could not be created.\n Path in question is: $full_path"
120 # now give the web server some access to the folder. this is crucial since the folders
121 # can be hosted in any user folder, and the group permissions will not necessarily be correct already.
122 local chow_path="$full_path"
123 # only the first chmod is recursive; the rest just apply to the specific folder of interest.
124 chmod -R g+rx "$chow_path"
125 # walk backwards up the path and fix perms.
126 while [[ $chow_path != $HOME ]]; do
127 echo chow path is now $chow_path
128 chmod g+rx "$chow_path"
129 test_or_die "Failed to add group permissions on the path: $chow_path"
130 # reassert the user's ownership of any directories we might have just created.
131 chown $(logname) "$chow_path"
132 test_or_die "changing ownership to user failed on the path: $chow_path"
133 chow_path="$(dirname "$chow_path")"
137 # main body of script.
139 if [[ $EUID != 0 ]]; then
140 echo "This script must be run as root or sudo."
146 site_path="$1"; shift
148 if [ -z "$appname" -o -z "$site" ]; then
149 #hmmm: move to a print_instructions function.
151 $(basename $0): {app name} {dns name} [site path]
153 This script needs to know (1) the application name for the new site and
154 (2) the DNS name for the apache virtual host. The appname should be an
155 appropriate name for a file-system compatible folder name. There is an
156 optional third parameter (3) the path for site storage. If the site path
157 is not provided, we'll use this path:
158 $BASE_APPLICATION_PATH/{app name}/$STORAGE_SUFFIX"
162 maybe_create_site_storage "$appname"
163 write_apache_config "$appname" "$site" "$site_path"