Tunnelmole 开源项目安装与使用指南

Tunnelmole 开源项目安装与使用指南

tunnelmole-clientTunnelmole - Connect to local servers from anywhere项目地址:https://gitcode.com/gh_mirrors/tu/tunnelmole-client

项目介绍

Tunnelmole 是一款开源工具，旨在为本地运行的HTTP(s)服务提供一个公共URL。无论是Web服务器、Docker容器、API接口、React或Node.js应用程序，还是静态网站，都可以通过Tunnelmole获得对外可访问的地址。它被设计得简单易用，同时提供了免费的HTTPS连接。该工具在功能上与ngrok类似，但作为开源软件，它更透明且无隐藏成本。

项目快速启动

安装 Tunnelmole

首先，你可以将Tunnelmole作为一个NPM依赖项集成到你的Node.js或TypeScript项目中：

npm install --save tunnelmole

使用 Tunnelmole

接下来，以以下方式启动Tunnelmole，假定你的应用监听在端口3000:

// 导入 Tunnelmole 模块
import { tunnelmole } from 'tunnelmole';

// 启动 Tunnelmole 并指定监听的端口号
const url = await tunnelmole({ port: 3000 });
console.log(url); // 输出如 https://idsq6j-ip-157-211-195-169.tunnelmole.net

或者如果你的应用是使用CommonJS模块:

const tunnelmole = require('tunnelmole/cjs');
const url = await tunnelmole({ port: 3000 });
console.log(url);

应用案例和最佳实践

自定义子域名

要使用自定义子域，可以传递domain选项:

const url = await tunnelmole({
  port: 3000,
  domain: 'mysite.tunnelmole.net'
});
console.log(url); // 输出类似于 mysite.tunnelmole.net 的地址

抑制日志输出

在CI/CD环境中或其他脚本中可能不需要初始URL输出，可以通过设置环境变量TUNNELMOLE_QUIET_MODE=1来抑制这些输出。

典型生态项目

虽然具体列出Tunnelmole生态系统中的所有项目超出了本文范围，但了解它的主要用途可以帮助你找到与之相关的其他工具和服务。例如，Tunnelmole可以与自动化测试框架结合使用，允许远程访问测试环境；也可以用于开发工作流中，使开发者能够轻松地向团队成员展示正在开发的功能。此外，Tunnelmole还支持动态配置和连续集成流程，使其成为现代开发工具链的一部分。

tunnelmole-clientTunnelmole - Connect to local servers from anywhere项目地址:https://gitcode.com/gh_mirrors/tu/tunnelmole-client