1.0.0 • Published 7 years ago

hapi-redirect-to-https v1.0.0

Weekly downloads
1
License
MIT
Repository
github
Last release
7 years ago

hapi-redirect-to-https

Build Status bitHound Overall Score bitHound Dependencies bitHound Code

hapi plugin that adds http to https redirection (NOTE: This plugin extends the functionality of hapi-require-https)

By default, any incoming request with 'http' in X-Forwarded-Proto will be redirected (301) to the same host and path with 'https' as the protocol. You can optionally disable proxy mode and redirect based on the actual request protocol. This plugin pays attention to the port that is being used for https (in case your using a port other than 443).

Usage

Just load the plugin and go!

server.register({
  register: require('hapi-redirect-to-https'),
  options: {
  }
})

or if your running without a proxy (local development):

server.register({
  register: require('hapi-redirect-to-https'),
  options: {
    proxy: false,
  }
})

API

plugin.register(server, [options], next)

Registers the plugin to run onRequest in the request lifecycle.

options

Type: object
Default: {}

proxy

Type: boolean
Default: true

Indicates whether the server expects requests coming from a reverse proxy (a common Node web server setup) or directly from the Internet. Set this to false if you'd like to redirect based on the actual protocol instead of the X-Forwarded-Proto header.

License

MIT © visualjeff