feat: add ssl module

feat: allow overriding default 404 response with custom file

README.md

@@ -1,17 +1,16 @@
-# Dokku Buildpack: nginx
+# heroku-buildpack-nginx
 
 This is the official dokku buildpack for static websites, powered by nginx.
 
 ## Usage
 
-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.
+All static files that you want to serve should be in the root directory of your repository. No need to use a separate `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.
 
 ### Dokku
 
-To trigger detection of this buildpack in Dokku, you have two options:
+To trigger detection of this buildpack you need to add a dotfile:
 
-- Automatic: Add an *empty* file called `.static` to your root directory of your web project.
-- Manual: Set your `BUILDPACK_URL` via `dokku config:set BUILDPACK_URL=https://github.com/dokku/buildpack-nginx.git`
+Add an *empty* file called `.static` to your root directory of your web project (regardless if you use a custom value for NGINX_ROOT)
 
 ### Heroku
 
@@ -23,8 +22,28 @@ heroku buildpacks:set https://github.com/dokku/buildpack-nginx.git
 
 ## Configuration
 
+### Custom nginx root
+
 You can override the nginx root via setting the `NGINX_ROOT` environment variable. This should be a relative path in your repository.
 
+```shell
+# where the app is named `static-app`
+# and the root dir is _site
+dokku config:set static-app NGINX_ROOT=_site
+````
+
+### Default to index for history routing
+
+By default, this buildpack will 404 if a requested file is not found. For static sites that use the browser's history router to show the correct context, setting the `NGINX_DEFAULT_REQUEST` to a specific file will override this.
+
+```shell
+# where the app is named `static-app`
+# and the desired default response is index.html
+dokku config:set static-app NGINX_ROOT=index.html
+```
+
+### Custom nginx config file
+
 You may completely override the built-in nginx config by placing an `app-nginx.conf.sigil` file in the root, modeled after our own [`conf/app-nginx.conf.sigil`](https://github.com/dokku/buildpack-nginx/blob/master/conf/app-nginx.conf.sigil). This will be used inside of the container, and not by the host Dokku instance. See the [sigil project](https://github.com/gliderlabs/sigil) for more information concerning the sigil format.
 
 ## Credits and License

bin/compile

@@ -2,13 +2,13 @@
 # bin/compile <build-dir> <cache-dir>
 set -eo pipefail; [[ $TRACE ]] && set -x
 
-NGINX_VERSION="1.10.1"
+NGINX_VERSION="1.17.0"
 NGINX_TARBALL="nginx-${NGINX_VERSION}.tar.gz"
-PCRE_VERSION="8.39"
+PCRE_VERSION="8.45"
 PCRE_TARBALL="pcre-${PCRE_VERSION}.tar.gz"
 SIGIL_VERSION="0.4.0"
 SIGIL_TARBALL="sigil_${SIGIL_VERSION}_Linux_x86_64.tgz"
-ZLIB_VERSION="1.2.8"
+ZLIB_VERSION="1.2.11"
 ZLIB_TARBALL="zlib-${ZLIB_VERSION}.tar.gz"
 
 suppress() {
@@ -47,25 +47,25 @@ fi
 cd "$CACHE_DIR"
 
 if [[ ! -d "${NGINX_TARBALL%.tar.gz}" ]]; then
-  echo "-----> Download and unzip nginx"
+  echo "-----> Download and unzip nginx ${NGINX_VERSION} via http"
   curl -sSL "http://nginx.org/download/${NGINX_TARBALL}" -o "${NGINX_TARBALL}"
   tar xzf "${NGINX_TARBALL}" && rm -f "${NGINX_TARBALL}"
 fi
 
 if [[ ! -d "${PCRE_TARBALL%.tar.gz}" ]]; then
-  echo "-----> Download and unzip pcre"
-  curl -sSL "http://ftp.csx.cam.ac.uk/pub/software/programming/pcre/${PCRE_TARBALL}" -o "${PCRE_TARBALL}"
+  echo "-----> Download and unzip pcre ${PCRE_VERSION} via http"
+  curl -sSL "https://downloads.sourceforge.net/project/pcre/pcre/${PCRE_VERSION}/${PCRE_TARBALL}" -o "${PCRE_TARBALL}"
   tar xzf "${PCRE_TARBALL}" && rm -f "${PCRE_TARBALL}"
 fi
 
 if [[ ! -d "${ZLIB_TARBALL%.tar.gz}" ]]; then
-  echo "-----> Download and unzip zlib"
-  curl -sSL "http://zlib.net/${ZLIB_TARBALL}" -o "${ZLIB_TARBALL}"
+  echo "-----> Download and unzip zlib ${ZLIB_VERSION} via http"
+  curl -sSL "https://github.com/madler/zlib/archive/v${ZLIB_VERSION}.tar.gz" -o "${ZLIB_TARBALL}"
   tar xzf "${ZLIB_TARBALL}" && rm -rf "${ZLIB_TARBALL}"
 fi
 
 if [[ ! -f "sigil" ]]; then
-  echo "-----> Download and unzip sigil"
+  echo "-----> Download and unzip sigil ${SIGIL_VERSION} via http"
   curl -sSL "https://github.com/gliderlabs/sigil/releases/download/v${SIGIL_VERSION}/${SIGIL_TARBALL}" -o "${SIGIL_TARBALL}"
   tar xzf "${SIGIL_TARBALL}" && rm -rf "${SIGIL_TARBALL}"
 fi
@@ -87,21 +87,19 @@ if [[ ! -f "${CACHE_DIR}/bin/nginx" ]]; then
     --with-ld-opt="-static" \
     --with-http_stub_status_module \
     --with-http_gzip_static_module \
+    --with-http_ssl_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 \
@@ -113,7 +111,8 @@ if [[ ! -f "${CACHE_DIR}/bin/nginx" ]]; then
     --without-http_upstream_keepalive_module \
     --without-mail_pop3_module \
     --without-mail_imap_module \
-    --without-mail_smtp_module
+    --without-mail_smtp_module \
+    --with-http_realip_module
 
   sed -i "/CFLAGS/s/ \-O //g" objs/Makefile
 
@@ -145,7 +144,7 @@ if [ -f "$BUILD_DIR/app-nginx.conf.sigil" ] ; then
 
 # Allow deprecated nginx.conf.erb
 elif [ -f "$BUILD_DIR/nginx.conf.erb" ] ; then
-  echo "-----> DEPRECATED: using user provided nginx.conf.erb"
+  echo "-----> DEPRECATED: Using user provided nginx.conf.erb"
   cp "$BUILD_DIR/nginx.conf.erb" "$BUILD_DIR/nginx/nginx.conf.erb"
 
 # ...else, force default file
@@ -169,7 +168,7 @@ cat <<EOF >"$BUILD_DIR/start_nginx"
 #!/usr/bin/env bash
 rm -f /app/nginx/nginx.conf
 if [[ -f /app/nginx/app-nginx.conf.sigil ]]; then
-  /app/sigil/sigil -f /app/nginx/app-nginx.conf.sigil NGINX_ROOT="\$NGINX_ROOT" PORT="\$PORT" | cat -s > /app/nginx/nginx.conf
+  /app/sigil/sigil -f /app/nginx/app-nginx.conf.sigil NGINX_ROOT="\$NGINX_ROOT" NGINX_DEFAULT_REQUEST="\$NGINX_DEFAULT_REQUEST" PORT="\$PORT" | cat -s > /app/nginx/nginx.conf
 else
   erb /app/nginx/nginx.conf.erb > /app/nginx/nginx.conf
 fi

conf/app-nginx.conf.sigil

@@ -10,6 +10,7 @@ events {
 http {
   types_hash_max_size 2048;
   include mime.types;
+  charset UTF-8;
   server {
     listen {{ $.PORT }};
     server_name  _;
@@ -19,9 +20,14 @@ http {
       root /app/www;
     {{ end }}
     index index.html;
+    port_in_redirect off;
 
     location / {
-      try_files $uri $uri/ /index.html;
+      {{ if ne $.NGINX_DEFAULT_REQUEST "" }}
+        try_files $uri $uri/ /{{ $.NGINX_DEFAULT_REQUEST }};
+      {{ else }}
+        try_files $uri $uri/ =404;
+      {{ end }}
     }
   }
 }

conf/mime.types

@@ -14,6 +14,7 @@ types {
     text/vnd.sun.j2me.app-descriptor      jad;
     text/vnd.wap.wml                      wml;
     text/x-component                      htc;
+    text/vtt                              vtt;
 
     image/png                             png;
     image/tiff                            tif tiff;