https-server-proxy

https-server-proxy

This is reverse-proxy meant to run at 'the front' of live web server. It:

• encrypts/decrypts https using TLS-certs (by default from LetsEncrypt)
• uses version 2 of the http-protocol
• proxies applications using http version 1.0/1.1 (such as Express applications) so that they are served using http version 2.
• lets you run one application per domain/sub-domain by pointing out the internal ports each domain should be proxied to
• allows redirects from one domain (or subdomain) to another. (For example if you want to redirect traffic from www.domain.com to domain.com - or vice versa.)
• enables you to use several certificates if necessary,
• supports web sockets.
• compresses content using the Brotli compression algorithm and caches compressed results to avoid having to run compression again (which would be slow) on identical requests/responses. Tip: Don't compress in your application - leave it to the proxy...

Install

npm install https-reverse-proxy

Basic usage

Call proxy with the name of your certificate as the first argument and a mapping object between domains/subdomain-names and internal ports as your second argument. You can also choose to redirect one domain to another (see below).

const proxy = require('https-reverse-proxy');

proxy('some.domain.org' /*cert name*/, {
  'some.domain.org': 3002,
  'domain.com': 3003,
  'www.domain.com': { redirect: "domain.com" }
});

(If you need to use several certificates then add another cert-name as argument 3, the mapping for domains in this certificate as argument 4 etc.)

Settings

There are some settings you change by calling proxy.settings(), see the default values below) - change one or many as you want (all are listed below):

const proxy = require('https-reverse-proxy');

proxy.settings({
  httpPort: 80,
  httpsPort: 443,
  pathToCerts: '/etc/letsencrypt/live',
  xPoweredBy: 'Love',
  brotliCompress: ct => /* compresss if true, ct = content-type */
    ct.includes('text') ||
    ct.includes('javascript') ||
    ct.includes('json') ||
    ct.includes('svg'),
  brotliQuality: 11, /* 1-11 */
  brotliCacheMaxSizeMb: 50,
  http2MaxChunk: 8192,
  http2MaxStreams: 80
});

proxy(/* see previous example */);

Note: The cert name is the name of a subfolder in the folder pathToCerts (default: /etc/letsencrypt/live). Each cert folder must contain the two files privkey.pem and fullchain.pem. This is the standard for LetsEncrypt certificates obtained using certbot. (If you have obtained a certificate with different file names for the pem-files, then rename them.)