Package Exports

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (ttunnel) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

ttunnel

ttunnel exposes your localhost to the world for testing and sharing! No need to mess with DNS or those hard networking staff.

ttunnel can expose ony hostname other than localhost, for example it is suitable for sharing valet sites.

Installation

Globally

npm install -g ttunnel

As a dev dependency in your project

npm install -D ttunnel

Quickstart

npx ttunnel start 8080

Common Issues

Node Version

ttunnel requires node version greater than or equal 20, due to resolving localhost issue

Invalid Host Header

Host header is being sent automatically

If you are trying to tunneling Vue, React or any other frameworks, sometimes it requires Host header to be presented in the request headers. To solve this common issue through ttunnel, run the following command:

npx ttunnel start 8080 --host-header=localhost:8080

Restart your tunnel

Sometimes you want to make changes to your codebase, most of times this requires to close the tunnel, but don't worry about restarting the tunnel with the same domain. You just need to remember the domain, or customize it from the beginning.

npx ttunnel start 8080 --domain=my-awesome-subdomain

Arguments & Flags

Arguments

port (argument)(number) [required] The local port number to expose through.

Flags

api-key (flag) [required] Your TTunnel API Key to make sure all tunnels are authorized.
domain (flag)(string) Request a specific subdomain on the proxy server. Note You may not actually receive this name depending on availability.
endpoint (flag)(string) Used for self-hosted ttunnel version. Defaults to ws://ttunnel.me:4000.
hostname (flag)(string) Proxy to a custom hostname instead of default one. Note Host header will equal hostname value unless you used host-header flag.
host-header (flag)(string) set Host header
basic-auth (flag)(string) enforce basic auth on tunnel endpoint, user:password
request-header-add (flag)(string) header key:value to add to request
request-header-remove (flag)(string) header field to remove from request if present
response-header-add (flag)(string) header key:value to add to response
response-header-remove (flag)(string) header field to remove from response if present

Run npx ttunnel help command to learn more about ttunnel available commands and arguments.