How can I use w/ TLS, a subdomain, and set my own port?

[markcerv]

Hello,

I am a pro plan user of ngrok which allows me to have "End-to-End TLS Tunnels".

When I fire up ngrok to work on a project, this is the command I run from Windows Terminal (or PowerShell, or CMD)

ngrok tls -subdomain=mysubdomainname 8000

I don't see how I can call ngrok using your extension and pass along those settings.
Is it possible?
If so, can you please let me know how?

Thank you.

[philnash]

Hey @markcerv,

Good question, I normally use ngrok to open http tunnels, so that's what I mainly built this to do by default.

What I would recommend is creating a named tunnel in your ngrok config that you can open with the plugin. You can define tunnels in your ngrok config as described in the documentation here.

With the latest version of this extension, you can open your ngrok config file for editing from the command palette (ngrok: edit ngrok settings) and then, when you have named tunnels in your config, when you run ngrok: start from the command palette you will see the option to start one of your named tunnels. This will use the settings from the config file.

I will consider adding commands to start a tls or tcp tunnel in addition to http tunnels, but for more complex tunnels, with subdomains, host headers and the like, I recommend creating named tunnels in your config.

Let me know if that helps!

[markcerv]

@philnash

Thank you for your reply. From your hints/notes above, I was able to add to my ngrok configuration file so that it looked like:

Inside Windows 10

authtoken: 12345secret12345secret
tunnels:
   somename:
        proto: tls
        addr: 8000
        subdomain: mysubdomainname 

Then from the windows terminal, I was able to run: ngrok start somename and that named configuration worked!

Inside Visual Studio Code

Lastly, from inside of Visual Studio Code, I chose View -> Command Palette , then typed in: ngrok: edit ngrok settings and modified the ngrok.yml that it opened.

To run that tunnel, I chose View -> Command Palette, then type in ngrok: start and the named tunnel(s) that I had configured showed up, and I retyped in the name and pressed enter.

NOTES

The config file that appears when you run ngrok: edit ngrok settings could very well be a totally different ngrok.yml than the one you have configured in your main OS.

The config file that I edited from Visual Studio Code is inside of a Ubuntu WSL 2 instance that I run inside of Windows 10.
Which is NOT the same config file that I run from Windows 10 terminal/command line.

Hopefully the above notes will help others!
mark

[philnash]

Thanks for following up with this @markcerv. I use a Mac, so I'm not used to VS Code in WSL 2 on Windows!

If it helps, you can set the path to the config file that ngrok for VSCode uses in the VS Code settings. I've never used WSL 2, so I don't know if this would work, but you may be able to point to the same yaml config file as the Windows 10 environment here.