- Rename
policy
totraffic_policy
in Listener builders andngrok.forward
- Fix quickstart example in README
- Add
root_cas
to session builder andngrok.forward
. Setting this tohost
will use the host's trusted certificates to connect for the ngrok session. - Add
session_ca_cert
andserver_addr
tongrok.forward
, which correspond to the same functions in the session builder.
- Add
verify_upstream_tls
to listener builders andngrok.forward
. Setting this to false will skip verification of the upstream application's TLS certificate.
- Add
app_protocol(string)
to http and labeled listener builders, andapp_protocol: string
as angrok.forward()
argument. Setting this to "http2" will enable HTTP/2 support to the backend application.
- Add policy support to Listener builders and
ngrok.forward
- Move to
ngrok.forward
fromngrok.connect
, keeping an alias
- Add
allow_user_agent
anddeny_user_agent
options to HTTP listeners - Add
client_id
andclient_secret
options to OAuth
- Rename all assets to listener
- Add links to ngrok documentation
- Log if an auth token was used for session creation
- Fix publishing for aarch64
- Add
listen_and_forward
andlisten_and_serve
to listener builders. - Update to latest version of underlying rust library, allowing TLS backends.
- Fix aarch64 build for docker-ubuntu-on-macos and raspberry pi.
- Flattened
listener.forward_pipe()
andlistener.forward_tcp()
intolistener.forward()
. Determination will be made based onaddr
input. - Added Mypy static typing information.
- Added
session.get_listeners()
to get a list of current non-closed listeners for the session. - Added
ngrok.set_auth_token(<token>)
to set a default auth token to use for sessions. - Added ngrok error codes as 3rd argument to thrown Errors, when available.
- Cleanly return from a listener forward call after a
session.close()
- Add
Session.client_info()
- Rename to
ngrok-python
- Add
ngrok.disconnect(url)
andngrok.kill()
convenience functions. - Add examples for Tornado, OpenPlayground, Streamlit, GPT4All.
- Handle protocols in
addr
, and dots inconnect
option keys, for ease-of-use. - Docs improvements
- Add
ngrok.connect(options)
convenience function. - Add Gradio example.
- Consolidate multiple listener classes into one.
- Add ngrok-asgi ASGI runner.
- Migrate
ca_cert
to the upstream call inngrok-rust
.
- Django, auto-format, and windows support in examples.
- Add wrapper convenience functions.
- Add
close
,ca_cert
,handle_disconnection
,handle_heartbeat
to Session.
- Initial public release.