Skip to content

Latest commit

 

History

History
467 lines (290 loc) · 17.1 KB

CHANGELOG.md

File metadata and controls

467 lines (290 loc) · 17.1 KB
Raw

Changelog

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

This project adheres to Semantic Versioning.

Unreleased

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 is passively maintained. It is available through the java8-ngrok artifact on Maven Central.

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.