https://github.com/migangqui/localhost-run-spring-boot-starter

localhost.run Spring Boot Starter
https://github.com/migangqui/localhost-run-spring-boot-starter

Last synced: 8 days ago
JSON representation

localhost.run Spring Boot Starter

• Host: GitHub
• URL: https://github.com/migangqui/localhost-run-spring-boot-starter
• Owner: migangqui
• Created: 2020-09-15T15:14:11.000Z (over 4 years ago)
• Default Branch: master
• Last Pushed: 2023-09-28T10:22:52.000Z (about 1 year ago)
• Last Synced: 2023-09-28T12:02:16.774Z (about 1 year ago)
• Language: Java
• Size: 33.2 KB
• Stars: 2
• Watchers: 2
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# localhost.run Spring Boot Starter

![GitHub last commit](https://img.shields.io/github/last-commit/migangqui/localhost-run-spring-boot-starter?style=for-the-badge)

![Maven Central](https://img.shields.io/maven-central/v/com.github.migangqui/localhost-run-spring-boot-starter?style=for-the-badge)

Spring Boot Starter to share your localhost Spring Application with an external url.

## What is localhost.run?

localhost.run is an SSH server just for remote port forwarding. When a user connects to localhost.run, they get a public URL that anybody can use to connect to their localhost server.

## How works this starter?

When you add this dependency to your pom.xml and configure it, you'll automatically get a public url to your local server in application logs:

 ```

Remote access to application with url https://abcd1234.lhr.life

```

 ## Dependency

 

Actual version is 3.0

 

 * Maven:

 ```xml

    com.github.migangqui

    localhost-run-spring-boot-starter

    3.0

```

* Gradle:

 ```groovy

implementation 'com.github.migangqui:localhost-run-spring-boot-starter:3.0'

```

https://mvnrepository.com/artifact/com.github.migangqui/localhost-run-spring-boot-starter

## Configuration

You must enable localhost.com runner adding the following property:

```yaml

localhost-run:

    enabled: true

```

By default, the subdomain to generate URL is *lhr.life*.

If **localhost.run** changes its subdomain, we can set by property:

```yaml

localhost-run:

    subdomain: lhr.life

```

### References

* Based in similar ngrok starter: https://github.com/kilmajster/ngrok-spring-boot-starter

* https://localhost.run/