/dokku-nginx-alt

Alternative nginx plugin for dokku

Primary LanguageShell

dokku-nginx-alt

dokku-nginx-alt is a alternative plugin for dokku that configures nginx as a reverse proxy to deployed dokku app. There are a number of design changes between this plugin and the standard built in dokku-vhosts plugin:

  • Moved configuration file from post-deploy into separate template files: nginx.conf and nginx.ssl.conf.
  • Ability to override default .conf files with user's own nginx configuration files placed in /home/git/$APP.
  • Ability to deploy an app under multiple custom domains. The VHOST file can now contain a list of domains that nginx will serve to.
  • VHOST file is decoupled from post-deploy in that post-deploy no longer overwrites VHOST after each deploy. Custom domains are set independently in the VHOST file.
  • Ability to mix SSL and non-SSL domains. For example, VHOST may contain mydomain.com and *.mydomain.com where SSL certificates only apply to *.mydomain.com. This plugin generates both SSL configurations for the wildcard domains and non-SSL configuration for the root domain.
  • Added helper messages during deploy.

Installation and Usage

This plugin has been tested on dokku version 0.2.3.

  1. Remove the default nginx-vhost plugin:

    rm -rf /var/lib/dokku/plugins/nginx-vhost
  2. Install the plugin by cloning into the dokku plugins directory:

    git clone https://github.com/mikexstudios/dokku-nginx-alt.git /var/lib/dokku/plugins/nginx-alt
  3. Create a VHOST file in your dokku app directory (e.g. /home/dokku/[app name]/VHOST) and add each domain name on a separate line.

  4. To over-ride the default nginx.conf and nginx.ssl.conf templates, place copies renamed as nginx.template and nginx.ssl.template in your /home/dokku/$APP directory. When you re-push your application, you should see a message like:

    -----> Overriding default SSL nginx.conf with detected nginx.template...
  5. Re-push your app.

Known Issues

  • backup-export and backup-import hook scripts have intentionally not been included to reduce the complexity of this plugin.

License

The MIT License (MIT)