search

liuweiGL / vite-plugin-mkcert

Provide certificates for vite's https dev service.
https://www.npmjs.com/package/vite-plugin-mkcert
MIT License
541 stars 37 forks source link

DOCS - Please update documentation [ path, cert name, sudo ] #55

Closed n8sabes closed 1 year ago

n8sabes commented 1 year ago

Very nice work on this -- thank you!

SUGGESTIONS

  1. It is unclear where in the file system the cert files are created (using the default configuration). Please add a reference in the documentation to ~/.vite-plugin-mkcert/certs.

  2. It is unclear the name of the cert added to the System Keychain. Please add reference in the documentation to mkcert USER@HOST.lan so it can be found and manually removed.

  3. Advise the user in the documentation their sudo password is required to install the certs. Explain why.

These are merely suggestions as giving an unknown plugin sudo control is very concerning and would build trust.

liuweiGL commented 1 year ago

Thanks for your advice, 1/2 has already been explained in document and the sudo privilege is required by mkcert

n8sabes commented 1 year ago

@liuweiGL, thank you.

I thought I searched the docs, but didn’t see the certPath or cert name in the keychain, so I spent a few minutes searching directores so I could copy the cert/key to another non-vite backend api server that is proxied on a route — they both need the same cert/key.

Just thought it would be of value to others users whom may be looking for the certs.

arxpoetica commented 1 year ago

I would document the sudo stuff here. Yes, it's in mkcert, but I spent way too long trying to figure out why Kit was asking me to use sudo. Additionally, it's still not clear what's going on.