From 04b4b3c06f3d20d12d41442ae655d04faa3cdbfa Mon Sep 17 00:00:00 2001 From: Josh Robson Chase Date: Thu, 2 Nov 2023 11:10:12 -0400 Subject: [PATCH] config: add link to `ListenAndForward` in `WithForwardsTo` --- config/forwards_to.go | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/config/forwards_to.go b/config/forwards_to.go index 4ead80c..d4ae12b 100644 --- a/config/forwards_to.go +++ b/config/forwards_to.go @@ -11,6 +11,10 @@ type forwardsToOption string // WithForwardsTo sets the ForwardsTo string for this tunnel. // This can be viewed via the API or dashboard. // +// This overrides the default process info if using +// [golang.ngrok.com/ngrok.Listen], and is in turn overridden by the url +// provided to [golang.ngrok.com/ngrok.ListenAndForward]. +// // https://ngrok.com/docs/api/resources/tunnels/#tunnel-fields func WithForwardsTo(meta string) Options { return forwardsToOption(meta)