Configurable SSL Server that runs on Node.js which can be used for development or production and can create and renew Lets Encrypt Certificates automatically using ACME
Designed to get out of your way so you can still change anything about https.createServer.
The easiest usage would be to serve a website:
CloneorDownloadthe main branch and extract it somewhere- Put your website in the
websitefolder - Open the
server-sslfolder inCommand PromptorGit Bash - Run
node server-ssl.js - View your website at
https://localhost
The default page/config is a simple API that serves and displays the time
node server-ssl.js takes your arguments and starts the server
# Start for production (Lets Encrypt!) with SAN Extension
node server-ssl.js --letsEncrypt --domains=['www.ssl.boats','ssl.boats']
server-ssl.js has some optional arguments you can use in production if the defaults aren't enough.
| Arguments/Flags | Description | Default Value |
|---|---|---|
--port= |
The port number for HTTPS |
443 |
--portHttp= |
The port number for HTTP that will be redirected | 80 |
--cert= |
The path to the SSL certificate file. |
"certificate.pem" |
--pk= |
The path to the private key file for the SSL certificate. |
"private-key.pem" |
--site= |
The directory for the website files | "wwwroot" |
--error= |
The directory for error messages (404,500) | "error" |
--entry= |
The page to use for the entry point | "index.html" |
All Arguments are case sensitive.
You can use Lets Encrypt to generate certificates.
Certificates are valid for 90 days but are renewed automatically sooner.
The certificates will be changed automatically when they are updated, you don't need to do anything.
| Automated Lets Encrypt! | Description |
|---|---|
--letsEncrypt |
Lets Encrypt! should be used to generate 90 day certificates automatically |
--domains= |
Domains to generate certificates for, this can not include wild cards, this should be an array. eg. --domains=['www.ssl.boats','ssl.boats'] |
--generateAnyway |
Certificates should always be generated when the server starts, this could get you rate limited, maybe use --staging |
--staging |
The Lets Encrypt! staging server should be used instead of production |
node server-ssl.js --letsEncrypt --domains=['www.ssl.boats','ssl.boats']
HTTP requests from end users are always redirected to HTTPS
ACME Challenges transparently happen over HTTP to create/issue a new certificate
Anything Node.js can do..
At the end of the day, this is just a Node.js server that sets up SSL automatically
const HTTPS_SERVER = createServerHTTPS(STATE.loadDefaultSecureContext(), (req, res) => {
// do whatever you like
})...
You can remove everything inside HTTPS_SERVER and do whatever you like.
There are also helpers you can use in STATE
This layout keeps the project organized and maintainable, separating error handling, website content, and server configuration.
/root
│
├── /error
│ ├── 404.html
│ └── 500.html
│
├── /ssl
│ ├── /production
│ │ │
│ │ ├── ...
│ │ ├── private-key.pem
│ │ └── certificate.pem
│ │
│ ├── /staging
│ │ │
│ │ ├── ...
│ │ ├── private-key.pem
│ │ └── certificate.pem
│ │
│ └── state.js
│
├── /wwwroot
│ └── index.html <---- Your website goes here
│
└── server-ssl.js
The server is configured to serve custom 404 and 500 error pages, instead of plain-text.
Currently everything is treated like a Server Error except for Not Found
These pages will automatically select light/dark mode
Convert your certificate and private key to PEM format and place them in the ssl folder
├── /ssl
│ ├── /production <> staging
│ │ │
│ │ ├── ...
│ │ ├── private-key.pem <--- Your private key goes here
│ │ └── certificate.pem <--- Your certificate goes here