Documentation
Learn how to use Burrow to create secure tunnels to your local development environment
Getting Started
Installation
Install Burrow client using one of the following methods:
Linux / macOS
curl -sSL https://moleburrow.com/install.sh | bash
Windows (PowerShell)
iwr https://moleburrow.com/install.ps1 | iex
Manual Download
Visit the Download page to download binaries for your platform.
Authentication
Before using Burrow, you need to authenticate with your account:
- Sign up or log in at moleburrow.com
- Go to your Profile page
- Copy your authorization token
- Run the authentication command:
burrow --auth
Paste your token when prompted. Your credentials will be securely stored in ~/.burrow/credentials
Basic Usage
Once authenticated, you can create a tunnel with a simple command:
burrow <port> <subdomain>
Example:
burrow 3000 myapp
This will create a tunnel from https://myapp.moleburrow.com to your local service running on port 3000.
Alternative Syntax
You can also use flags:
burrow -port 3000 -subdomain myapp
Advanced Options
Custom Client ID
burrow 3000 myapp -client-id my-custom-id
Specify a custom client identifier (auto-generated by default)
Multiple Connections
burrow 3000 myapp -connections 4
Use multiple parallel connections (1-4) for better performance (default: 2)
Tunnel Configuration
Configure your tunnels through the web dashboard:
- Basic Authentication: Protect your tunnel with username/password
- IP Whitelisting: Restrict access to specific IP addresses
- Enable/Disable: Turn tunnels on or off without deleting them
HTTP Request Inspection
Monitor and debug HTTP traffic in real-time using the HTTP Inspector:
- View all incoming HTTP requests and responses
- Inspect headers, body, and status codes
- Replay requests with or without modifications
- Edit and resend requests for testing
Visit the HTTP Inspector to start monitoring your tunnels.
Troubleshooting
Authentication Errors
If you see authentication errors, refresh your credentials:
burrow --auth
Connection Issues
Ensure your local service is running and accessible on the specified port.
Subdomain Already in Use
Choose a different subdomain or delete the existing tunnel from your dashboard.
Need Help?
If you encounter any issues or have questions:
- Check your tunnel status in the Dashboard
- Review the troubleshooting section above
- Contact support through your account settings