CommunityToolkit.Aspire.Hosting.Ngrok 13.6.1

Prefix Reserved
.NET 8.0 This package targets .NET 8.0. The package is compatible with this framework or higher.
There is a newer prerelease version of this package available.
See the version list below for details. 
dotnet add package CommunityToolkit.Aspire.Hosting.Ngrok --version 13.6.1
                    


                    

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


                            Directory.Packages.props
                        

                    

                
<PackageReference Include="CommunityToolkit.Aspire.Hosting.Ngrok" />
                    


                            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 CommunityToolkit.Aspire.Hosting.Ngrok --version 13.6.1
                    


                    

                
#r "nuget: CommunityToolkit.Aspire.Hosting.Ngrok, 13.6.1"
#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 CommunityToolkit.Aspire.Hosting.Ngrok@13.6.1
#: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=CommunityToolkit.Aspire.Hosting.Ngrok&version=13.6.1
                    


                            Install as a Cake Addin
                        

                    

                
#tool nuget:?package=CommunityToolkit.Aspire.Hosting.Ngrok&version=13.6.1
                    


                            Install as a Cake Tool

CommunityToolkit.Aspire.Hosting.Ngrok library

Provides extension methods and resource definitions for an Aspire AppHost to configure a ngrok container.

Getting Started

Install the package

In your AppHost project, install the package using the following command:

dotnet add package CommunityToolkit.Aspire.Hosting.Ngrok

Example usage

Then, in the Program.cs file of app host, add a ngrok resource and add endpoints to be tunneled following methods:

var myService = builder.AddProject<Projects.MyService>();
var otherSevice = builder.AddProject<Projects.OtherService>();

var authToken = builder
    .AddParameter("ngrok-auth-token", "your-ngrok-auth-token", secret: true);

builder.AddNgrok("ngrok", endpointPort: 59600) // omit endpointPort to use random port
    .WithAuthToken(authToken)
    .WithTunnelEndpoint(myService, "http", "<your-ngrok-domain>")
    .WithTunnelEndpoint(otherSevice, "http"); // ngrok will generate a random domain for this service

Querying the ngrok tunneled endpoints

After the ngrok container has started, you can query the ngrok tunneled endpoints using api exposed by the ngrok container:

curl -H "Accept: application/json" -s http://localhost:59600/api/tunnels

This will return a JSON response with the ngrok tunneled endpoints.

{
  "tunnels": [
    {
      "name": "my-http",
      "ID": "5baa78f84cffb31a96cccf5bbe992451",
      "uri": "/api/tunnels/my-http",
      "public_url": "https://<your-ngrok-domain>",
      "proto": "https",
      "config": {
        "addr": "http://host.docker.internal:5165",
        "inspect": true
      },
      // ...
    }, {
      "name": "other-http",
      "ID": "f7f1351d1307e3615ca7de310bf6bb61",
      "uri": "/api/tunnels/other-http",
      "public_url": "https://0849-94-134-176-242.ngrok-free.app",
      "proto": "https",
      "config": {
          "addr": "http://host.docker.internal:3657",
          "inspect": true
      },
      // ...
    }
  ],
  "uri": "/api/tunnels"
}

Additional Information

Feedback & contributing

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.  net9.0 is compatible.  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 is compatible.  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

This package is not used by any NuGet packages.

GitHub repositories

This package is not used by any popular GitHub repositories.

Version Downloads Last Updated
13.6.2-beta.959 44 10/27/2026
13.6.1 543 10/26/2026
13.6.1-beta.950 49 10/26/2026
13.6.1-beta.938 55 10/24/2026
13.6.1-beta.935 62 10/15/2026
13.6.1-beta.933 61 10/13/2026
13.6.1-beta.930 58 10/11/2026
13.6.0 10,924 10/1/2026
13.6.0-beta.914 62 10/1/2026
13.6.0-beta.910 65 9/30/2026
13.5.1-beta.895 68 9/29/2026
13.5.1-beta.806 63 9/28/2026
13.5.1-beta.803 65 9/28/2026
13.5.1-beta.781 65 9/28/2026
13.5.1-beta.779 61 9/28/2026
13.5.1-beta.777 63 9/28/2026
13.5.1-beta.776 69 9/28/2026
13.5.1-beta.775 72 9/27/2026
13.5.1-beta.770 65 9/25/2026
13.5.1-beta.767 72 9/22/2026
Loading failed