SGAppsProxy

Properties

( ex: 'https:' )

( ex: true )

( ex: null or 'username:password' )

( ex: 'sgapps.io:808' )

( ex: '808' )

( ex: 'sgapps.io' )

( ex: '#23' )

( ex: '?query=234' )

( ex: 'query=234' )

( ex: '/path' )

( ex: '/path?query=234' )

( ex: 'https://sgapps.io:808/path?query=234#23' )

url string to be parsed with the url module

url string to be parsed with the url module

object to be passed to http(s).request (see Node's https agent and http agent objects)

object to be passed to https.createServer()

true/false, if you want to proxy websockets

true/false, adds x-forward headers

true/false, if you want to verify the SSL Certs

true/false, passes the absolute URL as the path (useful for proxying to proxies)

true/false, Default: true - specify whether you want to prepend the target's path to the proxy path

true/false, Default: false - specify whether you want to ignore the proxy path of the incoming request (note: you will have to append / manually if required).

Local interface string to bind for outgoing connections

true/false, Default: false - changes the origin of the host header to the target URL

true/false, Default: false - specify whether you want to keep letter case of response header key

Basic authentication i.e. 'user:password' to compute an Authorization header.

rewrites the location hostname on (201/301/302/307/308) redirects.

rewrites the location host/port on (201/301/302/307/308) redirects based on requested host/port. Default: false.

rewrites the location protocol on (201/301/302/307/308) redirects to 'http' or 'https'. Default: null.

rewrites domain of set-cookie headers. Possible values: false (default): disable cookie rewriting String: new domain, for example cookieDomainRewrite: "new.domain". To remove the domain, use cookieDomainRewrite: "". Object: mapping of domains to new domains, use "*" to match all domains. For example keep one domain unchanged, rewrite one domain and remove other domains:

    cookieDomainRewrite: {
      "unchanged.domain": "unchanged.domain",
      "old.domain": "new.domain",
      "*": ""
    }

rewrites path of set-cookie headers. Possible values: false (default): disable cookie rewriting String: new path, for example cookiePathRewrite: "/newPath/". To remove the path, use cookiePathRewrite: "". To set path to root use cookiePathRewrite: "/". Object: mapping of paths to new paths, use "*" to match all paths. For example, to keep one path unchanged, rewrite one path and remove other paths:

    cookiePathRewrite: {
      "/unchanged.path/": "/unchanged.path/",
      "/old.path/": "/new.path/",
      "*": ""
    }

object with extra headers to be added to target requests.

timeout (in milliseconds) for outgoing proxy requests

timeout (in milliseconds) for incoming requests

true/false, Default: false - specify whether you want to follow redirects

true/false, if set to true, none of the webOutgoing passes are called and it's your responsibility to appropriately return the response by listening and acting on the proxyRes event

stream of data to send as the request body. Maybe you have some middleware that consumes the request stream before proxying it on e.g. If you read the body of a request into a field called 'req.rawbody' you could restream this field in the buffer option:

'use strict';

const streamify = require('stream-array');
const HttpProxy = require('http-proxy');
const proxy = new HttpProxy();

module.exports = (req, res, next) => {

  proxy.web(req, res, {
    target: 'http://localhost:4003/',
    buffer: streamify(req.rawBody)
  }, next);

};

Properties

( ex: '127.0.0.1' )

( ex: 80 )

array or domain mappers ( ex: "*.sgapps.io" )

( ex: '/some/path/' )

( ex: null or 'username:password' )