node-slack-sdk icon indicating copy to clipboard operation
node-slack-sdk copied to clipboard

Replace Ngrok with Tunnelmole in your docs for a FOSS Tunneling solution

Open robbie-cahill opened this issue 2 years ago • 1 comments

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 fully open source/FOSS with a permissive MIT license
  • You can self host it for total control or use the hosted service if you want to use it right away
  • It's available as an npm dependency, making installation and updates a lot easier for any JavaScript developer
  • You can run it from code in addition to the command line for more advanced setups

I'd like to update your docs to instruct users to use Tunnelmole for an easier experience.

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

Ngrok

First, download and install ngrok seperately from ngrok.com, then run

ngrok http 3000

Tunnelmole

Install from NPM with npm install -g tunnelmole, then run

tunnelmole 3000

Or run from code for more advanced setups:

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.

List any relevant URLs

  • docs/_packages/events_api.md
  • docs/_tutorials/local_development.md
  • examples/express-all-interactions/README.md
  • examples/greet-and-react/README.md
  • https://github.com/slackapi/node-slack-sdk/blob/b1e6550d84ff1cb80a8ed386e5f288aadc70b07f/examples/greet-and-react/index.js#L91
  • examples/greet-and-react/README.md
  • https://github.com/slackapi/node-slack-sdk/blob/b1e6550d84ff1cb80a8ed386e5f288aadc70b07f/examples/legacy-sign-in-with-slack/app_manifest.yml#L8
  • examples/oauth-v1/README.md
  • examples/oauth-v2/README.md
  • examples/openid-connect/README.md
  • packages/events-api/README.md

Requirements

Please read the Contributing guidelines and Code of Conduct before creating this issue or pull request. By submitting, you are agreeing to those rules.

robbie-cahill avatar Jul 08 '23 10:07 robbie-cahill

Hi @robbie-cahill, thank you for reaching out to us!

Your project looks really cool and I believe it would be valuable for many people, including myself! 👍 However, at this moment, we would prefer not to replace any parts of the document, as ngrok is already popular and useful. If we notice more people agreeing to include your OSS product in the documentation, we may consider adding it alongside ngrok in the future, instead of completely replacing it. Until then, let's hold off on making any changes and see what the community members think.

seratch avatar Jul 10 '23 00:07 seratch

Going to close this issue.

filmaj avatar Jun 05 '24 19:06 filmaj