https://github.com/stupside/moley
https://github.com/stupside/moley
access cli cloudflare cloudflared go localhost proxy tunnel zerotrust
Last synced: about 1 month ago
JSON representation
- Host: GitHub
- URL: https://github.com/stupside/moley
- Owner: stupside
- License: mit
- Created: 2025-06-29T01:18:33.000Z (8 months ago)
- Default Branch: main
- Last Pushed: 2025-12-16T13:04:41.000Z (2 months ago)
- Last Synced: 2025-12-20T03:20:17.146Z (about 2 months ago)
- Topics: access, cli, cloudflare, cloudflared, go, localhost, proxy, tunnel, zerotrust
- Language: Go
- Homepage: http://moley.dev/
- Size: 7.98 MB
- Stars: 85
- Watchers: 1
- Forks: 1
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Security: SECURITY.md
Awesome Lists containing this project
README
# Moley
**Turn localhost into production URLs with one command.**
[Cloudflare Tunnels](https://developers.cloudflare.com/cloudflare-one/connections/connect-networks/) are free, unlimited, and enterprise-grade but the manual setup (YAML editing, DNS commands for each subdomain and manual cleanup) is so tedious that developers turn to paid alternatives just to avoid the friction.
Moley automates everything so you get all the Cloudflare benefits on your custom domain without the manual work.
## What Moley Does
### Without Moley (manual cloudflared setup)
```bash
# 1. Authenticate with Cloudflare
cloudflared tunnel login
# 2. Create tunnel manually
cloudflared tunnel create my-tunnel
# 3. Configure tunnel YAML file with ingress rules
vim ~/.cloudflared/config.yml
# (figure out tunnel ID, credentials path, hostnames, services, catch-all rule...)
# 4. Route DNS via CLI for each subdomain
cloudflared tunnel route dns my-tunnel api.example.com
cloudflared tunnel route dns my-tunnel app.example.com
# (repeat for every subdomain... wait for DNS propagation...)
# 5. Run tunnel
cloudflared tunnel run my-tunnel
# 6. Manually delete tunnel and DNS records from dashboard when done
# (or forget and accumulate zombie tunnels...)
```
### With Moley
```bash
moley tunnel run
```
**That's it.** Moley handles everything automatically:
- ✅ **Authenticates** with Cloudflare API
- ✅ **Creates tunnels** programmatically
- ✅ **Generates config** with ingress rules (no YAML editing)
- ✅ **Creates DNS records** for all subdomains (no CLI gymnastics)
- ✅ **Runs tunnel** in foreground or background (`--detach`)
- ✅ **Cleans up** tunnels and DNS when stopping (no zombie tunnels)
One command. Multiple apps. Zero manual configuration.
## 📦 Installation
### Homebrew (Recommended)
```bash
brew install --cask stupside/tap/moley
```
### Go Install
```bash
go install github.com/stupside/moley@latest
```
### Manual Download
Download the latest binary from the [releases page](https://github.com/stupside/moley/releases/latest).
## 🚀 Quick Start
1. **Authentication**
```bash
# Authenticate cloudflared with your account
cloudflared tunnel login
# Option 1: Set API token in config file
moley config set --cloudflare.token="your-api-token"
# Option 2: Use environment variable (recommended for CI/CD)
export MOLEY_CLOUDFLARE_TOKEN="your-api-token"
```
2. **Initialize your project**
```bash
moley tunnel init
```
3. **Configure your apps**
```bash
# Option 1: Edit the generated moley.yml file
# Option 2: Use environment variables (great for containers/CI)
export MOLEY_TUNNEL_INGRESS_ZONE="yourdomain.com"
export MOLEY_TUNNEL_INGRESS_APPS_0_TARGET_PORT="8080"
export MOLEY_TUNNEL_INGRESS_APPS_0_EXPOSE_SUBDOMAIN="api"
```
4. **Start tunneling**
```bash
# Foreground mode
moley tunnel run
# Background mode
moley tunnel run --detach
# Or run with everything configured via environment variables
MOLEY_CLOUDFLARE_TOKEN="token" MOLEY_TUNNEL_INGRESS_ZONE="yourdomain.com" moley tunnel run
```
Your app is now accessible at `https://api.yourdomain.com`! 🎉
> 💡 **Pro tip**: Environment variables take precedence over config files and are perfect for CI/CD, Docker containers, and keeping secrets secure.
## 📚 Documentation
For complete documentation including configuration options, troubleshooting, and advanced usage, visit our [documentation site](https://stupside.github.io/moley).
### Quick Links
- 📖 **[Installation Guide](https://stupside.github.io/moley/docs/installation/)** - Detailed installation instructions
- ⚡ **[Quick Start](https://stupside.github.io/moley/docs/quick-start/)** - Get up and running in minutes
- ⚙️ **[Configuration](https://stupside.github.io/moley/docs/configuration/)** - Advanced configuration options
- 🔧 **[Troubleshooting](https://stupside.github.io/moley/docs/troubleshooting/)** - Common issues and solutions
## 🛠️ Development
### Prerequisites
- Go 1.23+
- [Cloudflared](https://developers.cloudflare.com/cloudflare-one/connections/connect-networks/downloads/) installed
### Building from Source
```bash
git clone https://github.com/stupside/moley.git
cd moley
go mod download
go build -o moley .
```
### Contributing
We welcome contributions! Please see our [Contributing Guide](CONTRIBUTING.md) for details.
## 📄 License
This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
## 🙏 Acknowledgments
- [Cloudflare](https://cloudflare.com) for providing the tunnel infrastructure
- [Cloudflared](https://github.com/cloudflare/cloudflared) team for the tunnel client