在 Web 开发中,本地开发环境往往需要使用 localhost。但是许多现代浏览器要求使用 HTTPS 才能运行很多功能,因此我们需要使用本地 HTTPS。这就需要为 localhost 生成证书,而 @small-tech/auto-encrypt-localhost 便是一款自动为 localhost 生成证书的 npm 包。
安装
使用 npm 安装,命令如下:
npm i -g @small-tech/auto-encrypt-localhost
这将会全局安装 @small-tech/auto-encrypt-localhost。
使用
命令行
可以在命令行下使用 auto-encrypt-localhost 命令来生成证书。
使用以下命令:
auto-encrypt-localhost
这将为你生成一个 key.pem 和一个 cert.pem 文件,位于命令运行的当前目录下。
在项目中使用
如果你需要在一个项目中使用此工具,可以按如下方法安装:
npm i --save-dev @small-tech/auto-encrypt-localhost
然后在项目下创建一个 server 文件,代码如下:
-- -------------------- ---- ------- ----- ----- - ----------------- ----- -- - -------------- ----- ------- - - ---- --------------------------- ----- --------------------------- -- ----- ------ - --------------------------- ----- ---- -- - ------------------- -------------- ---------- --- ------------------ -- -- - ------------------- ---------- ---
这样,你便可以在 localhost 的 443 端口上使用 HTTPS 了。
高级用法
如果你需要为其他域名或 IP 地址生成证书,可以在命令后面传入主机名或 IP 地址,如下所示:
auto-encrypt-localhost yourdomain.com your-ip-address.com
同时,你可以使用以下可选参数:
-t [timeoutMs]
: 连接超时时间(单位:毫秒)。--verbose
: 输出更详细的日志信息。
例如,
auto-encrypt-localhost yourdomain.com your-ip-address.com -t 10000 --verbose
将为 yourdomain.com
和 your-ip-address.com
生成证书,连接超时时间为 10 秒,并打印更详细的日志信息。
结语
本文介绍了 npm 包 @small-tech/auto-encrypt-localhost 的使用方法。通过阅读本文,你可以在自己的项目中使用此工具生成 localhost 上的 HTTPS 证书,从而使得你可以在现代浏览器下正常运行项目。同时,你还可以了解到如何为其他域名或 IP 地址生成证书。
来源:JavaScript中文网 ,转载请注明来源 https://www.javascriptcn.com/post/5eedb0dcb5cbfe1ea06110ee