Skip to content

Latest commit

 

History

History
299 lines (220 loc) · 10.3 KB

readme.md

File metadata and controls

299 lines (220 loc) · 10.3 KB
Raw

Forked from heroku-buildpack-nginx. All this adds is the auth-request module, a default nginx.conf.erb, and an env var for the socket to use.

This buildpack adds an nginx server in front of your heroku app with a nginx config that first redirects requests to the external authentication service of your choice.

If that check passes, your request goes through.

If that check fails, you're redirected to your external authentication source for verification.

To use it, make the following changes:

  1. Add an EXTERNAL_AUTHENTICATION_URL to your app's environment variables
heroku config:set EXTERNAL_AUTHENTICATION_URL=http://my-authentication-source.com
  1. Add the buildpack with
heroku buildpacks:add https://github.com/ShaperTools/heroku-external-authentication-buildpack
  1. Modify your Procfile to add bin/start-nginx before the command to start your application

i.e. from

web: yarn start

to

web: bin/start-nginx yarn start
  1. Modify your app to listen to the SOCKET env var (instead of the PORT env var), and touch/write to the APP_INITIALIZED_FILE env var to indicate the app is ready to receive traffic.

express example

app = express();

...

const socket = process.env.SOCKET || process.env.PORT;
app.listen(socket, () => {
  if (socket === process.env.SOCKET) {
    fs.writeFileSync(process.env.APP_INITIALIZED_FILE, "true");
  }
});

The original readme from heroku-buildpack-nginx follows:

Heroku Buildpack: NGINX

Nginx-buildpack vendors NGINX inside a dyno and connects NGINX to an app server via UNIX domain sockets.

Motivation

Some application servers (e.g. Ruby's Unicorn) halt progress when dealing with network I/O. Heroku's routing stack buffers only the headers of inbound requests. (The router will buffer the headers and body of a response up to 1MB) Thus, the Heroku router engages the dyno during the entire body transfer –from the client to dyno. For applications servers with blocking I/O, the latency per request will be degraded by the content transfer. By using NGINX in front of the application server, we can eliminate a great deal of transfer time from the application server. In addition to making request body transfers more efficient, all other I/O should be improved since the application server need only communicate with a UNIX socket on localhost. Basically, for webservers that are not designed for efficient, non-blocking I/O, we will benefit from having NGINX to handle all I/O operations.

Versions

Heroku 18

  • NGINX Version: 1.20.1

Heroku 20

  • NGINX Version: 1.20.1

Heroku 22

  • NGINX Version: 1.20.1

Requirements (Proxy Mode)

  • Your webserver listens to the socket at /tmp/nginx.socket.
  • You touch /tmp/app-initialized when you are ready for traffic.
  • You can start your web server with a shell command.

Requirements (Solo Mode)

Features

  • Unified NXNG/App Server logs.
  • L2met friendly NGINX log format.
  • Heroku request ids embedded in NGINX logs.
  • Crashes dyno if NGINX or App server crashes. Safety first.
  • Language/App Server agnostic.
  • Customizable NGINX config.
  • Application coordinated dyno starts.

Logging

NGINX will output the following style of logs:

measure.nginx.service=0.007 request_id=e2c79e86b3260b9c703756ec93f8a66d

You can correlate this id with your Heroku router logs:

at=info method=GET path=/ host=salty-earth-7125.herokuapp.com request_id=e2c79e86b3260b9c703756ec93f8a66d fwd="67.180.77.184" dyno=web.1 connect=1ms service=8ms status=200 bytes=21

Setting custom log paths

You can configure custom log paths using the environment variables NGINX_ACCESS_LOG_PATH and NGINX_ERROR_LOG_PATH.

For example, if you wanted to stop nginx from logging your access logs you could set NGINX_ACCESS_LOG_PATH to /dev/null:

$ heroku config:set NGINX_ACCESS_LOG_PATH="/dev/null"

Language/App Server Agnostic

nginx-buildpack provides a command named bin/start-nginx this command takes another command as an argument. You must pass your app server's startup command to start-nginx.

For example, to get NGINX and Unicorn up and running:

$ cat Procfile
web: bin/start-nginx bundle exec unicorn -c config/unicorn.rb

nginx debug mode

$ cat Procfile
web: bin/start-nginx-debug bundle exec unicorn -c config/unicorn.rb

nginx Solo Mode

nginx-buildpack provides a command named bin/start-nginx-solo. This is for you if you don't want to run an additional app server on the Dyno. This mode requires you to put a config/nginx.conf.erb in your app code. You can start by coping the sample config for nginx solo mode. To get NGINX Solo Mode running:

$ cat Procfile
web: bin/start-nginx-solo

Setting the Worker Processes and Connections

You can configure NGINX's worker_processes directive via the NGINX_WORKERS environment variable.

For example, to set your NGINX_WORKERS to 8 on a PX dyno:

$ heroku config:set NGINX_WORKERS=8

Similarly, the NGINX_WORKER_CONNECTIONS environment variable can configure the worker_connections directive:

$ heroku config:set NGINX_WORKER_CONNECTIONS=2048

Customizable NGINX Config

You can provide your own NGINX config by creating a file named nginx.conf.erb in the config directory of your app. Start by copying the buildpack's default config file.

Force SSL

You can add a redirect/force SSL based on Heroku headers. Full, commented example in the default config file or in the nextjs with forceSSL config file.

if ($http_x_forwarded_proto != "https") {
  return 301 https://$host$request_uri;
}

Customizable NGINX Compile Options

This requires a clone of this repository and Docker. All you need to do is have Docker setup and running on your machine. The Makefile will take care of the rest.

Configuring is as easy as changing the options passed to ./configure in scripts/build_nginx.

Run the builds in a container via:

$ make build

The binaries will be packed into tar files and placed in the repository's root directory. Commit the changes and push your repository.

Finally update your app to use your custom buildpack on Heroku either at https://dashboard.heroku.com/apps/#{YOUR_APP_NAME}/settings or via the Heroku CLI via:

heroku buildpacks:set #{YOUR_GIT_REPO_CLONE}

To test the builds locally:

$ make shell
$ cp bin/nginx-$STACK bin/nginx
$ FORCE=1 bin/start-nginx

Application/Dyno coordination

The buildpack will not start NGINX until a file has been written to /tmp/app-initialized. Since NGINX binds to the dyno's $PORT and since the $PORT determines if the app can receive traffic, you can delay NGINX accepting traffic until your application is ready to handle it. The examples below show how/when you should write the file when working with Unicorn.

Setup

Here are 2 setup examples. One example for a new app, another for an existing app. In both cases, we are working with ruby & unicorn. Keep in mind that this buildpack is not ruby specific. However if your app does happen to use Ruby, make sure to add the NGINX buildpack after the Ruby buildpack, so the NGINX buildpack doesn't have to install its own redundant copy of Ruby for the ERB templating feature.

Existing App

Update Buildpacks to use the latest stable version of this buildpack:

$ heroku buildpacks:add heroku-community/nginx

Alternatively, you can use the Github URL of this repo if you want to edge version.

Update Procfile:

web: bin/start-nginx bundle exec unicorn -c config/unicorn.rb

$ git add Procfile
$ git commit -m 'Update procfile for NGINX buildpack'

Update Unicorn Config

require 'fileutils'
listen '/tmp/nginx.socket'
before_fork do |server,worker|
	FileUtils.touch('/tmp/app-initialized')
end
$ git add config/unicorn.rb
$ git commit -m 'Update unicorn config to listen on NGINX socket.'

Deploy Changes

$ git push heroku main

New App

$ mkdir myapp; cd myapp
$ git init

Gemfile

source 'https://rubygems.org'
gem 'unicorn'

config.ru

run Proc.new {[200,{'Content-Type' => 'text/plain'}, ["hello world"]]}

config/unicorn.rb

require 'fileutils'
preload_app true
timeout 5
worker_processes 4
listen '/tmp/nginx.socket', backlog: 1024

before_fork do |server,worker|
	FileUtils.touch('/tmp/app-initialized')
end

Install Gems

$ bundle install

Create Procfile

web: bin/start-nginx bundle exec unicorn -c config/unicorn.rb

Create & Push Heroku App:

$ heroku create
$ heroku buildpacks:add heroku/ruby
$ heroku buildpacks:add heroku-community/nginx
$ git add .
$ git commit -am "init"
$ git push heroku main
$ heroku logs -t

Visit App

$ heroku open

License

Copyright (c) 2013 Ryan R. Smith Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.