Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/migangqui/spring-boot-starter-serveo

Spring Boot Starter to share your localhost Spring Application with an external url.
https://github.com/migangqui/spring-boot-starter-serveo

Last synced: 8 days ago
JSON representation

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

Awesome Lists containing this project

README

        

# Serveo Spring Boot Starter (DEPRECATED)

### SERVEO not exists nowadays.

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

## What is Serveo?

From the official website, Serveo is an SSH server just for remote port forwarding. When a user connects to Serveo, 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.

## Dependency

Actual version is 1.1

* Maven:
```xml

com.github.migangqui
serveo-spring-boot-starter
1.0

```

* Gradle:
```xml
compile('com.github.migangqui:serveo-spring-boot-starter:1.0')
```

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

## Configuration

You must enable Serveo runner adding the following property:
```yaml
serveo:
enabled: true
```

As optional property, you can choose a subdomain:
```yaml
serveo:
custom:
domain: mysubdomain
```

### References

* Based in similar ngrok starter: https://github.com/kilmajster/ngrok-spring-boot-starter
* http://serveo.net/#manual

### Disclaimer

ArtifactId has been modified from spring-boot-starter-serveo to serveo-spring-boot-starter to follow Spring instruction starters naming
https://docs.spring.io/spring-boot/docs/2.0.0.M5/reference/html/boot-features-developing-auto-configuration.html#boot-features-custom-starter-naming