search

alexdlaird / pyngrok

A Python wrapper for ngrok
https://pyngrok.readthedocs.io
MIT License
416 stars 59 forks source link

Update pyngrok to work with ngrok 3.x #99

Closed alexdlaird closed 1 year ago

alexdlaird commented 2 years ago

ngrok released v3.x, which has many breaking changes. pyngrok still works fine with ngrok 2.x, which is the version it uses for its managed binary, but it is easy to miss which version you've downloaded (which has led to a lot of community confusion), and the library should be updated to support the latest ngrok using their migration guide.

Additionally, since ngrok doesn't version its docs, this has led to further community confusion, since pyngrok frequently links to its documentation, but now these links point to incompatible 3.x documentation. The last good 2.x docs can be found on the Archive.org here.

cmsethi commented 1 year ago

Please... update pyngrok to work with ngrok 3.x all the scripts have stopped working regards

alexdlaird commented 1 year ago

Support for ngrok v3 is currently on the develop branch. In the meantime, however, pyngrok continues to work fine with ngrok 2.x binaries, which is what it installs by default. If you are having issues with ngrok, it is likely because you are trying to use a ngrok 3.x binary with it rather than a 2.x binary (or you're not letting pyngrok manage its own binary, where it will choose a 2.x binary).

If you are having issues troubleshooting, you can provide more details and open a question over at StackOverflow.

alexdlaird commented 1 year ago

Closing, as pyngrok 5.2.0 testing is now stable, and this release will include support for ngrok v3`.