opentunnel-cli 1.0.23 → 1.0.26

package/README.md

@@ -1,6 +1,6 @@
 <h1 align="center">OpenTunnel</h1>
 
-<p align="center">Self-hosted alternative to ngrok. Expose local services to the internet with custom subdomains.</p>
+<p align="center">Self-hosted alternative to ngrok. Expose local services to the internet with custom subdomains, or use ngrok/Cloudflare Tunnel.</p>
 
 ---
 
@@ -38,6 +38,9 @@ opentunnel server -d --domain example.com --letsencrypt --email admin@example.co
 
 # Private server (with auth)
 opentunnel server -d --domain example.com --letsencrypt --email admin@example.com --auth-tokens "SECRET"
+
+# Custom port (if 8080/443 is occupied)
+opentunnel server -d --domain example.com --port 8443 --letsencrypt --email admin@example.com --auth-tokens "SECRET"
 ```
 
 **DNS Setup:** Point `op.example.com` and `*.op.example.com` to your server IP.
@@ -54,6 +57,42 @@ opentunnel setdomain yourdomain.com
 opentunnel expl 3000
 ```
 
+### Using ngrok or Cloudflare Tunnel
+
+Don't have a server? Use third-party tunnel providers:
+
+```bash
+# With Cloudflare Tunnel (free, no account needed for quick tunnels)
+opentunnel http 3000 --cloudflare
+opentunnel http 3000 --cf
+
+# With ngrok
+opentunnel http 3000 --ngrok
+opentunnel http 3000 --ngrok --region eu
+```
+
+### Authentication & Named Tunnels
+
+Store credentials securely and manage Cloudflare named tunnels:
+
+```bash
+# Login to providers
+opentunnel login cloudflare       # Opens browser for OAuth
+opentunnel login ngrok --token YOUR_TOKEN
+
+# Create and manage named tunnels
+opentunnel create my-tunnel --cf
+opentunnel tunnels --cf
+opentunnel route my-tunnel app.example.com
+opentunnel delete my-tunnel --cf
+
+# Use named tunnel with -n flag
+opentunnel http 3000 --cf -n my-tunnel
+
+# View stored credentials
+opentunnel config list
+```
+
 ---
 
 ## Documentation
@@ -64,12 +103,14 @@ opentunnel expl 3000
 | [Server Guide](docs/server-guide.md) | Server deployment and configuration |
 | [Commands Reference](docs/commands.md) | All CLI commands and options |
 | [Configuration File](docs/configuration.md) | opentunnel.yml reference |
+| [Troubleshooting](docs/troubleshooting.md) | Common issues and solutions |
 | [Home Use Guide](docs/home-use-guide.md) | Running from home with port forwarding |
 | [Domain Setup](docs/domain-setup.md) | DNS and SSL configuration |
 | [DuckDNS & Free DNS](docs/duckdns-setup.md) | Free DNS services setup |
+| [Cloudflare Tunnel](docs/cloudflare-tunnel.md) | Cloudflare Tunnel & named tunnels |
 | [Multi-Domain](docs/multi-domain.md) | Multiple domains on one server |
 | [Authentication](docs/authentication.md) | Token-based authentication |
-| [IP Access Control](docs/ip-access-control.md) | Allow/deny IP ranges |
+| [IP Access Control](docs/ip-access-control.md) | Allow/deny IP ranges (cross-provider) |
 | [Firewall (Dymo API)](docs/firewall-dymo-api.md) | Fraud detection and bot protection |
 
 ---