It's a very cool tool that lets you expose a local webserver to the outside world (internet)- in short, it creates a secure tunnel on your local machine along with a public URL that you can use or give to your colleagues, friends, etc. for browsing or testing your local site.
Go through this to know more about it: https://ngrok.com/docs
I have used this where I wanted to expose my local running Jenkins to git for the webhook part.
1) Using Java (Lengthy way) : Create a utility and use it:>> import java.io.BufferedOutputStream; import org.openqa.selenium.io.Zip; import java.io.File; import java.io.FileInputStream; import java.io.FileOutputStream; import java.io.IOException; import java.util.zip.ZipEntry; import java.util.zip.ZipInputStream; public class UnzipUtil { private static final int BUFFER_SIZE = 4096; public void unzip (String zipFilePath, String destDirectory) throws IOException { File destDir = new File(destDirectory); if (!destDir.exists()) { destDir.mkdir(); } ZipInputStream zipIn = new ZipInputStream(new FileInputStream(zipFilePath)); ZipEntry entry = zipIn.getNextEntry(); // to iterates over entries in the zip folder while (entry != null) { String filePath = destDirectory + File.separator + entry.getName(); if (!entry.isDirectory()) { extractFile (zipIn, filePath);
Thanks for the nice information. I used it to expose my localhost URL (localhost:8080) on Jenkins to Git. From GIT, I wanted to send a push request to http://localhost:8080/github-webhook/
ReplyDeleteWith localhost in URL we would normally get an error that "We couldn't deliver this payload". To overcome this we need to provide a public IP address and this is where ngrok would come in handy.
Mentioning below some of the steps:
1. Download ngrok
2. Run the .exe.
3. Type ngrok http 8080 (8080 is where Jenkins is running)
4. You will get an URL something like: 56139657bf53.ngrok.io , note that this is the substitute of localhost:8080.
5. In your WebHook settings on git replace http://localhost:8080/github-webhook/ with http://56139657bf53.ngrok.io/github-webhook/ (no need to add 8080 again)
6. Save it and you should be good to go.
Point to note:
1) Include "/" at the end of URL to avoid any issue
2) For the generated link to work please keep the terminal window of ngrok open. Each time the terminal window is reopened it would generate a new link so keep it open to avoid any errors.
3)Ensure that service (Jenkins in this case) should be running on the URL/port specified , else it would give an error.
Thanks!
Thanks Namit for the detailed info. This should help others.
Delete