[Feature] Integrate ngrok support

[esskar]

Description

The feature request is to integrate ngrok support into the CommunityToolkit.Aspire project.

Motivation

ngrok support would enhance the developer experience by enabling secure and public URLs for local applications, which is especially useful for testing and demo purposes. This feature would be a great addition to the toolkit, providing:

• Simplified local testing of webhooks.
• Easier sharing of local applications for feedback or collaboration.
• Improved accessibility during development.

Proposed Solution

Integrate the CommunityToolkit.Aspire.Hosting.Ngrok library into the main CommunityToolkit.Aspire repository.

For more information see https://github.com/esskar/CommunityToolkit.Aspire/tree/main/src/CommunityToolkit.Aspire.Hosting.Ngrok

[davidfowl]

Very cool! Is there a programmatic way to get the ngrok url for a resource being proxied? That would make it possible to pass it to other resources

[esskar]

Could try the api to retrieve it - or is there an easy way to pipe the stdout of the container to the host.

[davidfowl]

Ngrok doesn't have an api?

[esskar]

Ngrok doesn't have an api?

Yes there is, and i found a way. when i am called for the ResourceReadyEvent subscription, i can query the ngrok api to retireve the endpoints. Is there a way to publish those endpoints at this stage? Adding to the builder is probably to late, isn't it?

[davidfowl]

1. I’m not sure you want to want to make them endpoints (there’s a chicken an egg problem). You maybe want to expose an api like endpoint like api. Typically the patten is exposing a builder API is a promise like object (it gets resolved in the future). This is going deeper than what’s currently documented for building hosting integrations but it’s available. Let me know if you still want to attempt to implement it.

The other question is, what happens to this resource in publish mode?

[esskar]

The other question is, what happens to this resource in publish mode?

I currently have it excluded from the manifest, as I saw it for development purposes only. But as i read more on ngrok, it could make sense to publish it.

Any suggestions here?

[aaronpowell]

What would the role of ngrok in production be?

I've merged the integration PR, it'll be in a preview on NuGet soon (takes a for manual steps). In the meantime, can you get it on docs - https://github.com/dotnet/docs-aspire/issues/new?template=05-community-toolkit-docs-request.yml

[esskar]

First I thought ngrok in production would not make no much sense as I only use it in development, but it acts as an api gateway Saas (https://ngrok.com/use-cases/api-gateway) as you can connect your own domains to it. Will get on the docs during the weekend. Is there an existing hosting related docs for reference?

…

On 9. Jan 2025, at 04:49, Aaron Powell ***@***.***> wrote: What would the role of ngrok in production be? I've merged the integration PR, it'll be in a preview on NuGet soon (takes a for manual steps). In the meantime, can you get it on docs - https://github.com/dotnet/docs-aspire/issues/new?template=05-community-toolkit-docs-request.yml — Reply to this email directly, view it on GitHub <#366 (comment)>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/AAAP5NRKPZLECCH3QXSZRXL2JXWSZAVCNFSM6AAAAABUSMLW7CVHI2DSMVQWIX3LMV43OSLTON2WKQ3PNVWWK3TUHMZDKNZZGEZDOMBQGQ>. You are receiving this because you authored the thread.

[aaronpowell]

Check out any of the ones in https://github.com/dotnet/docs-aspire/tree/main/docs/community-toolkit as a reference point