Skip to content

CHANGELOG.md

Latest commit

 

History

History
711 lines (431 loc) · 27.8 KB

CHANGELOG.md

File metadata and controls

711 lines (431 loc) · 27.8 KB

Changelog

All notable changes to this project will be documented in this file.

This project adheres to Semantic Versioning.

Unreleased

3.1.2 - 2026-04-29

Added

  • Build and stability improvements.

Added

  • Build and stability improvements.

3.1.1 - 2026-04-27

Added

  • CreateTunnel.trafficPolicyFile, CreateTunnel.agentTlsTermination, Upstream.proxyProtocol for v3 config gaps.

Fixed

  • Build and stability improvements.

3.1.0 - 2026-04-26

Added

  • Full support for ngrok's v3 config schema. Set JavaNgrokConfig.configVersion to ConfigVersion.V3 to have NgrokClient.connect() and other methods use ngrok's Endpoints instead of Tunnels.
  • Tunnel.getUpstream(), populated from the v3 endpoint response (or synthesized from config.addr for v2). Raw v3 fields like trafficPolicy and bindings remain accessible via matching Tunnel getters.
  • v2 withAddr() / withProto() args are interpolated to a v3 upstream block when configVersion is V3.
  • Documentation updates.

3.0.0 - 2026-03-31

Breaking

  • Removed support for ngrok v2, as v2 binaries are no longer distributed by ngrok. Only ngrok v3 is now supported.

Changed

  • Updated Linux and FreeBSD CDN URLs from .zip to .tgz.
  • Added .tgz archive extraction support alongside existing .zip support.

2.5.1 - 2026-03-06

Changed

  • Migrated CDN URLs from bin.equinox.io to bin.ngrok.com.

2.5.0 - 2025-11-17

Removed

  • Removed support for ngrok Edges, as they are deprecated by ngrok and will be sunset December 31st, 2025. See this issue for more details.

2.4.1 - 2025-10-23

Added

  • Support for XDG_CONFIG_HOME.

2.4.0 - 2025-09-23

Changed

  • As of ngrok Agent 3.29.0, two tunnels cannot have the same name (and this includes tunnel's defined in the config, even if they are not started). As such, when withName() is given and matches a tunnel defined in the config, java-ngrok will append "-api" to the tunnel's name when starting it.

2.3.16 - 2025-07-09

Added

  • Support for s390x, ppc64, and ppc64le architectures.
  • Stability improvements.

2.3.15 - 2025-05-28

Added

  • Documentation improvements.

2.3.14 - 2025-05-16

Added

  • Documentation improvements.

Fixed

  • Noisy log around ProcessMonitor thread shutting down.

2.3.12 - 2025-05-16

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.

Fixed

  • NgrokV2CDNUrl and NgrokV3CDNUrl both improperly defined the constant for Apple Silicon as DARWIN_i386_arm. It has been renamed to DARWIN_x86_64_arm.

2.3.11 - 2025-05-11

Added

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

Changed

  • NgrokLog.lvl now consistently parses ERR, EROR, and CRIT to ERROR instead of SEVERE.

Fixed

  • Refactored concurrency around ProcessMonitor and startup logging, as the old design could lead to race conditions when startup errored.
  • NgrokLog string may contain a malformed or empty lvl. Default is now NOTSET in such cases.

2.3.10 - 2025-05-07

Added

  • Support for pooling_enabled in CreateTunnel, which allows for the use of https and tls Internal Endpoints.
  • Stability improvements around concurrency, process execution.
  • Documentation improvements.
  • Test improvements.

2.3.9 - 2025-04-23

Added

  • Deprecation warning when using Labeled Tunnels, since ngrok Edges will be sunset December 31st, 2025. See this issue for more details.
  • Migrate build from OSSRH to Central publishing.
  • Updates to Maven Central badge links.
  • Documentation improvements.
  • Build improvements.

2.3.8 - 2025-03-16

Added

  • DefaultHttpClient now respects retryCount, so API GET operations also retry if configured.

Fixed

  • process and processMonitor are no longer set to null when NgrokProcess.stop() is called, as this was error prone behavior that also suppressed useful information.

2.3.7 - 2025-02-18

Added

  • Documentation improvements.

2.3.6 - 2025-01-28

Added

  • Documentation improvements.

2.3.5 - 2025-01-08

Added

  • Support for ngrok config version 3.
  • Support for traffic_policy tunnel definition, which ngrok renamed from policy.
  • Support for traffic_policy.on_http_request and traffic_policy.on_http_response, which ngrok added unique keys for in HTTP tunnels.
  • If a value for apiKey is not set in JavaNgrokConfig, it will attempt to use the environment variable NGROK_API_KEY if it is set.

Remove

  • Tunnel definition fields hostname and client_cas, as they are no longer supported by ngrok.

2.3.4 - 2024-12-13

Added

  • Test improvements.

Changed

  • Permission for installed binary to limit execute to user.

2.3.3 - 2024-11-10

Added

  • Documentation improvements.

2.3.2 - 2024-11-08

Added

  • Documentation improvements.

Fixed

2.3.1 - 2024-11-04

Added

  • Documentation improvements update links to ngrok's documentation.
  • Test improvements.

2.3.0 - 2024-04-08

Added

  • Support for domain configuration when building CreateTunnel.
  • Support for user_agent_filter configuration when building CreateTunnel.
  • Support for policy configuration when building CreateTunnel.
  • us-cal-1 to Region.
  • Test cases for TLS tunnels.
  • Build improvements.

Fixed

  • ngrok config value ip_restriction was incorrectly plural in previous versions of java-ngrok. Value is now interpreted as singular to align with the ngrok docs, and classes and methods associated with it, like TunnelIPRestriction, have been renamed.

2.2.16 - 2024-03-24

Added

  • Build and stability improvements.

2.2.15 - 2024-03-08

Added

  • obj parsing in NgrokLog.
  • throws for unchecked exceptions to documentation.
  • Documentation improvements.
  • Build and stability improvements.

Fixed

2.2.14 - 2024-03-06

Added

  • Build and stability improvements.
  • Documentation and style improvements.

2.2.13 - 2024-02-26

Added

  • Build improvements.
  • Documentation improvements.

2.2.12 - 2024-02-18

Added

  • Build and stability improvements.

2.2.10 - 2024-02-15

Changed

  • Moved evaluation of HTTP GET retry logic from DefaultHttpClient's getInputStream() to get().
  • Build and stability improvements.

2.2.9 - 2024-02-14

Added

  • Stability improvements.

2.2.8 - 2024-01-08

Added

  • Support for Java 21.
  • Build improvements.

2.2.7 - 2023-12-30

Fixed

  • Test improvements, suite now respects NGROK_AUTHTOKEN for all necessary tests (skipped if not set, rather than tests failing).

2.2.6 - 2023-12-27

Added

  • If a value for authToken is not set in JavaNgrokConfig, it will attempt to use the environment variable NGROK_AUTHTOKEN if it is set.
  • Build improvements.

2.2.5 - 2023-12-01

Changed

Fixed

  • Build improvements.

2.2.4 - 2023-11-14

Added

  • Documentation improvements.

2.2.3 - 2023-09-17

Added

  • retryCount added to DefaultHttpClient, so GET options can now support retries.
  • Documentation improvements.
  • Test improvements.

Changed

  • NgrokInstaller now uses the DefaultHttpClient to download ngrok binaries.

2.2.2 - 2023-09-14

Added

  • Documentation improvements.

2.2.1 - 2023-09-13

Fixed

  • Bug in Tunnel, a misspelled method was committed instead of using setters to update publicUrl and proto.

2.2.0 - 2023-09-12

Added

2.1.0 - 2023-04-22

Added

  • Support for oauth configuration when building CreateTunnel.
  • Support for other new ngrok v3 CreateTunnel parameters, including circuit_breaker, compression, mutual_tls_cas, proxy_proto, websocket_tcp_converter, terminate_at, request_header, response_header, ip_restrictions, and verify_webhook.
  • Documentation improvements.
  • Test improvements.

2.0.0 - 2023-04-12

Changed

  • Default installer behavior downloads ngrok v3 by default.
  • Documentation updates.
  • Test updates.

1.7.2 - 2023-04-12

Added

  • Support for basic_auth parameter in ngrok v3.
  • Documentation improvements.
  • Test improvements.

1.7.1 - 2023-04-11

Fixed

  • Inconsistencies with default installation of ngrok v2.

1.7.0 - 2023-04-11

Added

  • ngrokVersion to CreateTunnel so parameter details can be properly inferred when necessary.

Fixed

  • Inconsistencies with default installation of ngrok v2.
  • Documentation improvements.
  • Test improvements.

1.6.2 - 2023-03-08

Fixed

  • Issue where zip file paths were not normalized before they were read.
  • Documentation improvements.
  • Test improvements.

1.6.1 - 2022-11-29

Fixed

  • Stability improvements.

1.6.0 - 2022-11-28

Added

  • Support for ngrok v3 (v2 is still used by default).
  • Documentation and examples for using java-ngrok with ngrok v3.

Fixed

  • Stability improvements.
  • Documentation improvements.
  • Test improvements.

1.5.6 - 2022-02-07

Added

  • Darwin 64-bit ARM support, as this was added to ngrok itself.

Removed

  • Darwin 386 support, as this was removed from ngrok itself.

1.5.5 - 2021-09-28

Fixed

  • Full ngrok log line now passed to Java logger (was previously just the msg field).

1.5.4 - 2021-09-21

Added

  • Test improvements.

Fixed

  • Parse issue from ngrok config file with inspect and bind_tls in tunnels definitions.

1.5.3 - 2021-08-26

Added

  • Build improvements.
  • Documentation improvements.

Fixed

  • If no configPath is set in JavaNgrokConfig, now properly defaults to ~/.ngrok2/ngrok.yml.

1.5.0 - 2021-08-25

Added

  • Shutdown hook, so running ngrok processes will clean themselves when the JVM shuts down.
  • Build improvements.
  • Documentation improvements.
  • Test improvements.

Removed

  • Java 8 support.
  • reconnectSessionRetries from JavaNgrokConfig, instead relying on ngrok's own built-in retry mechanism on startup fails.

1.4.x

The 1.4.x branch is where support for Java 8 of java-ngrok was maintained. It is available through the java8-ngrok artifact on Maven Central.

1.4.20

Fixed

  • ngrok CDN URLs updated from bin.equinox.io to bin.ngrok.com.
  • Linux and FreeBSD downloads now use .tgz archives instead of .zip.

1.4.19 - 2025-05-16

Added

  • Documentation improvements.

Fixed

  • Noisy log around ProcessMonitor thread shutting down.

1.4.17 - 2025-05-16

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.

Fixed

  • NgrokV2CDNUrl and NgrokV3CDNUrl both improperly defined the constant for Apple Silicon as DARWIN_i386_arm. It has been renamed to DARWIN_x86_64_arm.

1.4.16 - 2025-05-11

Added

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

Changed

  • NgrokLog.lvl now consistently parses ERR, EROR, and CRIT to ERROR instead of SEVERE.

Fixed

  • Refactored concurrency around ProcessMonitor and startup logging, as the old design could lead to race conditions when startup errored.
  • NgrokLog string may contain a malformed or empty lvl. Default is now NOTSET in such cases.

1.4.15 - 2025-05-07

Added

  • Support for pooling_enabled in CreateTunnel, which allows for the use of https and tls Internal Endpoints.
  • Stability improvements around concurrency, process execution.
  • Documentation improvements.
  • Test improvements.

1.4.14 - 2025-04-23

Added

  • Rebased the 1.4.x branch with Java 8-compatible changes from main between 2.2.15 and 2.3.9. See the main changelog for full details.
  • Biggest changes include support for ngrok's v3 config (including traffic_policy), support for latest fields in tunnel definitions, ip_restriction
  • Deprecation warning when using Labeled Tunnels, since ngrok Edges will be sunset December 31st, 2025. See this issue for more details.

Fixed

  • ip_restriction was incorrectly plural, config and class are now singular to match ngrok.

1.4.13 - 2024-03-08

Added

  • obj parsing in NgrokLog.
  • throws for unchecked exceptions to documentation.
  • Documentation improvements.
  • Build and stability improvements.

Fixed

1.4.12 - 2024-03-06

Added

  • Build and stability improvements.
  • Documentation and style improvements.

1.4.11 - 2024-02-26

Added

  • Build improvements.
  • Documentation improvements.

1.4.8 - 2024-02-19

Added

  • Rebased the 1.4.x branch with Java 8-compatible changes from main between 1.6.0 and 2.2.12. See the main changelog for full details.
  • Biggest change is support for ngrok v3—including labels—and that ngrok v3 is installed by default.

Removed

  • NgrokProcess.stopMonitorThread(), use NgrokProcess.ProcessMonitor.stop() instead.

1.4.6 - 2024-02-15

Added

  • If a value for authToken is not set in JavaNgrokConfig, it will attempt to use the environment variable NGROK_AUTHTOKEN if it is set.
  • Test improvements, suite now respects NGROK_AUTHTOKEN for all necessary tests (skipped if not set, rather than tests failing).
  • Build and stability improvements.

Fixed

  • Issue where zip file paths were not normalized before they were read.

1.4.5 - 2022-02-07

Added

  • Darwin 64-bit ARM support, as this was added to ngrok itself.

Removed

  • Darwin 386 support, as this was removed from ngrok itself.

1.4.4 - 2021-09-28

Added

  • Test improvements.

Fixed

  • Parse issue from ngrok config file with inspect and bind_tls in tunnels definitions.
  • Full ngrok log line now passed to Java logger (was previously just the msg field).

1.4.3 - 2021-08-26

Added

  • Build improvements.
  • Documentation improvements.

Fixed

  • If no configPath is set in JavaNgrokConfig, now properly defaults to ~/.ngrok2/ngrok.yml.

1.4.0 - 2021-08-25

Added

  • Java 8 support, which will not be actively maintained. It is available through the java8-ngrok artifact on Maven Central.

1.1.0 - 2021-08-20

Added

Fixed

  • JavaNgrokConfig.keepMonitoring is now true by default (was already documented this way, so fixing bug where it defaulted it false).
  • Serialization of ngrok's ngrok.yml (can now properly parsed nested YAML to a nested Map).
  • Tunnel.Metrics rate and p fields are now doubles rather than ints, so they serialize correctly when populated.

1.0.0 - 2021-08-18

  • First stable release of java-ngrok.