This Quarkus extension integrates ngrok into Quarkus Dev Mode thus allowing users to expose their application to the public internet while they are still developing it.
[!IMPORTANT]
NOTE: The extension has absolutely no impact on the production Quarkus application
Read the full Ngrok documentation.
quarkus ext add io.quarkiverse.ngrok:quarkus-ngrok
./mvnw quarkus:add-extension -Dextensions="io.quarkiverse.ngrok:quarkus-ngrok"
Get a ngrok auth token and configure it using ngrok or set it via quarkus.ngrok.auth-token
A short while after the application has started, you should see something in the application logs like:
ngrok is running and its web interface can be accessed at: 'http://localhost:4040'
The application can be accessed publicly over the internet using: 'http://4f59-68-81-186-238.ngrok-free.app'
For further instructions and tips to run using stable domains and additional config see https://docs.quarkiverse.io/quarkus-ngrok/dev/
Thanks goes to these wonderful people (emoji key):
Georgios Andrianakis 💻 🚧 |
Melloware 💻 🚧 |
zakhdar 📖 |
Max Rydahl Andersen 💻 |
Phillip Krüger 💻 |
Kevin Wooten 🐛 |
Sergey Beryozkin 🤔 |
Žan Magerl 📖 |
Stéphane Épardaud 📖 |
This project follows the all-contributors specification. Contributions of any kind welcome!