You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
If this is not defined, pyngrok still works fine, but anyone using the endpoints value in their config just doesn't get this built-in benefit of pyngrok anymore, so we want to support that too.
The existing implementation should work if the config version field value is 1 or 2. In config version 3, the "tunnels" field does still work, it's just deprecated, so in the config version 3 case, we should add additional support for defined endpoints.
Ensure support for the special pyngrok-default named tunnel works when its defined in the new endpoints section instead. No need to deduplicate if a named tunnel exists in both tunnels and endpoints, ngrok already does this for us.
Check if/what docs need to be updated. For now, the installer should still provision a default v2 config, we are not changing to make v3 the default config version, only add support for it.
The text was updated successfully, but these errors were encountered:
Note that the traffic_policy element of the v3 config is still in preview, and may break without notice. There is a separate ticket created (#139) to add support for this config element (in v2 and v3), so when we implement the v3 config, leave it out for now (since it also doesn't yet exist in our implementation of the v2 config, and is still new and being tested anyway). This way we are not blocked by the traffic_policy element to implement the v3 config support.
alexdlaird
added
ready
Issue has been triaged and accepted, ready to work
and removed
stale
Issue will be closed automatically if no further activity occurs
labels
Nov 15, 2024
Add support for
ngrok
's v3 config file: https://ngrok.com/docs/agent/config/v3/#breaking-changesThe entire
start()
method is based on parsing the "tunnels" value of the config:pyngrok/pyngrok/ngrok.py
Line 250 in 85f10f8
If this is not defined,
pyngrok
still works fine, but anyone using theendpoints
value in their config just doesn't get this built-in benefit ofpyngrok
anymore, so we want to support that too.The existing implementation should work if the config
version
field value is1
or2
. In config version3
, the "tunnels" field does still work, it's just deprecated, so in the config version3
case, we should add additional support for definedendpoints
.Ensure support for the special
pyngrok-default
named tunnel works when its defined in the newendpoints
section instead. No need to deduplicate if a named tunnel exists in bothtunnels
andendpoints
,ngrok
already does this for us.Check if/what docs need to be updated. For now, the installer should still provision a default v2 config, we are not changing to make v3 the default config version, only add support for it.
The text was updated successfully, but these errors were encountered: