CHANGE to static compile

README.md

@@ -1,13 +1,20 @@
-# NGINX Buildpack
+# NGINX Buildpack for Dokku - Hosting static pages
+This buildpack has been successfully run on Digital Ocean instances of Ubuntu 14.04 (Status: Jan 2015). It might also work with different configurations.
 
-**Note**: This has only been tested with [dokku](https://github.com/progrium/dokku) - it may not work elsewhere.
+## Purpose
+`buildpack-nginx` provides a simple, low overhead way of hosting static pages and websites on Dokku. Just add the `.env` and `.static` file to the root directory of your website as described below.
 
-## Structure
-* .nginx - File: its presence signals that this buildpack should be used
-* www - Folder: holds all files to be served by nginx
-* nginx.conf.erb - Optional File: overrides `conf/nginx.conf.erb`
-* mime.types - Optional File: overrides `conf/mime.types`
-* custom-build - Optional File: executes commands before build is finished. Note that this script does not run in the application root. To execute commands in the application root you must do `cd "$1"`.
+## Usage
+1. Add a file with the name `.env` in the root of your directory with the following content: `export BUILDPACK_URL=https://github.com/florianheinemann/buildpack-nginx.git`
+2. Add another, *empty* file called `.static` to your root directory of your web project. It signals that this buildpack shall be used
+3. Push your project to Dokku
 
-## Environment Variables
-* root - Optional: overrides root directory
+All static files that you want to serve should be in the root directory of your repository. No need to use a seperate `www` folder. `buildpack-nginx` will automatically download the buildpack, download NGINX, compile it, and install it. The next time you push your project, the buildpack will reuse the precompiled binaries. 
+
+## NGINX CONFIGURATION
+Override default configuration by adding `nginx.conf.erb` in the root directory
+
+## Credits and License
+`buildpack-nginx` is licensed under the CC0 1.0 Universal license and has been informed by many similar projects on the web
+
+[Florian Heinemann](http://twitter.com/TheSumOfAll/)

bin/compile

@@ -1,19 +1,151 @@
 #!/usr/bin/env bash
+# bin/compile <build-dir> <cache-dir>
+
 set -e
+set -o pipefail
+
+# Nginx 1.8.1
+NGINX_VERSION="1.8.1"
+NGINX_TARBALL="nginx-${NGINX_VERSION}.tar.gz"
+PCRE_VERSION="8.40"
+PCRE_TARBALL="pcre-${PCRE_VERSION}.tar.gz"
+ZLIB_VERSION="1.2.11"
+ZLIB_TARBALL="zlib-${ZLIB_VERSION}.tar.gz"
+
+# parse and derive params
+BUILD_DIR=$1
+CACHE_DIR=$2
+CUR_DIR=`cd $(dirname $0); cd ..; pwd`
+
+mkdir -p $BUILD_DIR $CACHE_DIR
+
+if [[ ! -e "$BUILD_DIR/www" ]]; then
+  echo "-----> copy static files to www"
+  rm -rf $CACHE_DIR/www
+  mkdir -p $CACHE_DIR/www
+  mv $BUILD_DIR/* $CACHE_DIR/www
+  mkdir -p $BUILD_DIR/www
+  mv $CACHE_DIR/www/* $BUILD_DIR/www
+  # Check for a copy the nginx conf file override to the build dir
+  [[ -f "$BUILD_DIR/www/nginx.conf.erb" ]] && mv $BUILD_DIR/www/nginx.conf.erb $BUILD_DIR
+  [[ -f "$BUILD_DIR/www/mime.types" ]] && mv $BUILD_DIR/www/mime.types $BUILD_DIR
+  [[ -f "$BUILD_DIR/www/CHECKS" ]] && mv $BUILD_DIR/www/CHECKS $BUILD_DIR
+  rm -rf $CACHE_DIR/www
+fi
 
-apt-get update
-apt-get -y install nginx
+cd $CACHE_DIR
 
-BINDIR=$(dirname "$0")
+if [[ ! -d "${NGINX_TARBALL%.tar.gz}" ]]; then
+  echo "-----> download and unzip nginx"
+  curl "http://nginx.org/download/${NGINX_TARBALL}" -o "${NGINX_TARBALL}"
+  tar xzf "${NGINX_TARBALL}" && rm -f "${NGINX_TARBALL}"
+fi
 
-if [[ ! -f $1/nginx.conf.erb ]]; then
-    cp $BINDIR/../conf/nginx.conf.erb $1/nginx.conf.erb
+if [[ ! -d "${PCRE_TARBALL%.tar.gz}" ]]; then
+  echo "-----> download and unzip pcre"
+  curl "http://ftp.csx.cam.ac.uk/pub/software/programming/pcre/${PCRE_TARBALL}" -o "${PCRE_TARBALL}"
+  tar xzf "${PCRE_TARBALL}" && rm -f "${PCRE_TARBALL}"
 fi
 
-if [[ ! -f $1/mime.types ]]; then
-	cp $BINDIR/../conf/mime.types $1/mime.types
+if [[ ! -d "${ZLIB_TARBALL%.tar.gz}" ]]; then
+  echo "-----> download and unzip zlib"
+  curl "http://zlib.net/${ZLIB_TARBALL}" -o "${ZLIB_TARBALL}"
+  tar xzf "${ZLIB_TARBALL}" && rm -rf "${ZLIB_TARBALL}"
 fi
 
-if [[ -e $1/${CUSTOM_BUILD:-custom-build} ]]; then
-    $1/${CUSTOM_BUILD:-custom-build} "$@"
+cd "nginx-${NGINX_VERSION}"
+if [[ ! -f "${CACHE_DIR}/bin/nginx" ]]; then
+  echo "-----> compile static nginx"
+  mkdir $BUILD_DIR/nginx
+  ./configure \
+    --with-cpu-opt=generic \
+    --prefix=$BUILD_DIR/nginx \
+    --with-pcre=../pcre-${PCRE_VERSION} \
+    --sbin-path=. \
+    --pid-path=./nginx.pid \
+    --conf-path=./nginx.conf \
+    --with-ld-opt="-static" \
+    --with-http_spdy_module \
+    --with-http_stub_status_module \
+    --with-http_gzip_static_module \
+    --with-file-aio \
+    --with-zlib=../zlib-${ZLIB_VERSION} \
+    --with-pcre \
+    --with-cc-opt="-O2 -static -static-libgcc" \
+    --without-http_charset_module \
+    --without-http_ssi_module \
+    --without-http_userid_module \
+    --without-http_access_module \
+    --without-http_auth_basic_module \
+    --without-http_autoindex_module \
+    --without-http_geo_module \
+    --without-http_map_module \
+    --without-http_split_clients_module \
+    --without-http_referer_module \
+    --without-http_proxy_module \
+    --without-http_fastcgi_module \
+    --without-http_uwsgi_module \
+    --without-http_scgi_module \
+    --without-http_memcached_module \
+    --without-http_empty_gif_module \
+    --without-http_browser_module \
+    --without-http_upstream_ip_hash_module \
+    --without-http_upstream_least_conn_module \
+    --without-http_upstream_keepalive_module \
+    --without-mail_pop3_module \
+    --without-mail_imap_module \
+    --without-mail_smtp_module
+
+  sed -i "/CFLAGS/s/ \-O //g" objs/Makefile
+
+  make && make install
+
+  rm -rf $CACHE_DIR/bin && mkdir -p $CACHE_DIR/bin/
+  cp -r $BUILD_DIR/nginx/* $CACHE_DIR/bin/
+
+else
+  echo "-----> reuse nginx from cache"
+  mkdir -p $BUILD_DIR/nginx
+  cp -r $CACHE_DIR/bin/* $BUILD_DIR/nginx/
 fi
+
+# Update the PATH
+mkdir -p $BUILD_DIR/.profile.d
+cat > $BUILD_DIR/.profile.d/nginx.sh <<"EOF"
+export PATH="$PATH:$HOME/nginx"
+EOF
+
+cd $CUR_DIR
+
+
+# Test for user override on nginx config...
+if [ -f $BUILD_DIR/nginx.conf.erb ] ; then
+  echo "-----> using user provided nginx.conf.erb"
+  cp $BUILD_DIR/nginx.conf.erb $BUILD_DIR/nginx/nginx.conf.erb
+  #rm $BUILD_DIR/nginx.conf.erb
+
+# ...else, force default file
+else
+  echo "-----> using default nginx.conf.erb"
+  cp conf/nginx.conf.erb $BUILD_DIR/nginx/nginx.conf.erb
+fi
+
+# build mime.types unless overridden by user
+if [ -f $BUILD_DIR/mime.types ] ; then
+  echo "-----> using user provided mime.types"
+  cp $BUILD_DIR/mime.types $BUILD_DIR/nginx/mime.types
+
+else
+  echo "-----> using default mime.types"
+  cp conf/mime.types $BUILD_DIR/nginx/mime.types
+fi
+
+
+# build a startup script
+cat <<EOF >"$BUILD_DIR/start_nginx"
+#!/usr/bin/env bash
+rm -f /app/nginx/nginx.conf
+erb /app/nginx/nginx.conf.erb > /app/nginx/nginx.conf
+exec /app/nginx/nginx -p /app/nginx -c /app/nginx/nginx.conf
+EOF
+chmod +x "$BUILD_DIR/start_nginx"

bin/detect

@@ -1,8 +1,8 @@
 #!/usr/bin/env bash
 set -e
 
-if [[ -f $1/.nginx ]]; then
-  echo "nginx"
+if [[ -f $1/.static ]]; then
+  echo ".static"
   exit 0
 else
   exit 1

bin/release

@@ -1,8 +1,12 @@
 #!/usr/bin/env bash
-set -e 
+# bin/release <build-dir>
 
-cat << EOF
+cat <<EOF
 ---
+
+addons:
+config_vars:
+  PATH: /usr/local/bin:/usr/bin:/bin:/app/nginx
 default_process_types:
-  web: erb /app/nginx.conf.erb > /app/nginx.conf && nginx -c /app/nginx.conf
-EOF
+  web: /app/start_nginx
+EOF

conf/nginx.conf.erb

@@ -4,16 +4,20 @@ pid nginx.pid;
 daemon off;
 
 events {
-	worker_connections 768;
+  worker_connections 768;
 }
 
 http {
-	types_hash_max_size 2048;
-	include mime.types;
-	server {
-		listen <%= ENV['PORT'] %>;
-		server_name  _;
-		root <%= ENV.fetch('root', '/app/www') %>;
-		index index.html;
-	}
+  types_hash_max_size 2048;
+  include mime.types;
+  server {
+    listen <%= ENV["PORT"] %>;
+    server_name  _;
+    <% if ENV["ROOT"] %>
+      root /app/www/<%= ENV["ROOT"] %>;
+    <% else %>
+      root /app/www;
+    <% end %>
+    index index.html;
+  }
 }