mirror of
https://github.com/CharaChorder/DeviceManager.git
synced 2026-01-17 23:42:51 +00:00
106 lines
3.1 KiB
Markdown
106 lines
3.1 KiB
Markdown
# [中文文档](README-zh_CN.md)
|
|
|
|
# vite-plugin-mkcert
|
|
|
|
Use mkcert to provide certificate support for vite https development services.
|
|
|
|
## When should I use this plugin
|
|
|
|
1. When you want to use `http/2` to solve the concurrency limit of vite http dev server requests, you find that the browser cache is invalid [#2725](https://github.com/vitejs/vite/issues/2725).
|
|
2. I have obsessive-compulsive disorder, and I hope that the browser will not show annoying https certificate errors.
|
|
|
|
## Effect
|
|
|
|
<details>
|
|
<summary>View</summary>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</details>
|
|
|
|
## Quick start
|
|
|
|
1. Installation dependencies
|
|
|
|
```sh
|
|
yarn add vite-plugin-mkcert -D
|
|
```
|
|
|
|
2. Configure vite
|
|
|
|
```ts
|
|
import {defineConfig} from'vite'
|
|
import mkcert from'vite-plugin-mkcert'
|
|
|
|
// https://vitejs.dev/config/
|
|
export default defineConfig({
|
|
server: {
|
|
https: true
|
|
},
|
|
plugins: [mkcert()]
|
|
})
|
|
```
|
|
|
|
## Parameters
|
|
### hosts
|
|
|
|
Custom hosts, default value is `localhost` + `local ip addrs`.
|
|
### force
|
|
|
|
Whether to force generate.
|
|
### autoUpgrade
|
|
|
|
Whether to automatically upgrade `mkcert`.
|
|
|
|
### source
|
|
|
|
Specify the download source of `mkcert`, domestic users can set it to `coding` to download from the coding.net mirror, or provide a custom [BaseSource](plugin/mkcert/Source.ts).
|
|
|
|
### mkcertPath
|
|
|
|
If the network is restricted, you can specify a local `mkcert` file instead of downloading from the network.
|
|
|
|
### savePath
|
|
|
|
The location to save the files, such as the downloaded mkcert program and the generated CA file, private key and certificate file, etc. Default value is [PLUGIN_DATA_DIR](plugin/lib/constant.ts)
|
|
|
|
### keyFileName
|
|
|
|
The name of private key file generated by mkcert
|
|
|
|
### certFileName
|
|
|
|
The name of cert file generated by mkcert
|
|
|
|
## Mobile devices
|
|
|
|
For the certificates to be trusted on mobile devices, you will have to install the root CA. It's the `rootCA.pem` file in the folder printed by `mkcert -CAROOT`.
|
|
|
|
On iOS, you can either use AirDrop, email the CA to yourself, or serve it from an HTTP server. After opening it, you need to [install the profile in Settings > Profile Downloaded](https://github.com/FiloSottile/mkcert/issues/233#issuecomment-690110809) and then [enable full trust in it](https://support.apple.com/en-nz/HT204477).
|
|
|
|
For Android, you will have to install the CA and then enable user roots in the development build of your app. See [this StackOverflow answer](https://stackoverflow.com/a/22040887/749014).
|
|
|
|
## Display the debugging information of the plug-in
|
|
|
|
Set the environment variable `DEBUG`=`vite:plugin:mkcert`
|
|
|
|
## CHANGELOG
|
|
|
|
[CHANGELOG](CHANGELOG.md)
|
|
|
|
## Principle
|
|
|
|
Use [mkcert](https://github.com/FiloSottile/mkcert) to install the local `CA` certificate and generate it for [server.https](https://vitejs.bootcss.com/config/#server-https) Server certificate.
|
|
|
|
## Friendly reminder
|
|
|
|
1. Uninstall the `CA` certificate: `mkcert -uninstall`
|
|
|
|
## Thanks
|
|
|
|
- [mkcert](https://github.com/FiloSottile/mkcert)
|
|
- [daquinoaldo/https-localhost](https://github.com/daquinoaldo/https-localhost)
|