Merge pull request #53 from jdeathe/issue/44

ISSUE 44: Disabled ExtendedStatus by default and added option for ope…

Author: jdeathe

README.md

@@ -46,7 +46,30 @@ $ docker run -d \
 
 Now point your browser to ```http://<docker-host>:8080``` where "```<docker-host>```" is the host name of your docker server and, if all went well, you should see the "Hello, world!" page.
 
-![Hello World Screen Shot](https://raw.github.com/jdeathe/centos-ssh-apache-php-fcgi/centos-6/images/hello-world.png)
+![Hello World - PHP FastCGI Screen Shot - Chrome](https://raw.github.com/jdeathe/centos-ssh-apache-php/centos-6/images/hello-world-php-fcgi-chrome.png)
+
+To be able to access the server using the "app-1.local" domain name you need to add a hosts file entry locally; such that the IP address of the Docker host resolves to the name "app-1.local". Alternatively, you can use the elinks browser installed in the container. Note that because you are using the browser from the container you access the site over port 80.
+
+```
+$ docker exec -it apache-php.app-1.1.1 \
+  elinks http://app-1.local
+```
+
+![Hello World - PHP FastCGI Screen Shot - eLinks](https://raw.github.com/jdeathe/centos-ssh-apache-php/centos-6/images/hello-world-php-fcgi-elinks.png)
+
+To verify the container is initialised and running successfully by inspecting the container's logs.
+
+```
+$ docker logs apache-php.app-1.1.1
+```
+
+On first run, the bootstrap script, ([/etc/apache-bootstrap](https://github.com/jdeathe/centos-ssh-apache-php-fcgi/blob/centos-6/etc/apache-bootstrap)), will check if the DocumentRoot directory is empty and, if so, will populate it with the example app scripts and VirtualHost configuration files. If you place your own app in this directory it will not be overwritten but you must ensure to include at least a vhost.conf file and, if enabling SSL a vhost-ssl.conf file too.
+
+The ```apachectl``` command can be accessed as follows.
+
+```
+$ docker exec -it apache-php.app-1.1.1 apachectl -h
+```
 
 ## Instructions
 
@@ -91,10 +114,11 @@ $ docker run -d \
   --env "SERVICE_UNIT_INSTANCE=app-1" \
   --env "SERVICE_UNIT_LOCAL_ID=1" \
   --env "SERVICE_UNIT_INSTANCE=1" \
-  --env "APACHE_SERVER_ALIAS=app-1" \
-  --env "APACHE_SERVER_NAME=app-1.local" \
+  --env "APACHE_EXTENDED_STATUS_ENABLED=false" \
   --env "APACHE_LOAD_MODULES=authz_user_module log_config_module expires_module deflate_module headers_module setenvif_module mime_module status_module dir_module alias_module rewrite_module" \
   --env "APACHE_MOD_SSL_ENABLED=false" \
+  --env "APACHE_SERVER_ALIAS=app-1" \
+  --env "APACHE_SERVER_NAME=app-1.local" \
   --env "APP_HOME_DIR=/var/www/app-1" \
   --env "DATE_TIMEZONE=UTC" \
   --env "SERVICE_USER=app" \
@@ -162,7 +186,26 @@ The ```APACHE_SERVER_NAME``` and ```APACHE_SERVER_ALIAS``` environmental variabl
 
 from your browser you can then access it with ```http://app-1.local:8080``` assuming you have the IP address of your docker mapped to the hostname using your DNS server or a local hosts entry.
 
-##### 3. APACHE_LOAD_MODULES
+##### 3. APACHE_EXTENDED_STATUS_ENABLED
+
+The variable ```APACHE_EXTENDED_STATUS_ENABLED``` allows you to turn ExtendedStatus on. It is turned off by default as it has an impact on the server's performance but with it enabled you can gather more statistics.
+
+```
+...
+  --env "APACHE_EXTENDED_STATUS_ENABLED=true"
+...
+```
+
+You can view the output from Apache server-status either using the elinks browser from onboard the container or by using `watch` and `curl` to monitor status over time - the following command shows the server-status updated at a 1 second interval.
+
+```
+$ docker exec -it apache-php.app-1.1.1 \
+  env TERM=xterm \
+  watch -n 10 \
+  -d "curl -s http://app-1/_httpdstatus?auto"
+```
+
+##### 4. APACHE_LOAD_MODULES
 
 The variable ```APACHE_LOAD_MODULES``` defines all Apache modules to be loaded from */etc/httpd/conf/http.conf*. The default is the minimum required so you may need to add more as necessary. To add the "mod\_rewrite" Apache Module you would add it's identifier ```rewrite_module``` to the array as follows.
 
@@ -172,7 +215,7 @@ The variable ```APACHE_LOAD_MODULES``` defines all Apache modules to be loaded f
 ...
 ```
 
-##### 4. APACHE_MOD_SSL_ENABLED
+##### 5. APACHE_MOD_SSL_ENABLED
 
 By default SSL support is disabled but a second port, (mapped to 8443), is available for traffic that has been been through upstream SSL termination (SSL Offloading). If you want the container to support SSL directly then set ```APACHE_MOD_SSL_ENABLED=true``` this will then generate a self signed certificate and will update Apache to accept traffic on port 443.
 
@@ -196,7 +239,7 @@ $ docker run -d \
   jdeathe/centos-ssh-apache-php-fcgi:latest
 ```
 
-##### 5. APP_HOME_DIR
+##### 6. APP_HOME_DIR
 
 The home directory of the service user and parent directory of the Apache DocumentRoot is  /var/www/app by default but can be changed if necessary using the ```APP_HOME_DIR``` environment variable. It is also necessary to change the target of the data volume mapping accordingly as in the following example where /var/www/app-1 is used.
 
@@ -207,7 +250,7 @@ The home directory of the service user and parent directory of the Apache Docume
 ...
 ```
 
-##### 6. DATE_TIMEZONE
+##### 7. DATE_TIMEZONE
 
 The default timezone for the container, and the PHP app, is UTC however the operator can set an appropriate timezone using the ```DATE_TIMEZONE``` variable. The value should be a timezone identifier, like UTC or Europe/London. The list of valid identifiers is available in the PHP [List of Supported Timezones](http://php.net/manual/en/timezones.php).
 
@@ -219,7 +262,7 @@ To set the timezone for the UK and account for British Summer Time you would use
 ...
 ```
 
-##### 7. SERVICE_USER, SERVICE_USER_GROUP & SERVICE_USER_PASSWORD
+##### 8. SERVICE_USER, SERVICE_USER_GROUP & SERVICE_USER_PASSWORD
 
 Use the ```SERVICE_USER```, ```SERVICE_USER_GROUP``` and ```SERVICE_USER_PASSWORD``` environment variables to define a custom service username, group and password respectively. If the password is left an empty string then it is automatically generated on first run which is the default.
 
@@ -266,5 +309,3 @@ The supervisor service's configuration can also be overridden by editing the cus
 ### Apache DocumentRoot - Data Directory
 
 In the previous example Docker run commands we mapped the Docker host directory ```/var/services-data/apache-php/app-1``` to ```/var/www/app``` in the Docker container, where ```/var/services-data/``` is the directory used to store persistent files and the subdirectory is used by an individual app's named container(s), ```apache-php.app-1.1.1```, in the previous examples.
-
-On first run, the bootstrap script, ([/etc/apache-bootstrap](https://github.com/jdeathe/centos-ssh-apache-php-fcgi/blob/centos-6/etc/apache-bootstrap)), will check if the DocumentRoot directory is empty and, if so, will populate it with the example app scripts and VirtualHost configuration files. If you place your own app in this directory it will not be overwritten but you must ensure to include at least a vhost.conf file and, if enabling SSL a vhost-ssl.conf file too.

etc/apache-bootstrap

@@ -29,6 +29,26 @@ get_password ()
 	echo $(head -n 4096 /dev/urandom | tr -cd '[:alnum:]' | head -c ${1})
 }
 
+set_apache_extended_status ()
+{
+	local ENABLED=${1:-false}
+	local PATTERN_FROM
+	local PATTERN_TO
+
+	if [[ ${ENABLED} == true ]]; then
+		echo "Enabling ExtendedStatus."
+		PATTERN_FROM="^[#]?ExtendedStatus (On|on|Off|off)$"
+		PATTERN_TO="ExtendedStatus On"
+	else
+		PATTERN_FROM="^ExtendedStatus (On|on)$"
+		PATTERN_TO="#ExtendedStatus On"
+	fi
+
+	sed -i \
+		-re "s~${PATTERN_FROM}~${PATTERN_TO}~g" \
+		/etc/httpd/conf/httpd.conf
+}
+
 set_apache_server_name ()
 {
 	local HOST_NAME=${1:-${APACHE_SERVER_NAME:-$(hostname)}}
@@ -41,10 +61,11 @@ set_apache_server_name ()
 
 APP_HOME_DIR_TEMPLATE="/var/www/.app-skel"
 
-OPTS_APACHE_SERVER_ALIAS="${APACHE_SERVER_ALIAS:-}"
-OPTS_APACHE_SERVER_NAME="${APACHE_SERVER_NAME:-$(hostname)}"
+OPTS_APACHE_EXTENDED_STATUS_ENABLED="${APACHE_EXTENDED_STATUS_ENABLED:-false}"
 OPTS_APACHE_LOAD_MODULES="${APACHE_LOAD_MODULES:-authz_user_module log_config_module expires_module deflate_module headers_module setenvif_module mime_module status_module dir_module alias_module reqtimeout_module}"
 OPTS_APACHE_MOD_SSL_ENABLED="${APACHE_MOD_SSL_ENABLED:-false}"
+OPTS_APACHE_SERVER_ALIAS="${APACHE_SERVER_ALIAS:-}"
+OPTS_APACHE_SERVER_NAME="${APACHE_SERVER_NAME:-$(hostname)}"
 OPTS_APP_HOME_DIR="${APP_HOME_DIR:-/var/www/app}"
 OPTS_SERVICE_USER="${SERVICE_USER:-app}"
 OPTS_SERVICE_USER_GROUP="${SERVICE_USER_GROUP:-app-www}"
@@ -94,6 +115,9 @@ fi
 # Add local hosts entries
 add_hosts_entry 127.0.0.1 ${OPTS_APACHE_SERVER_NAME}${OPTS_APACHE_SERVER_ALIAS:+ }${OPTS_APACHE_SERVER_ALIAS}
 
+# Set ExtendedStatus
+set_apache_extended_status ${OPTS_APACHE_EXTENDED_STATUS_ENABLED}
+
 # Add ServerName
 set_apache_server_name ${OPTS_APACHE_SERVER_NAME} 80
 

etc/services-config/httpd/apache-bootstrap.conf

@@ -15,10 +15,11 @@ SERVICE_UNIT_APP_GROUP="${SERVICE_UNIT_APP_GROUP:-app-1}"
 SERVICE_UNIT_LOCAL_ID="${SERVICE_UNIT_LOCAL_ID:-1}"
 SERVICE_UNIT_INSTANCE="${SERVICE_UNIT_INSTANCE:-1}"
 
-APACHE_SERVER_ALIAS="${APACHE_SERVER_ALIAS:-}"
-APACHE_SERVER_NAME="${APACHE_SERVER_NAME:-${SERVICE_UNIT_APP_GROUP}.local}"
+APACHE_EXTENDED_STATUS_ENABLED="${APACHE_EXTENDED_STATUS_ENABLED:-false}"
 APACHE_LOAD_MODULES="${APACHE_LOAD_MODULES:-${APACHE_LOAD_MODULES_DEFAULT}}"
 APACHE_MOD_SSL_ENABLED="${APACHE_MOD_SSL_ENABLED:-false}"
+APACHE_SERVER_ALIAS="${APACHE_SERVER_ALIAS:-}"
+APACHE_SERVER_NAME="${APACHE_SERVER_NAME:-${SERVICE_UNIT_APP_GROUP}.local}"
 APP_HOME_DIR="${APP_HOME_DIR:-/var/www/app}"
 DATE_TIMEZONE="${DATE_TIMEZONE:-UTC}"
 HTTPD="${HTTPD:-/usr/sbin/httpd}"

etc/services-config/httpd/conf/httpd.conf

@@ -225,7 +225,7 @@ Include conf.d/*.conf
 # information (ExtendedStatus On) or just basic information (ExtendedStatus
 # Off) when the "server-status" handler is called. The default is Off.
 #
-ExtendedStatus On
+#ExtendedStatus On
 
 #
 # If you wish httpd to run as a different user or group, you must run

images/hello-world-php-fcgi-chrome.png

@@ -43,6 +43,7 @@ APACHE_LOAD_MODULES_DEFAULT="
  alias_module
 "
 
+APACHE_EXTENDED_STATUS_ENABLED=false
 APACHE_LOAD_MODULES="${APACHE_LOAD_MODULES_DEFAULT}"
 APACHE_MOD_SSL_ENABLED=false
 APACHE_SERVER_ALIAS=app-1

images/hello-world-php-fcgi-elinks.png

@@ -151,6 +151,7 @@ docker run \
 	--env "SERVICE_UNIT_APP_GROUP=${SERVICE_UNIT_APP_GROUP}" \
 	--env "SERVICE_UNIT_LOCAL_ID=${SERVICE_UNIT_LOCAL_ID}" \
 	--env "SERVICE_UNIT_INSTANCE=${SERVICE_UNIT_INSTANCE}" \
+	--env "APACHE_EXTENDED_STATUS_ENABLED=${APACHE_EXTENDED_STATUS_ENABLED}" \
 	--env "APACHE_LOAD_MODULES=${APACHE_LOAD_MODULES}" \
 	--env "APACHE_MOD_SSL_ENABLED=${APACHE_MOD_SSL_ENABLED}" \
 	--env "APACHE_SERVER_ALIAS=${APACHE_SERVER_ALIAS}" \
@@ -180,6 +181,7 @@ docker run \
 # 	--env "SERVICE_UNIT_APP_GROUP=app-1" \
 # 	--env "SERVICE_UNIT_LOCAL_ID=1" \
 # 	--env "SERVICE_UNIT_INSTANCE=1" \
+# 	--env "APACHE_EXTENDED_STATUS_ENABLED=true"
 # 	--env "APACHE_LOAD_MODULES=${APACHE_LOAD_MODULES} rewrite_module" \
 # 	--env "APACHE_MOD_SSL_ENABLED=false" \
 # 	--env "APACHE_SERVER_ALIAS=app-1 www.app-1 www.app-1.local" \