How to Expose a Local Server to the Internet with ngrok
- Published on
- • 5 mins read•––– views
There are several methods for exposing a local server, each serving different purposes. One tool that’s been on my radar is ngrok.
Why use ngrok for exposing a local server?
Problem
During local development, we often face the need to expose our server to the internet. This is especially important for testing webhooks or enabling remote access to our applications. So, how can we easily set up a secure public-facing server?
Many third-party services that require callbacks or notifications use HTTPS and expect your server to be publicly accessible. This can present challenges, particularly when your development environment is behind a firewall or NAT.
To address this issue, we can use ngrok—a powerful tool that creates a secure tunnel from your local machine to the internet, allowing you to easily expose your local server with a public URL.
Solution
ngrok simplifies this process by creating a secure tunnel to your localhost, giving you a public URL that can be accessed over the internet.
Stay with me as I guide you through the steps to set up and use ngrok.
Install ngrok
To get started with ngrok, download and install it from the official website. Choose the appropriate version for your operating system and unzip the file.
On macOS and Linux, you can install ngrok using the following commands:
brew install ngrok/ngrok/ngrok
Or, you can download it manually and unzip it:
unzip /path/to/ngrok.zip
Move the extracted ngrok binary to a directory in your PATH for easy access:
mv /path/to/ngrok /usr/local/bin
Authenticate Your ngrok Account
After installation, sign up for a free ngrok account and obtain your authentication token. This step is crucial for accessing additional features and managing your tunnels.
Authenticate ngrok with your token:
ngrok config add-authtoken YOUR_AUTH_TOKEN
Create a Tunnel
To expose your local server, start a tunnel with ngrok. Specify the protocol and port your server is running on. For example, if your server is running on http://localhost:3000, use the following command:
ngrok http 3000
ngrok will generate a public URL that points to your local server. You can use this URL to access your server from anywhere, test webhooks, or share with remote clients.
Access and Monitor the Tunnel
Once the tunnel is active, ngrok provides a public URL (e.g., https://example.ngrok-free.app) that you can share with others or use for testing. You can also view real-time request logs and response details on the ngrok dashboard at http://localhost:4040.
The dashboard provides valuable insights into the requests being forwarded to your local server, making it easier to debug and test your application.
Using a Static Domain
For consistency in your development workflow, use a static domain. Create a static domain via the ngrok dashboard, then run:
ngrok http 3000 --domain your-static-domain.ngrok.app
Securing Your Application
- ngrok - Secure introspectable tunnels to localhost
- Getting Started with ngrok application, use ngrok’s authentication features. For Google OAuth:
ngrok http http://localhost:3000 --oauth=google --oauth-allow-email=your-email@example.com
For basic authentication:
ngrok http http://localhost:3000 --basic-auth 'username:secure-password'
Running ngrok Persistently
To keep ngrok running persistently, consider these options:
- Docker: Containerize ngrok for easy deployment. Refer to Docker configuration.
- Systemd service (Linux): Set up a systemd service for automatic startup. See Systemd service creation.
- Windows service (Windows): Create a Windows service for ngrok. Refer to Windows service documentation.
- Tmux (optional): Use Tmux for sessTabItemion management if you're familiar with it.
Practical Use Cases
Webhook Development
ngrok is indispensable for developing and testing webhooks. It allows you to receive real-time callbacks from external services without deploying your server to the public internet.
Remote Access
ngrok provides a secure and straightforward way to access your local applications from anywhere, making it ideal for demonstrations or remote collaborations.
Conclusion
ngrok simplifies the process of exposing local servers to the internet, providing a secure and efficient solution for developers. Whether you're testing webhooks, accessing applications remotely, or requiring HTTPS in development, ngrok offers an invaluable service.
Thank you for readng and happy tunneling!