Document ngrok usage

[gsmet]

We are using smee.io for testing but it might be a good idea to allow using Ngrok for production workload.

I don't think we need much but some documentation just to state that it actually works would be nice.

[philipleonardgriffiths]

Could we also add zrok.io? It's open source and built on OpenZiti. While OpenZiti does not have a quarkus integration module, we have created a vert.x - https://github.com/openziti/ziti-sdk-jvm/tree/v0.24.0/ziti-vertx. We could wrap this into zrok to make it a native capability.

[gsmet]

How do you envision this?

Here is the current situation:

• for production, we expect the service to be available on the Internet and accessible from GitHub servers.
• for development, we simply connect to an Smee.io channel and we get the events from there.

I could see Ngrok and equivalents as used for:

• production maybe? If it's stable enough. I know for some people it's not easy to get a GitHub App exposed on the Internet and having a stable proxy could help.
• development

What I wouldn't like though is to add a ton of dependencies to actually connect to these.

I can make this extension a bit more flexible but I would prefer if we keep the dependencies as they are. Note that we could optionally wire things if additional extensions/dependencies are around.

If you're interested in prototyping what you have in mind with zrok.io, I can certainly help. Even pseudo code or basic Java code could help, no need to wire things for now.

[philipleonardgriffiths]

Something like that yes. We will add it onto our backlog to create some documentation on using zrok with the quarkus github app

[jlin-nf]

@gsmet The zrok.io give you easy access to the private server. It is free to sign up and test what you need. You can even self-host the service if you don't want to use the generally available server ziti is hosting. Please let me know if I can help you to get you what you need to be.

[maxandersen]

@gsmet ngrok "just works" but would be great if security checks could be enabled in devmode so actually get the benefits.

@jlin-nf @philipleonardgriffiths if i understand right something like quarkus-zrok extension would make sense similar to how we have https://github.com/quarkiverse/quarkus-ngrok support.