Fixing default ngrok.yml config path.

alexdlaird · Aug 26, 2021 · 9cf15f4 · 9cf15f4
1 parent 6da0870
commit 9cf15f4
Show file tree

Hide file tree

Showing 3 changed files with 8 additions and 5 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -3,13 +3,16 @@ All notable changes to this project will be documented in this file.
 
 This project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
-## [Unreleased](https://github.com/alexdlaird/java-ngrok/compare/1.5.2...HEAD)
+## [Unreleased](https://github.com/alexdlaird/java-ngrok/compare/1.5.3...HEAD)
 
-## [1.5.2](https://github.com/alexdlaird/java-ngrok/compare/1.5.0...1.5.2) - 2021-08-26
+## [1.5.3](https://github.com/alexdlaird/java-ngrok/compare/1.5.0...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](https://github.com/alexdlaird/java-ngrok/compare/1.1.0...1.5.0) - 2021-08-25
 ### Added
 - Shutdown hook, so running `ngrok` processes will clean themselves when the JVM shuts down.
@@ -30,7 +33,7 @@ This project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.htm
 
 ### 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 `config.yml` (can now properly parsed nested YAML to a nested Map).
+- Serialization of `ngrok`'s `ngrok.yml` (can now properly parsed nested YAML to a nested Map).
 - `Tunnel.Metrics` `rate` and `p` fields are now `double`s rather than `int`s, so they serialize correctly when populated.
 
 ## [1.0.0](https://github.com/alexdlaird/java-ngrok/releases/tag/1.0.0) - 2021-08-18

diff --git a/src/main/java/com/github/alexdlaird/ngrok/conf/JavaNgrokConfig.java b/src/main/java/com/github/alexdlaird/ngrok/conf/JavaNgrokConfig.java
@@ -172,7 +172,7 @@ public Builder withNgrokPath(final Path ngrokPath) {
         }
 
         /**
-         * The path to the <code>ngrok</code> config file, defaults to <code>~/.ngrok2/config.yml</code>.
+         * The path to the <code>ngrok</code> config file, defaults to <code>~/.ngrok2/ngrok.yml</code>.
          */
         public Builder withConfigPath(final Path configPath) {
             this.configPath = configPath;

diff --git a/src/main/java/com/github/alexdlaird/ngrok/installer/NgrokInstaller.java b/src/main/java/com/github/alexdlaird/ngrok/installer/NgrokInstaller.java
@@ -76,7 +76,7 @@ public class NgrokInstaller {
     public static final String FREEBSD = "FREEBSD";
     public static final List<String> UNIX_BINARIES = List.of(MAC, LINUX, FREEBSD);
     public static final Path DEFAULT_NGROK_PATH = Paths.get(System.getProperty("user.home"), ".ngrok2", NgrokInstaller.getNgrokBin());
-    public static final Path DEFAULT_CONFIG_PATH = Paths.get(System.getProperty("user.home"), ".ngrok2", "config.yml");
+    public static final Path DEFAULT_CONFIG_PATH = Paths.get(System.getProperty("user.home"), ".ngrok2", "ngrok.yml");
 
     private static final List<String> VALID_LOG_LEVELS = List.of("info", "debug");