alexdlaird / pyngrok

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

traffic policies #135

Closed ohitstom closed 1 month ago

ohitstom commented 1 month ago

Acknowledgements

Describe the Feature

i was interested in setting up a rate limit traffic policy, how can i do this using pyngrok?

Describe Alternative Solutions/Workarounds

No response

github-actions[bot] commented 1 month ago

This is a bug tracker and not a support forum.

While we'd love to be able to support every person on their projects, that would simply be infeasible. Luckily, that's what the helpful developer community over at Stack Overflow is for! Please create a question there with the \"pyngrok\" tag if what you're looking for is a programming question or you need help with an integration. You can refer to pyngrok's own documentation to help you write the best possible question.

If you support the project, contact me directly and I'd be happy to help you troubleshoot.

ohitstom commented 1 month ago

This is a bug tracker and not a support forum.

While we'd love to be able to support every person on their projects, that would simply be infeasible. Luckily, that's what the helpful developer community over at Stack Overflow is for! Please create a question there with the "pyngrok" tag if what you're looking for is a programming question or you need help with an integration. You can refer to pyngrok's own documentation to help you write the best possible question.

If you support the project, contact me directly and I'd be happy to help you troubleshoot.

???????????? this isnt a support question i dont see anywhere in the docs for implementation on this feature

alexdlaird commented 1 month ago

pyngrok supports all standard configuration parameters of ngrok via kwargs. Some basic examples are are there, but ultimately ngrok's documentation would be source of truth for how you'd build the args (purposely pyngrok tries not to duplicate too much of ngrok's own documentation beyond the basic examples, as that'd be a nightmare to maintain).

The non-programmatic way to accomplish this would be to put the policy in the ngrok's config for the tunnel (pyngrok is unaware of this configuration, it's just passed to the tunnel by ngrok on startup).

If you encounter any issues with the kwarg method, feel free to open a bug report, as that should work. Or if you feel there's generic wording in the documentation that could be improved to help people understand how to map the pyngrok docs to the ngrok docs at this point, feel free to suggest a change or submit a PR for consideration. Thanks!