Easy to configure SSL Server
that can be used for development or production
HTTP
requests are redirected to HTTPS
Production servers can use and renew Lets Encrypt 90 Day Certificates
automatically.
Designed to get out of your way, you can still change anything about the server.
The easiest usage would be to serve a website:
Clone
orDownload
the main branch and extract it somewhere- Put your website in the
website
folder - Open the
server-ssl
folder inCommand Prompt
orGit Bash
- Run
start-windows.bat
- View your website at
https://localhost
start-windows.bat
takes your arguments and starts the server
# Start for production (Lets Encrypt!) with SAN Extension
./start-windows.bat --letsEncrypt --domains=['www.ssl.boats','ssl.boats']
# Start for production (BYO)
./start-windows.bat --cert="your-certificate.pem" --pk="your-private-key.pem"
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 | "website" |
--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 |
--autoRestart |
Restart the server after cert generation, firing a callback to notify of the restart (not required) |
start-windows.bat
is required to use --autoRestart
./start-windows.bat --letsEncrypt --domains=['www.ssl.boats','ssl.boats']
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(S_SSL.loadDefaultSecureContext(), (req, res) => {
// do whatever you like
}).on('error', (e) => e.code === S_SSL.ADDR_IN_USE && console.error(`${S_SSL.optPort}${S_SSL.IN_USE}`)).listen(S_SSL.optPort, (err) => err ? console.error(S_SSL.ERROR_STARTING, err) : console.log(`${S_SSL.STARTED_HTTPS}${S_SSL.optPort}`));
You can remove everything inside HTTPS_SERVER
and do whatever you like.
There are also helpers you can use in S_SSL
This structure is designed to keep the project organized and maintainable, separating error handling, website content, and server configuration.
/root
│
├── /error
│ ├── 404.html
│ └── 500.html
│
├── /ssl
│ ├── /openssl
│ ├── /module
│ │ ├── /crypt
│ │ ├── /jose
│ │ └── lets-encrypt-acme-client.js
│ │
│ ├── acmeKeys
│ ├── private-key.pem
│ └── certificate.pem
│ └── ssl.js
│
├── /website
│ └── index.html <---- Your website goes here
│
├── node.exe
├── server-ssl.js <--- server config
└── start-windows.bat
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
./start-windows.bat --cert="your-certificate.pem" --pk="your-private-key.pem"
node server-ssl.js --cert="your-certificate.pem" --pk="your-private-key.pem"
Important
Your Certificate
and Private Key
should be relative to the SSL
folder if you bring your own
start-windows.bat
will automatically create a Certificate
and Private Key
when you run it if you don't provide any and none exist
When you run start-windows.bat
the first time the latest version of node.exe
portable will be downloaded