Merge pull request #56 from jdeathe/master

Release changes ready for centos-6-1.4.1

Author: jdeathe

Dockerfile

@@ -4,7 +4,7 @@
 # CentOS-6, Apache 2.2, PHP 5.3, PHP Memcached 1.0, PHP APC 3.1.
 # 
 # =============================================================================
-FROM jdeathe/centos-ssh-apache-php:centos-6-1.4.0
+FROM jdeathe/centos-ssh-apache-php:centos-6-1.4.1
 
 MAINTAINER James Deathe <james.deathe@gmail.com>
 
@@ -35,13 +35,6 @@ RUN sed -i \
 	-e 's~^;cgi.fix_pathinfo=1$~cgi.fix_pathinfo=1~g' \
 	/etc/php.ini
 
-# -----------------------------------------------------------------------------
-# Enable Apache MPM worker
-# -----------------------------------------------------------------------------
-RUN sed -i \
-	-e 's~#HTTPD=/usr/sbin/httpd.worker~HTTPD=/usr/sbin/httpd.worker~g' \
-	/etc/sysconfig/httpd
-
 # -----------------------------------------------------------------------------
 # Disable mod_php
 # -----------------------------------------------------------------------------
@@ -65,6 +58,29 @@ RUN ln -sf /etc/services-config/httpd/apache-bootstrap.conf /etc/apache-bootstra
 	&& ln -sf /etc/services-config/httpd/conf.d/fcgid.conf /etc/httpd/conf.d/fcgid.conf \
 	&& chmod +x /etc/apache-bootstrap
 
+# -----------------------------------------------------------------------------
+# Set default environment variables used to identify the service container
+# -----------------------------------------------------------------------------
+ENV SERVICE_UNIT_APP_GROUP app-1
+ENV SERVICE_UNIT_LOCAL_ID 1
+ENV SERVICE_UNIT_INSTANCE 1
+
+# -----------------------------------------------------------------------------
+# Set default environment variables used to configure the service container
+# -----------------------------------------------------------------------------
+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"
+ENV APACHE_MOD_SSL_ENABLED false
+ENV APACHE_SERVER_ALIAS ""
+ENV APACHE_SERVER_NAME app-1.local
+ENV APP_HOME_DIR /var/www/app
+ENV DATE_TIMEZONE UTC
+ENV HTTPD /usr/sbin/httpd.worker
+ENV SERVICE_USER app
+ENV SERVICE_USER_GROUP app-www
+ENV SERVICE_USER_PASSWORD ""
+ENV SUEXECUSERGROUP false
+
 EXPOSE 80 8443 443
 
 CMD ["/usr/bin/supervisord", "--configuration=/etc/supervisord.conf"]

README.md

@@ -13,7 +13,7 @@ This build of [Apache](https://httpd.apache.org/), (httpd CentOS package), uses
 
 Included in the build are the [EPEL](http://fedoraproject.org/wiki/EPEL) and [IUS](https://ius.io/) repositories. Installed packages include [OpenSSH](http://www.openssh.com/portable.html) secure shell, [vim-minimal](http://www.vim.org/), [elinks](http://elinks.or.cz) (for fullstatus support), PHP [APC](http://pecl.php.net/package/APC), PHP [Memcached](http://pecl.php.net/package/memcached) are installed along with python-setuptools, [supervisor](http://supervisord.org/) and [supervisor-stdout](https://github.com/coderanger/supervisor-stdout).
 
-Supervisor is used to start httpd.worker daemon when a docker container based on this image is run. To enable simple viewing of stdout for the sshd subprocess, supervisor-stdout is included. This allows you to see output from the supervisord controlled subprocesses with ```docker logs <docker-container-name>```.
+Supervisor is used to start httpd.worker daemon when a docker container based on this image is run. To enable simple viewing of stdout for the service's subprocess, supervisor-stdout is included. This allows you to see output from the supervisord controlled subprocesses with ```docker logs <docker-container-name>```.
 
 If enabling and configuring SSH access, it is by public key authentication and, by default, the [Vagrant](http://www.vagrantup.com/) [insecure private key](https://github.com/mitchellh/vagrant/blob/master/keys/vagrant) is required.
 
@@ -38,7 +38,6 @@ $ docker run -d \
   --env "SERVICE_UNIT_APP_GROUP=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 "DATE_TIMEZONE=UTC" \
   -v /var/services-data/apache-php/app-1:/var/www/app \
@@ -47,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
 
@@ -92,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" \
@@ -163,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.
 
@@ -173,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.
 
@@ -197,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.
 
@@ -208,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).
 
@@ -220,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.
 
@@ -267,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.

apache-php.app-1.1.1@8080.service

@@ -32,7 +32,13 @@ TimeoutStartSec=1200
 Environment="MOUNT_PATH_CONFIG=/etc/services-config"
 Environment="MOUNT_PATH_DATA=/var/services-data"
 Environment="DOCKER_IMAGE_NAME=jdeathe/centos-ssh-apache-php-fcgi"
-Environment="DOCKER_IMAGE_TAG=centos-6-1.4.0"
+Environment="DOCKER_IMAGE_TAG=centos-6-1.4.1"
+Environment="SERVICE_UNIT_APP_GROUP=app-1"
+Environment="SERVICE_UNIT_LOCAL_ID=1"
+Environment="SERVICE_UNIT_INSTANCE=1"
+Environment="APACHE_SERVER_ALIAS=app-1"
+Environment="APACHE_SERVER_NAME=app-1.local"
+Environment="DATE_TIMEZONE=UTC"
 
 # Create a data container for the configuration volume
 ExecStartPre=/bin/sudo /bin/bash -c \
@@ -80,34 +86,43 @@ ExecStart=/bin/sudo /bin/bash -c \
       --name %p \
       -p %i:80 \
       -p 8580:8443 \
-      --env SERVICE_UNIT_INSTANCE=app-1 \
-      --env SERVICE_UNIT_LOCAL_ID=1 \
-      --env SERVICE_UNIT_INSTANCE=1 \
-      --env APACHE_SERVER_NAME=app-1.local \
-      --env APACHE_SERVER_ALIAS=app-1 \
-      --env DATE_TIMEZONE=UTC \
+      --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_SERVER_ALIAS=${APACHE_SERVER_ALIAS} \
+      --env APACHE_SERVER_NAME=${APACHE_SERVER_NAME} \
+      --env DATE_TIMEZONE=${DATE_TIMEZONE} \
       --volumes-from volume-config.%p \
-      -v ${MOUNT_PATH_DATA}/apache-php/app-1:/var/www/app \
+      -v ${MOUNT_PATH_DATA}/apache-php/${SERVICE_UNIT_APP_GROUP}:/var/www/app \
       ${DOCKER_IMAGE_NAME}:${DOCKER_IMAGE_TAG}; \
   else \
     /usr/bin/docker run \
       --name %p \
       -p %i:80 \
       -p 8580:8443 \
-      --env SERVICE_UNIT_INSTANCE=app-1 \
-      --env SERVICE_UNIT_LOCAL_ID=1 \
-      --env SERVICE_UNIT_INSTANCE=1 \
-      --env APACHE_SERVER_NAME=app-1.local \
-      --env APACHE_SERVER_ALIAS=app-1 \
-      --env DATE_TIMEZONE=UTC \
-      -v ${MOUNT_PATH_DATA}/apache-php/app-1:/var/www/app \
+      --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=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' \
+      --env APACHE_MOD_SSL_ENABLED=false \
+      --env APACHE_SERVER_ALIAS=${APACHE_SERVER_ALIAS} \
+      --env APACHE_SERVER_NAME=${APACHE_SERVER_NAME} \
+      --env APP_HOME_DIR=/var/www/app \
+      --env DATE_TIMEZONE=${DATE_TIMEZONE} \
+      --env HTTPD=/usr/sbin/httpd \
+      --env SERVICE_USER=app \
+      --env SERVICE_USER_GROUP=app-www \
+      --env SERVICE_USER_PASSWORD= \
+      --env SUEXECUSERGROUP=false \
+      -v ${MOUNT_PATH_DATA}/apache-php/${SERVICE_UNIT_APP_GROUP}:/var/www/app \
       ${DOCKER_IMAGE_NAME}:${DOCKER_IMAGE_TAG}; \
   fi"
 
-ExecStartPost=/usr/bin/etcdctl set /services/apache-php/app-1/1.1 %H:%i
+ExecStartPost=/usr/bin/etcdctl set /services/apache-php/${SERVICE_UNIT_APP_GROUP}/${SERVICE_UNIT_LOCAL_ID}.${SERVICE_UNIT_INSTANCE} %H:%i
 
 ExecStop=/usr/bin/docker stop --time 10 %p
-ExecStopPost=/usr/bin/etcdctl rm /services/apache-php/app-1/1.1
+ExecStopPost=/usr/bin/etcdctl rm /services/apache-php/${SERVICE_UNIT_APP_GROUP}/${SERVICE_UNIT_LOCAL_ID}.${SERVICE_UNIT_INSTANCE}
 
 [Install]
 WantedBy=multi-user.target