# webpack-mkcert

> Provide certificates for webpack https dev service

Latest version **1.0.3** (published 2022-09-18) · MIT license · 0 weekly downloads

## Install

```sh
npm install webpack-mkcert
pnpm add webpack-mkcert
yarn add webpack-mkcert
bun add webpack-mkcert
```

## Health

**Score 30/100 (F)** — status: abandoned.

Positive: has types; esm support; no vulnerabilities; high quality score.

Warnings: low downloads.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.3 |
| Published | 2022-09-18 |
| First published | 2022-09-18 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | ESM + CommonJS |
| Node | >=v16.0.0 |
| Dependencies | 5 |
| Unpacked size | 127.7 KB |
| Known vulnerabilities | 0 (+36 in 2 direct dependencies) |
| Install scripts | no |
| GitHub stars | 3 |
| Author | Wxperia |
| Maintainers | wxperia |
| Keywords | webpack-plugin, certificate, https, mkcert |

## Links

- npm: https://www.npmjs.com/package/webpack-mkcert
- Repository: https://github.com/WXperia/webpack-mkcert
- Homepage: https://github.com/WXperia/webpack-mkcert#readme
- Issues: https://github.com/WXperia/webpack-mkcert/issues
- npm.io page: https://npm.io/package/webpack-mkcert

## Dependencies (5)

- [vite](https://npm.io/package/vite.md) ^3.1.0
- [axios](https://npm.io/package/axios.md) ^0.21.4
- [debug](https://npm.io/package/debug.md) ^4.3.4
- [picocolors](https://npm.io/package/picocolors.md) ^1.0.0
- [@octokit/rest](https://npm.io/package/@octokit/rest.md) ^19.0.4

## Alternatives

- [raw-loader](https://npm.io/package/raw-loader.md) — 4.3M weekly downloads
- [plop](https://npm.io/package/plop.md) — 1.4M weekly downloads
- [webpack-deadcode-plugin](https://npm.io/package/webpack-deadcode-plugin.md) — 80.3K weekly downloads
- [@storybook/preact-vite](https://npm.io/package/@storybook/preact-vite.md) — 54.2K weekly downloads
- [vite-plugin-transform](https://npm.io/package/vite-plugin-transform.md) — 2.4K weekly downloads

## Recent versions

- 1.0.3 (latest) — 2022-09-18
- 1.0.2 — 2022-09-18
- 1.0.1 — 2022-09-18
- 1.0.0 — 2022-09-18

## README

# webpack-mkcert-getter

使用 mkcert 为 webpack https 开发服务提供证书支持。

## 效果

<details>
  <summary>查看</summary>
  
  ![localhost](docs/assets/screenshot/localhost.png)

![127.0.0.1](docs/assets/screenshot/127.0.0.1.png)

![localhost](docs/assets/screenshot/localip.png)

</details>

## 快速开始

1. 安装依赖

```sh
yarn add webpack-mkcert
```

2. 配置 webpack

```ts
const { defineConfig } = require('@vue/cli-service')

const webpackPlugin = require('webpack-mkcert')

module.exports = defineConfig(async () => {
  const https = await webpackPlugin.default({
    source: 'coding',
    hosts: ['localhost', '127.0.0.1']
  })

  return {
    transpileDependencies: true,
    devServer: {
      server: {
        type: 'https',
        options: {
          host: 'localhost',
          ...https,
        },
      }
    },
  }
})

```

## 参数

### force

是否强制重新生成证书。

### autoUpgrade

是否自动升级 `mkcert`。

### source

指定 `mkcert` 的下载源，国内用户可以设置成 `coding` 从 coding.net 镜像下载，也可以提供一个自定义的 [BaseSource](plugin/mkcert/Source.ts)。

### mkcertPath

如果网络受限的话，可以指定一个本地的 `mkcert` 文件来代替网络下载。

### hosts

自定义域名，默认使用 `localhost` + 本地 ip 列表。

## 移动端设备使用

为了使证书在移动设备上被信任，你必须安装根证书 `rootCA.pem` 文件。可以使用 `mkcert -CAROOT` 命令打印它所在的文件夹。

在 iOS 上，你可以使用 AirDrop 隔空投送，或者用 CA 用电子邮件发给自己，或者从 HTTP 服务器上提供。打开后，你需要[在设置>已下载描述文件中安装配置文件](https://github.com/FiloSottile/mkcert/issues/233#issuecomment-690110809)，然后[对其启用完全信任](https://support.apple.com/zh-cn/HT204477)。

对于安卓系统，安装根证书 CA ，然后在你的应用程序的开发构建中启用用户根证书。见 [StackOverflow 的答案](https://stackoverflow.com/a/22040887/749014)。

## 显示插件的调试信息

设置环境变量 `DEBUG`=`vite:plugin:mkcert`

## 更新日志

[CHANGELOG](CHANGELOG.md)

## 原理

使用 [mkcert](https://github.com/FiloSottile/mkcert) 安装本地 `CA` 证书，并为 [server.https](https://vitejs.bootcss.com/config/#server-https) 生成服务端证书。

## 友情提示

1. `mkcert` 保存目录：[PLUGIN_DATA_DIR](plugin/lib/constant.ts)
2. 卸载 `CA` 证书：`mkcert -uninstall`

## 感谢

- [mkcert](https://github.com/FiloSottile/mkcert)
- [daquinoaldo/https-localhost](https://github.com/daquinoaldo/https-localhost)
- [vite-plugin-mkcert](https://github.com/liuweiGL/vite-plugin-mkcert)

---
_Source: https://npm.io/package/webpack-mkcert · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._