This buildpack aims at installing a nginx instance and let you configure it at your convenance.

By default we're installing the latest available version of Nginx, but if you want to use a specific version, you can define the environment variable NGINX_VERSION

$ scalingo env-set NGINX_VERSION=1.8.0

The buildpack is expecting a configuration file at the root of the project which can be:

• nginx.conf: Simple configuration file
• nginx.conf.erb: Template to generate the configuration file
• servers.conf.erb: (optional) Let you configure your nginx instance at the http level if required

If the template is found, it will be rendered as configuration file, it let you use environment variables as in the following examples.

The following directives should not be used in you configuration file: listen, access_log, error_log and server_name.

location /api/v1 {
  proxy_pass https://api-v1-app.scalingo.io;
}

location /api/v2 {
  proxy_pass https://api-v2-app.scalingo.io;
}

Using a template to give the names of the app from the environment: nginx.conf.erb

location /api/v1 {
  proxy_pass <%= ENV["API_V1_BACKEND"] %>;
}

location /api/v2 {
  proxy_pass <%= ENV["API_V2_BACKEND"] %>;
}

Use nginx configuration: https://nginx.org/en/docs/ to get details about how to configure your app.

When using this configuration method, the previous one won't be considered, they are exclusive.

# instruction at the http level like
limit_req_zone $binary_remote_addr zone=one:10m rate=1r/s;

server {
    server_name localhost;
    listen <%= ENV['PORT'] %>;

    charset utf-8;
    location {
        limit_req zone=one burst=5;
        proxy_pass http://<%= ENV["API_V1_BACKEND"] %>;
    }
}

server {
    server_name front.example.com;
    listen <%= ENV['PORT'] %>;

    charset utf-8;
    location {
        proxy_pass http://<%= ENV["FRONT_BACKEND"] %>;
    }
}

server {
    server_name api.example.com;
    listen <%= ENV['PORT'] %>;

    charset utf-8;
    location {
        proxy_pass http://<%= ENV["API_BACKEND"] %>;
    }
}

If you want to set a basic auth, provide a environment variable with the hash called BASIC_AUTH and it will deploy it in a file conf/.htpasswd

To genere the hash, use htpasswd:

htpasswd -nbB user_name password

Example to use it in your nginx config template:

<% if ENV['BASIC_AUTH'] %>
  auth_basic           "Restricted Area";
  auth_basic_user_file conf/.htpasswd;
<% end %>

The configuration file you have to provide is at the server level, if you need to add something at the http level, please open an issue or a pull request and we'll discuss it.