简介
Ngrok 是一个可以将本地的 web 服务器映射到公共的互联网上的工具，可以将本地开发中的调试服务器暴露到公网，便于其他人访问。ngrok.js 是一个基于 Node.js 封装的 Ngrok 客户端工具。
本文将简单介绍 npm 包 ngrok.js 的使用方法，包括安装，配置及使用方法。我们以一个本地的 Express 应用为例子，演示如何使用 ngrok.js 工具将本地服务器映射到公共互联网上。
安装
首先，我们需要在本地环境安装 ngrok.js，使用 npm 命令安装即可。
npm install ngrok --save-dev
配置
安装后，我们需要使用 Ngrok 提供的服务进行映射和调试，使用 Ngrok 需要提供一个 Authtoken，可以在官网 https://dashboard.ngrok.com/auth 注册账号后获取。
获取 Authtoken 后，我们需要在 ngrok.js 中进行配置。在项目跟目录下新建一个 .env 文件，将 Authtoken 添加到该文件中：
NGROK_AUTH_TOKEN=***********
使用
安装并配置好 ngrok.js 后，我们通过以下步骤即可将本地的 Express 应用映射到公共互联网上：
- 在 Express 应用中添加端口配置，如下：
-- -------------------- ---- ------- ----- ------- - ------------------ ----- --- - --------- ----- ---- - ---- -- --- ------------ ----- ---- -- - --------------- -------- -- ---------------- -- -- - ---------------- --------- -- -------------------------- --
- 在项目根目录下创建一个 ngrok.js 文件，添加如下内容：
-- -------------------- ---- -------
----- ----- - ----------------
----- ------ - -----------------
---------------
----- ---------- - ---------------------------- -- -- ---------
----- ---- - ---- -- ---
----- ---------- - ----- -- -- -
------ ----- ---------------
----- -----
---------- ----------
--
-
------ -- -- -
----- --- - ----- ------------
------------------ ------------ -- ------ --- --
----- 启动 Express 应用，并运行 ngrok.js 文件
node app node ngrok.js
- 打开 ngrok 提供的链接即可访问映射后的应用。
示例代码
完整的示例代码可以在 GitHub 上查看， https://github.com/example/ngrokjs-example。该示例包含一个简单的 Express 应用和 ngrok.js 工具的配置和使用。
来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/6005671d81e8991b448e37d8