opentunnel-cli 1.0.23 → 1.0.25
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +39 -2
- package/dist/cli/index.js +678 -84
- package/dist/cli/index.js.map +1 -1
- package/dist/client/CloudflareTunnelClient.d.ts +110 -0
- package/dist/client/CloudflareTunnelClient.d.ts.map +1 -0
- package/dist/client/CloudflareTunnelClient.js +531 -0
- package/dist/client/CloudflareTunnelClient.js.map +1 -0
- package/dist/client/NgrokClient.d.ts +18 -1
- package/dist/client/NgrokClient.d.ts.map +1 -1
- package/dist/client/NgrokClient.js +130 -4
- package/dist/client/NgrokClient.js.map +1 -1
- package/dist/client/TunnelClient.d.ts +0 -1
- package/dist/client/TunnelClient.d.ts.map +1 -1
- package/dist/client/TunnelClient.js +2 -96
- package/dist/client/TunnelClient.js.map +1 -1
- package/dist/client/index.d.ts +1 -0
- package/dist/client/index.d.ts.map +1 -1
- package/dist/client/index.js +3 -1
- package/dist/client/index.js.map +1 -1
- package/dist/index.d.ts +1 -0
- package/dist/index.d.ts.map +1 -1
- package/dist/index.js +3 -1
- package/dist/index.js.map +1 -1
- package/dist/lib/index.d.ts +2 -0
- package/dist/lib/index.d.ts.map +1 -0
- package/dist/lib/index.js +18 -0
- package/dist/lib/index.js.map +1 -0
- package/dist/lib/pages/index.d.ts +2 -0
- package/dist/lib/pages/index.d.ts.map +1 -0
- package/dist/lib/pages/index.js +6 -0
- package/dist/lib/pages/index.js.map +1 -0
- package/dist/lib/pages/not-running.d.ts +10 -0
- package/dist/lib/pages/not-running.d.ts.map +1 -0
- package/dist/lib/pages/not-running.js +117 -0
- package/dist/lib/pages/not-running.js.map +1 -0
- package/dist/server/TunnelServer.d.ts +1 -3
- package/dist/server/TunnelServer.d.ts.map +1 -1
- package/dist/server/TunnelServer.js +7 -58
- package/dist/server/TunnelServer.js.map +1 -1
- package/dist/shared/credentials.d.ts +101 -0
- package/dist/shared/credentials.d.ts.map +1 -0
- package/dist/shared/credentials.js +302 -0
- package/dist/shared/credentials.js.map +1 -0
- package/dist/shared/ip-filter.d.ts +75 -0
- package/dist/shared/ip-filter.d.ts.map +1 -0
- package/dist/shared/ip-filter.js +203 -0
- package/dist/shared/ip-filter.js.map +1 -0
- package/dist/shared/types.d.ts +34 -0
- package/dist/shared/types.d.ts.map +1 -1
- package/package.json +6 -3
package/README.md
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
<h1 align="center">OpenTunnel</h1>
|
|
2
2
|
|
|
3
|
-
<p align="center">Self-hosted alternative to ngrok. Expose local services to the internet with custom subdomains.</p>
|
|
3
|
+
<p align="center">Self-hosted alternative to ngrok. Expose local services to the internet with custom subdomains, or use ngrok/Cloudflare Tunnel.</p>
|
|
4
4
|
|
|
5
5
|
---
|
|
6
6
|
|
|
@@ -54,6 +54,42 @@ opentunnel setdomain yourdomain.com
|
|
|
54
54
|
opentunnel expl 3000
|
|
55
55
|
```
|
|
56
56
|
|
|
57
|
+
### Using ngrok or Cloudflare Tunnel
|
|
58
|
+
|
|
59
|
+
Don't have a server? Use third-party tunnel providers:
|
|
60
|
+
|
|
61
|
+
```bash
|
|
62
|
+
# With Cloudflare Tunnel (free, no account needed for quick tunnels)
|
|
63
|
+
opentunnel http 3000 --cloudflare
|
|
64
|
+
opentunnel http 3000 --cf
|
|
65
|
+
|
|
66
|
+
# With ngrok
|
|
67
|
+
opentunnel http 3000 --ngrok
|
|
68
|
+
opentunnel http 3000 --ngrok --region eu
|
|
69
|
+
```
|
|
70
|
+
|
|
71
|
+
### Authentication & Named Tunnels
|
|
72
|
+
|
|
73
|
+
Store credentials securely and manage Cloudflare named tunnels:
|
|
74
|
+
|
|
75
|
+
```bash
|
|
76
|
+
# Login to providers
|
|
77
|
+
opentunnel login cloudflare # Opens browser for OAuth
|
|
78
|
+
opentunnel login ngrok --token YOUR_TOKEN
|
|
79
|
+
|
|
80
|
+
# Create and manage named tunnels
|
|
81
|
+
opentunnel create my-tunnel --cf
|
|
82
|
+
opentunnel tunnels --cf
|
|
83
|
+
opentunnel route my-tunnel app.example.com
|
|
84
|
+
opentunnel delete my-tunnel --cf
|
|
85
|
+
|
|
86
|
+
# Use named tunnel with -n flag
|
|
87
|
+
opentunnel http 3000 --cf -n my-tunnel
|
|
88
|
+
|
|
89
|
+
# View stored credentials
|
|
90
|
+
opentunnel config list
|
|
91
|
+
```
|
|
92
|
+
|
|
57
93
|
---
|
|
58
94
|
|
|
59
95
|
## Documentation
|
|
@@ -67,9 +103,10 @@ opentunnel expl 3000
|
|
|
67
103
|
| [Home Use Guide](docs/home-use-guide.md) | Running from home with port forwarding |
|
|
68
104
|
| [Domain Setup](docs/domain-setup.md) | DNS and SSL configuration |
|
|
69
105
|
| [DuckDNS & Free DNS](docs/duckdns-setup.md) | Free DNS services setup |
|
|
106
|
+
| [Cloudflare Tunnel](docs/cloudflare-tunnel.md) | Cloudflare Tunnel & named tunnels |
|
|
70
107
|
| [Multi-Domain](docs/multi-domain.md) | Multiple domains on one server |
|
|
71
108
|
| [Authentication](docs/authentication.md) | Token-based authentication |
|
|
72
|
-
| [IP Access Control](docs/ip-access-control.md) | Allow/deny IP ranges |
|
|
109
|
+
| [IP Access Control](docs/ip-access-control.md) | Allow/deny IP ranges (cross-provider) |
|
|
73
110
|
| [Firewall (Dymo API)](docs/firewall-dymo-api.md) | Fraud detection and bot protection |
|
|
74
111
|
|
|
75
112
|
---
|