Skip to content
This repository was archived by the owner on Oct 9, 2025. It is now read-only.
This repository was archived by the owner on Oct 9, 2025. It is now read-only.

Replace Ngrok with Tunnelmole #47

@robbie-cahill

Description

@robbie-cahill

I've noticed you have ngrok as your suggested tunneling solution in your docs. However, it has a few issues

  • Its closed source and proprietary
  • It has to be downloaded and installed as an external dependency from ngrok.com
  • You can't self host ngrok and their paid plans are overpriced

So, i'd like to update your docs to use tunnelmole instead. It has the following advantages

  • Its open source/FOSS
  • You can self host it
  • The runtime code is pure JavaScript and is available as an npm dependency

What I can do is add tunnelmole as a dev npm dependency (it will then be available at node_modules/.bin/tunnelmole), then update your docs to use that instead of ngrok. I'll also update the relevant environment variables and references to them. Once that is done there won't be any need to install anything separately.

Here's the difference in terms of set up and usage

ngrok
First, download and install ngrok from ngrok.com

ngrok http 3000

tunnelmole

npx tunnelmole 3000

or as code:

import { tunnelmole } from 'tunnelmole';
const url = await tunnelmole({
    port: 3000
});
// url = https://idsq6j-ip-157-211-195-169.tunnelmole.com

Let me know if you'd like me to create a PR with these changes.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions