NgrokSharp 1.0.13

.NET 6.0 This package targets .NET 6.0. The package is compatible with this framework or higher.
The owner has unlisted this package. This could mean that the package is deprecated, has security vulnerabilities or shouldn't be used anymore. 
dotnet add package NgrokSharp --version 1.0.13
                    


                    

                
NuGet\Install-Package NgrokSharp -Version 1.0.13
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="NgrokSharp" Version="1.0.13" />
For projects that support PackageReference, copy this XML node into the project file to reference the package. 
<PackageVersion Include="NgrokSharp" Version="1.0.13" />
                    


                            Directory.Packages.props
                        

                    

                
<PackageReference Include="NgrokSharp" />
                    


                            Project file
For projects that support Central Package Management (CPM), copy this XML node into the solution Directory.Packages.props file to version the package. 
paket add NgrokSharp --version 1.0.13
                    


                    

                
#r "nuget: NgrokSharp, 1.0.13"
#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. 
#:package NgrokSharp@1.0.13
#:package directive can be used in C# file-based apps starting in .NET 10 preview 4. Copy this into a .cs file before any lines of code to reference the package. 
#addin nuget:?package=NgrokSharp&version=1.0.13
                    


                            Install as a Cake Addin
                        

                    

                
#tool nuget:?package=NgrokSharp&version=1.0.13
                    


                            Install as a Cake Tool

Contributors Forks Stargazers Issues MIT License Coverage Discord

About The Project

Features

  • Easy to use API
  • Downloads the correct Ngrok version for your platform
  • Supports different logging providers by implementing Microsoft.Extensions.Logging

Getting Started

Installation

Install via nuget.org

Usage

Code example

static async Task Main(string[] args)
{
    INgrokManager _ngrokManager;
    _ngrokManager = new NgrokManager();

    await _ngrokManager.DownloadAndUnzipNgrokAsync();

    // Insert your token, if you have one.
    //await _ngrokManager.RegisterAuthTokenAsync("Your token");

    _ngrokManager.StartNgrok();

    var tunnel = new StartTunnelDTO
    {
        name = "reverse proxy",
        proto = "http",
        addr = "8080"
    };

    var httpResponseMessage = await _ngrokManager.StartTunnelAsync(tunnel);

    if ((int)httpResponseMessage.StatusCode == 201)
    {
        var tunnelDetail =
            JsonSerializer.Deserialize<TunnelDetailDTO>(
                await httpResponseMessage.Content.ReadAsStringAsync());

        Console.WriteLine(tunnelDetail.PublicUrl);
    }
}

Projects using NgrokSharp

NgrokGUI

Roadmap

See the open issues for a list of proposed features (and known issues).

Contributing

Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are greatly appreciated. But first please read this.

License

Distributed under the MIT License. See LICENSE for more information.

Acknowledgements

Thanks to these

Product Compatible and additional computed target framework versions.
.NET net6.0 is compatible.  net6.0-android was computed.  net6.0-ios was computed.  net6.0-maccatalyst was computed.  net6.0-macos was computed.  net6.0-tvos was computed.  net6.0-windows was computed.  net7.0 was computed.  net7.0-android was computed.  net7.0-ios was computed.  net7.0-maccatalyst was computed.  net7.0-macos was computed.  net7.0-tvos was computed.  net7.0-windows was computed.  net8.0 was computed.  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.  net9.0 was computed.  net9.0-android was computed.  net9.0-browser was computed.  net9.0-ios was computed.  net9.0-maccatalyst was computed.  net9.0-macos was computed.  net9.0-tvos was computed.  net9.0-windows was computed.  net10.0 was computed.  net10.0-android was computed.  net10.0-browser was computed.  net10.0-ios was computed.  net10.0-maccatalyst was computed.  net10.0-macos was computed.  net10.0-tvos was computed.  net10.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 NgrokSharp:

Package Downloads
Neon.Operator

Kubernetes Operator SDK.

GitHub repositories

This package is not used by any popular GitHub repositories.

Version Downloads Last Updated

Added a new method that allows to set directory where the ngrok executable is