webpack-mkcert-plugin

Use certificates that are trusted by your local machine, avoiding browser security warnings during development. 🤝

What does this plugin do?

This plugin simplifies the process of setting up HTTPS for your webpack development server by automatically generating and managing SSL certificates using mkcert.

Install

npm install webpack-mkcert-plugin --save-dev

Usage

Check the demo folder for a sample Webpack configuration.

// webpack.config.js
const path = require('path')
const MkcertPlugin = require('webpack-mkcert-plugin')

module.exports = {
  devServer: {
    server: {
      type: 'https'
    }
  },
  // ...other webpack config,
  plugins: [
    // See below a list of all available options.
    new MkcertPlugin()
  ]
}

Options

new MkcertPlugin({
  // The directory where the generated files will be stored.
  // Defaults to ./certs.
  outputDir: path.join(__dirname, './dist/cert-custom-path'),
  // The name of the certificate file.
  // Defaults to dev.cert.
  cert: 'my-custom-dev.cert',
  // The name of the key file.
  // Defaults to dev.key.
  key: 'my-custom-dev.key',
  // A list of custom hosts to include in the certificate.
  // Defaults to ['localhost'] plus the local IP addresses.
  hosts: ['localhost', 'my-site.local'],
  // If set to true, forces the regeneration of the certificate
  // files even if they already exist. Defaults to false.
  force: true,
  // If set to true, automatically upgrades the mkcert binary to
  // the latest version before generating certificates. Defaults to false.
  autoUpgrade: true
})

License

MIT (c) Cezar Augusto.