dmanchon/ngrok-java-client

Download

Step 1. Add the JitPack repository to your build file

Add it in your root settings.gradle at the end of repositories:

	dependencyResolutionManagement {
		repositoriesMode.set(RepositoriesMode.FAIL_ON_PROJECT_REPOS)
		repositories {
			mavenCentral()
			maven { url 'https://jitpack.io' }
		}
	}

Add it in your settings.gradle.kts at the end of repositories:

	dependencyResolutionManagement {
		repositoriesMode.set(RepositoriesMode.FAIL_ON_PROJECT_REPOS)
		repositories {
			mavenCentral()
			maven { url = uri("https://jitpack.io") }
		}
	}

Add to pom.xml

	<repositories>
		<repository>
		    <id>jitpack.io</id>
		    <url>https://jitpack.io</url>
		</repository>
	</repositories>

Add it in your build.sbt at the end of resolvers:

 
    resolvers += "jitpack" at "https://jitpack.io"

Add it in your project.clj at the end of repositories:

 
    :repositories [["jitpack" "https://jitpack.io"]]

Step 2. Add the dependency

	dependencies {
		implementation 'com.github.dmanchon:ngrok-java-client:0.1-SNAPSHOT'
	}
	dependencies {
		implementation("com.github.dmanchon:ngrok-java-client:0.1-SNAPSHOT")
	}
	<dependency>
	    <groupId>com.github.dmanchon</groupId>
	    <artifactId>ngrok-java-client</artifactId>
	    <version>0.1-SNAPSHOT</version>
	</dependency>

                            
    libraryDependencies += "com.github.dmanchon" % "ngrok-java-client" % "0.1-SNAPSHOT"
        
        

                            
    :dependencies [[com.github.dmanchon/ngrok-java-client "0.1-SNAPSHOT"]]

Readme

ngrok-java-client

  • For example jitpack can be used to get the dependecy from a github repo:
<repositories>
  <repository>
      <id>jitpack.io</id>
      <url>https://jitpack.io</url>
  </repository>
</repositories>
  • Include the dependency:
<dependency>
    <groupId>com.github.dmanchon</groupId>
    <artifactId>ngrok-java-client</artifactId>
    <version>0.1-SNAPSHOT</version>
</dependency>
  • Start ngrok:
$ ngrok start --none
  • Usage:
    ...
    import xyz.dmanchon.ngrok.client.NgrokTunnel;
    ...

    //Start tunnel, ngrok address is default
    NgrokTunnel tunnel = new NgrokTunnel(8080);

    //Start tunnel, explicit ngrok address
    NgrokTunnel tunnel = new NgrokTunnel("http://127.0.0.1:4040", 8080);

    ...

    //Get the public url:
    String url = tunnel.url();

    //Close the tunnel:
    tunnel.close();