Tunnelite.Sdk 1.0.0

dotnet add package Tunnelite.Sdk --version 1.0.0                
NuGet\Install-Package Tunnelite.Sdk -Version 1.0.0                
This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package.
<PackageReference Include="Tunnelite.Sdk" Version="1.0.0" />                
For projects that support PackageReference, copy this XML node into the project file to reference the package.
paket add Tunnelite.Sdk --version 1.0.0                
#r "nuget: Tunnelite.Sdk, 1.0.0"                
#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package.
// Install Tunnelite.Sdk as a Cake Addin
#addin nuget:?package=Tunnelite.Sdk&version=1.0.0

// Install Tunnelite.Sdk as a Cake Tool
#tool nuget:?package=Tunnelite.Sdk&version=1.0.0                

⚑Tunnelite

Tunnelite is a .NET tool that lets you set up a secure connection between a public web address and an application running on your local machine. It effectively makes your local app accessible from the internet.

πŸš€ Use Cases

  • Exposing locally-hosted web applications to the internet for testing or demo purposes.
  • Quickly sharing dev builds during hackathons.
  • Testing and debugging webhook integrations.
  • Providing internet access to services running behind firewalls without exposing incoming ports.

πŸ“„ Installation

To install Tunnelite as a global tool, use the following command:

dotnet tool install --global Tunnelite

Once installed, you can use the tunnelite command to create a tunnel to your local application:

tunnelite http://localhost:3000

This command returns a public URL with an auto-generated subdomain.

alt text

πŸ” How It Works

Tunnelite creates a bridge between your local application and the internet using a websocket connection. It streams incoming data from a public URL directly to your local server, making your local app accessible from anywhere.

The managed version of Tunnelite supports http(s) and ws(s) tunneling. If you need TCP tunneling, you'll have to host the server yourself.

Self-Hosting Requirements

To set up your own Tunnelite server, you'll need:

  • Wildcard SSL certificate for your domain
  • Wildcard DNS record pointing to your server's IP address

These allow Tunnelite to create secure subdomains for your tunnels and properly route traffic to your self-hosted server.

<br/> <details> <summary>HTTP Connection</summary>

<br/>

image info

</details>

<details> <summary>TCP Overview</summary>

<br/>

image info

</details>

<details> <summary>TCP Connection</summary>

<br/>

image info

</details>

<br/>

πŸ“„ License

This project is licensed under the MIT License.

Product Compatible and additional computed target framework versions.
.NET net8.0 is compatible.  net8.0-android was computed.  net8.0-browser was computed.  net8.0-ios was computed.  net8.0-maccatalyst was computed.  net8.0-macos was computed.  net8.0-tvos was computed.  net8.0-windows was computed. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.

NuGet packages (1)

Showing the top 1 NuGet packages that depend on Tunnelite.Sdk:

Package Downloads
Tunnelite.AspNetCore

SDK for tunneling AspNetCore apps

GitHub repositories

This package is not used by any popular GitHub repositories.

Version Downloads Last updated
1.0.0 113 10/10/2024