Added

• Support for s390x, ppc64, and ppc64le architectures.

Added

• Build and stability improvements.
• Documentation improvements.

Added

• Support for MSYS2's mingw when installing the agent. Like cygwin, it is mapped to its corresponding Windows binary.
• Windows ARM 64-bit support.
• FreeBSD ARM support.
• Build and stability improvements.
• Documentation improvements.

Removed

• cygwin from dict of PLATFORMS, since the installer can just map to its corresponding Windows CDN value instead.

Added

• ngrok.api(), allowing api commands to be executed from the agent.
• Agent interface, which provides access to Captured Requests and agent status.
• Stability and logging improvements.
• Documentation improvements.

Added

• stderr is now sent to stdout in capture_run_process().
• Stability improvements around concurrency.
• Documentation improvements.
• Test improvements.

Added

• Deprecation warning when using Labeled Tunnels, since ngrok Edges will be sunset December 31st, 2025. See this issue for more details.
• Documentation improvements.
• Build improvements.

Added

• Documentation improvements.

Removed

• Behavior where ngrok default config file is always installed to conf.DEFAULT_NGROK_CONFIG_PATH, even when override PyngrokConfig.config_path is given. This contradicted documentation, and is inconsistent with parallel behavior in java-ngrok.

Added

• Support for ngrok config version 3.
• ngrok.set_api_key() to allowing setting the API key in the ngrok config file.
• If no value for PyngrokConfig.api_key, it will attempt to use the environment variable NGROK_API_KEY if it is set.

Added

• Test improvements.

Changed

• Permission for installed binary to limit execute to user.

Added

• Include SSL handshake failures in installer retry logic.
• Documentation improvements update links to ngrok's documentation.