https://github.com/linux-china/ngrok-spring-boot-starter

Easy to expose a local Spring Boot Application to the internet by ngrok
https://github.com/linux-china/ngrok-spring-boot-starter

ngrok

Last synced: 6 months ago
JSON representation

Easy to expose a local Spring Boot Application to the internet by ngrok

• Host: GitHub
• URL: https://github.com/linux-china/ngrok-spring-boot-starter
• Owner: linux-china
• Created: 2017-09-11T05:12:07.000Z (about 8 years ago)
• Default Branch: master
• Last Pushed: 2017-09-11T06:36:21.000Z (about 8 years ago)
• Last Synced: 2025-04-02T02:51:12.405Z (6 months ago)
• Topics: ngrok
• Language: Java
• Homepage:
• Size: 417 KB
• Stars: 23
• Watchers: 5
• Forks: 5
• Open Issues: 1
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

          
ngrok-spring-boot-start

=========================

Spring boot starter for ngrok, easy to expose a local Spring Boot Application to the internet

![ngrok with spring boot](.README_images/ngrok-starter.png)

### Usage

* Start local ngrok tunnels： ngrok start --none

* Add ngrok-spring-boot-starter in your pom.xml:

```xml

          

                     com.mvnsearch.spring.boot

                     ngrok-boot-starter

                     1.0.0-SNAPSHOT

          

```

* Get public url for spring boot application:

    

    * ngrok web inspection http://localhost:4040  or ngrok terminal console

    * ngrok endpoint in spring boot application: http://localhost:8080/ngrok

    * public url output in Spring Boot console

### Functions

* ngrok web inspection: http://localhost:4040

* Inspecting your traffic

* Replaying requests

### how it works

The starter automate ngrok via API(http://127.0.0.1:4040/api/)

### References

* ngrok: https://ngrok.com/