Generating Tunneling URL

Tunneling URL is required, because you need it to associate with your tunneling-enabled functions when you enable Tunneling. When your tunneled functions are triggered, the calls made to this URL will be routed to your local system.

Depending on the reverse proxy provider you have chosen, the steps to generate the Tunneling URL varies. For the purposes of this help documentation we will be covering the steps to generate Tunneling URL with some of the most popular and commonly used reverse proxy providers.

Ngrok

  • Log in to Ngrok through their CLI and configure two-factor authentication (2FA) for Ngrok in your system.
Note: Steps on establishing 2FA for Ngrok is provided in their official help documentation.
  • To generate a Tunneling URL, use the following CLI command:
copy
$
ngrok http tunnel-port-number

catalyst_tunneling_ngrok_tunneling_URL

  • Copy the Tunneling URL generated by Ngrok, and proceed to the Catalyst console to tunnel the functions using Catalyst.
Note:
  • The tunnel-port-number you use here will need to be the same you use to launch your function shell.

  • You can find more information on Ngrok in their official help documentation.

Localtunnel

  • Install Localtunnel in your local system by executing the following terminal command:
copy
$
npm install -g localtunnel

catalyst_tunneling_localtunnel_install

  • Execute the command below in the Localtunnel CLI to generate a tunneling URL
copy
$
lt --port tunnel-port-number

catalyst_tunneling_localtunnel_tunneling_URL

  • Copy the Tunneling URL generated by Localtunnel, and proceed to the Catalyst console to tunnel the functions using Catalyst.
Note:
  • The tunnel-port-number you use here will need to be the same you use to launch your function shell.

  • You can find more information on Localtunnel in their official help documentation.

Serveo

  • Execute the following command in a new terminal window to generate a tunneling URL using Serveo.
copy
$
ssh -R 80:localhost:tunnel-port_number serveo.net

catalyst_tunneling_serveo_tunneling_URL

  • Copy the Tunneling URL generated by Serveo, and proceed to the Catalyst console to tunnel the functions using Catalyst.
Note:
  • The tunnel-port-number you use here will need to be the same you use to launch your function shell.

  • You do not require any additional CLI commands to generate Tunneling URL using Serveo. You can find more information on Serveo in their official help documentation.

Localhost.run

  • Execute the following command in a new terminal window to generate a tunneling URL using Localhost.run
copy
$
ssh -R 80:localhost:tunnel-port-number nokey@localhost.run

catalyst_tunneling_localhostrun_tunneling_URL

  • Copy the Tunneling URL generated by Localhost.run and proceed to tunnel the functions using Catalyst.
Note:
  • The tunnel-port-number you use here will need to be the same you use to launch your function shell.

  • You do not require any additional CLI commands to generate Tunneling URL using Localhost.run. You can find more information on Localhost.run in their official help documentation.

Pagekite

  • Execute the following commands in a new terminal window to generate a tunneling URL using Pagekite.
copy
$
ssh -R 80:localhost:tunnel-port-number nokey@localhost.run

catalyst_tunneling_pagekite_install

This command will send a curl request to the Pagekite website and will ask you to download the pagekite.py file in your local system.

Note: You can use Pagekite to reverse proxy functions of any programming stack. However, to use Pagekite services, you need to ensure you have Python 3 installed in your system.
  • Now execute the following command in your Pagekite terminal to generate the Tunneling URL
copy
$
python3 pagekite.py tunnel-port-number yourname.pagekite.me

catalyst_tunneling_pagekite_tunneling_URL

Ensure that you provide a unique name for your Tunneling URL when you are prompted to do so.

Note:
  • The tunnel-port-number you use here will need to be the same you use to launch your function shell.

  • You can find more information on Pagekite in there official help documentation.

Last Updated 2024-07-23 17:40:25 +0530 +0530