LocalSSL 🔒

LocalSSL is a zero-config, native Node.js command-line tool that enables you to use HTTPS in your local development environment (localhost) without any installation.

Features

• 🚀 Fast: Generates certificates with a single command.
• 📦 No Installation: No need to download external binaries (like mkcert).
• 🛡️ Secure: Creates your own Certificate Authority (CA) and trusts it on your system.
• ⚙️ Flexible: Use it via command-line arguments or interactive mode.
• 🌐 IPv6 Support: Full support for IPv6 addresses (e.g., ::1).
• 🧹 Cleanable: You can remove the CA certificate from the system with a single command.

⚡ Quick Start

# One-time setup (creates and trusts CA)
npx local-ssl-setup

# Generate certificates for your project
npx local-ssl-setup -d localhost,app.test -o ./certs

🖥️ Platform Support

• ✅ Windows 10/11
• ✅ macOS 10.15+
• ✅ Linux (Ubuntu, CentOS, etc.)

Installation

Install globally to access it from anywhere:

npm install -g local-ssl-setup

Or run it instantly with npx without installing:

npx local-ssl-setup

Usage

1. Interactive Mode (Recommended)

If you run it without parameters, it will ask you step-by-step questions:

local-ssl-setup

2. Quick Mode

You can specify domains and output directory directly:

local-ssl-setup -d localhost,test.local --output ./certs

3. Uninstall

To remove the CA certificate from system trusted roots:

local-ssl-setup --uninstall

🛠️ Integration Examples

Vite

vite --https --key ./certs/localhost.key --cert ./certs/localhost.crt

Webpack Dev Server

// webpack.config.js
const fs = require("fs");

module.exports = {
  devServer: {
    https: {
      key: fs.readFileSync("./certs/localhost.key"),
      cert: fs.readFileSync("./certs/localhost.crt"),
    },
  },
};

Express.js

const https = require("https");
const fs = require("fs");

const options = {
  key: fs.readFileSync("./certs/localhost.key"),
  cert: fs.readFileSync("./certs/localhost.crt"),
};

https.createServer(options, app).listen(443);

Options

| Option | Alias | Description | | -------------- | ----- | ------------------------------------------------------------- | | --domains | -d | Comma separated list of domains (e.g., localhost,api.local) | | --output | -o | Directory to save certificates | | --validity | | Certificate validity in days. Default: 365 | | --install-ca | | Attempts to add the CA certificate to system trusted roots | | --uninstall | | Removes the CA certificate from the system | | --help | -h | Shows help message |

Configuration File (Optional)

You can persist your settings by creating a localssl.config.js file in your project root:

// localssl.config.js
module.exports = {
  domains: ["localhost", "my-app.local"],
  output: "./ssl",
};

❓ Troubleshooting

Certificate not trusted?

• Run with admin/sudo privileges: sudo local-ssl-setup
• Restart your browser after installation

Command not found?

• Use npx: npx local-ssl-setup
• Or install globally: npm install -g local-ssl-setup

Support

If you enjoy this theme and want to support its development, you can buy me a coffee! ☕

Your support helps me create more awesome themes and tools! 🙏