Skip to content

README.md

Latest commit

 

History

History
156 lines (106 loc) · 5.87 KB

README.md

File metadata and controls

156 lines (106 loc) · 5.87 KB

server-ssl.js

Easy to configure SSL Server that can be used for development or production that can create and renew Lets Encrypt Certificates automatically.

Designed to get out of your way so you can still change anything about https.createServer.

Getting Started

The easiest usage would be to serve a website:

  1. Clone or Download the main branch and extract it somewhere
  2. Put your website in the website folder
  3. Open the server-ssl folder in Command Prompt or Git Bash
  4. Run start-windows.bat
  5. View your website at https://localhost

The default page/config is a simple API that serves and displays the time

Advanced/Production Usage

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"

Optional Arguments

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"
--skipNodeUpdate Do not update NPM packages before starting the server not present

All Arguments are case sensitive.

Use Lets Encrypt!

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']

Always Redirect HTTP to HTTPS

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

Default Layout

This layout keeps the project organized and maintainable, separating error handling, website content, and server configuration.

/root
│
├── /error
│   ├── 404.html
│   └── 500.html
│
├── /ssl
│   ├── /openssl
│   │
│   ├── private-key.pem
│   └── certificate.pem
│   └── state.js
│
├── /wwwroot
│   └── index.html <---- Your website goes here
│
├── server-ssl.js            <--- server config
└── start-windows.bat

404/500 Pages

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

Bring Your Own SSL Certificate

Convert your certificate and private key to PEM format and place them in the ssl folder

├── /ssl
│   │
│   ├── private-key.pem <--- Your private key goes here
│   └── certificate.pem <--- Your certificate goes here
│   └── state.js