Run an express server on localhost with HTTP2 and SSL. Serve static files or import as module in your project.
https-localhost is a lightweight tool for serving static content on SSL thanks to locally-trusted development certificates.
It works with MacOS, Linux and Windows, on Chrome and Firefox, and requires you no configuration.
npm i -g https-localhost
serve ~/myproj
sudomay be necessary.- If a static path is not provided the current directory content will be served.
- You can change the port setting the PORT environmental variable:
PORT=4433 serve ~/myproj.
Install as a dependency:
npm i -s https-localhost
Then put in your index.js file:
const httpsLocalhost = require("https-localhost")
const app = httpLocalhost()
// app is an express app, do what you usually do with express
app.listen(port)
- If the port number is not provided, it will listen on 443.
- To redirect the http traffic to https use
app.redirect(). - You can serve static files with
app.serve(path).
This tool has a production version that activates HTTP/2, compression and minify.
NODE_ENV=production serve ~/myproj
I decide to not activate it by default since it is usually an unwanted behaviour for localhost testing, but sometimes it could be userful, e.g. to test Progressive Web Application or more ingeneral the website performances.
IMPORTANT: the fact that there is a production enviornment doesn't mean that this tool is suitable for production. It's intended to be used only for local testing.
Serving static content on localhost in a trusted SSL connection is not so simple.
It requires to manually generate and trust certificates, with complicate commands and many manual steps.
sserve, serves static content using a locally-trusted certificate, generated with the well-knowed mkcert tool.
When you install sserve it automatically creates and installs a local CA in the system (and browsers) root store, and generates the certificate for you.
No configuration is required, just lunch the tool and we take care of everything you need.
The supported root stores are the one supported by mkcert.
Checkout the updated list here.
Here there is a handy copy:
- macOS system store
- Windows system store
- Linux variants that provide either
update-ca-trust(Fedora, RHEL, CentOS) orupdate-ca-certificates(Ubuntu, Debian) ortrust(Arch)
- Firefox (macOS and Linux only)
- Chrome and Chromium
- Java (when
JAVA_HOMEis set)
https-localhost requires Node.js 7.6 or higher.
If you need compatibility with previously Node.js versions let me know, I'll try to rearrange the code.
RangeError: Invalid typed array length: -4095
It is a known bug of spdy that is present sometimes with some old Node.js versions.
It should be present only with NODE_ENV=production, hence the easiest fix is to avoid using the production env. Anyway, if you need the production env, you can try to update Node.js to the latest release, or to the most stable LTS version.
I've tried to reproduce this error without any success (checkout the Travis build logs). If you can help please open an issue and describe as better as you can how to reproduce it, I'll be happy to help you.
Is released under AGPL-3.0 - GNU Affero General Public License v3.0.
- modification and redistribution allowed for both private and commercial use
- you must grant patent rigth to the owner and to all the contributors
- you must keep it open source and distribute under the same license
- changes must be documented
- include a limitation of liability and it does not provide any warranty
THIS TOOL IS PROVIDED "AS IS" WITHOUT WARRANTY OF ANY KIND. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU. For the full warranty check the LICENSE.
