@easytunnel/et-sdk 1.0.1 → 1.2.0
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 +6 -4
- package/etunnel.js +2 -2
- package/package.json +3 -3
package/README.md
CHANGED
|
@@ -1,10 +1,12 @@
|
|
|
1
1
|
# etunnel for Node.js
|
|
2
2
|
|
|
3
|
+
[](https://www.npmjs.com/package/@easytunnel/et-sdk)
|
|
4
|
+
|
|
3
5
|
Expose a local service through an etunnel reverse-tunnel server. Zero dependencies (Node >= 22 built-in WebSocket).
|
|
4
6
|
|
|
5
7
|
Zero registration: every SDK client speaks the same tiny wire protocol
|
|
6
8
|
([PROTOCOL.md](../../PROTOCOL.md)) against any etunnel server
|
|
7
|
-
(default `wss://t.
|
|
9
|
+
(default `wss://t.etun.uk/tunnel`).
|
|
8
10
|
|
|
9
11
|
## Install
|
|
10
12
|
|
|
@@ -20,14 +22,14 @@ Requires Node >= 22.
|
|
|
20
22
|
npx @easytunnel/et-sdk 3000
|
|
21
23
|
```
|
|
22
24
|
|
|
23
|
-
Prints `TUNNEL_URL: https://<subdomain>.t.
|
|
25
|
+
Prints `TUNNEL_URL: https://<subdomain>.t.etun.uk` — that URL now routes to
|
|
24
26
|
your local service. Ctrl-C closes the tunnel.
|
|
25
27
|
|
|
26
28
|
## Embed
|
|
27
29
|
|
|
28
30
|
```js
|
|
29
31
|
const { connect } = require('@easytunnel/et-sdk');
|
|
30
|
-
const t = await connect('wss://t.
|
|
32
|
+
const t = await connect('wss://t.etun.uk/tunnel', 3000);
|
|
31
33
|
console.log(t.url);
|
|
32
34
|
```
|
|
33
35
|
|
|
@@ -35,7 +37,7 @@ console.log(t.url);
|
|
|
35
37
|
|
|
36
38
|
| Variable | Meaning | Default |
|
|
37
39
|
|---|---|---|
|
|
38
|
-
| `ETUNNEL_SERVER` | tunnel server WebSocket URL | `wss://t.
|
|
40
|
+
| `ETUNNEL_SERVER` | tunnel server WebSocket URL | `wss://t.etun.uk/tunnel` |
|
|
39
41
|
| `ETUNNEL_LOCAL` | local port or `host:port` (or 1st CLI arg) | `3000` |
|
|
40
42
|
| `ETUNNEL_TOKEN` | paid-plan API key (optional) | - |
|
|
41
43
|
| `ETUNNEL_SUBDOMAIN` | custom subdomain (paid plans) | random |
|
package/etunnel.js
CHANGED
|
@@ -6,7 +6,7 @@
|
|
|
6
6
|
// forwarded — use the Go SDK for full streaming/upgrades).
|
|
7
7
|
//
|
|
8
8
|
// const { connect } = require('./etunnel');
|
|
9
|
-
// const t = await connect('wss://t.
|
|
9
|
+
// const t = await connect('wss://t.etun.uk/tunnel', 3000);
|
|
10
10
|
// console.log(t.url);
|
|
11
11
|
|
|
12
12
|
const MAXP = 32768;
|
|
@@ -130,7 +130,7 @@ async function connect(server, local, opts = {}) {
|
|
|
130
130
|
module.exports = { connect };
|
|
131
131
|
|
|
132
132
|
if (require.main === module) {
|
|
133
|
-
const server = process.env.ETUNNEL_SERVER || 'wss://t.
|
|
133
|
+
const server = process.env.ETUNNEL_SERVER || 'wss://t.etun.uk/tunnel';
|
|
134
134
|
const local = process.env.ETUNNEL_LOCAL || process.argv[2] || '3000';
|
|
135
135
|
connect(server, local, { token: process.env.ETUNNEL_TOKEN, subdomain: process.env.ETUNNEL_SUBDOMAIN })
|
|
136
136
|
.then((t) => { console.log('TUNNEL_URL: ' + t.url); })
|
package/package.json
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@easytunnel/et-sdk",
|
|
3
|
-
"version": "1.0
|
|
4
|
-
"description": "Expose
|
|
3
|
+
"version": "1.2.0",
|
|
4
|
+
"description": "Expose local services to the internet in one line of code: instant public HTTPS URLs with automatic TLS, through NAT and firewalls, no signup. Webhook-friendly ngrok-style reverse tunnel, with SDKs in 20 languages and a single-binary Go server.",
|
|
5
5
|
"license": "MIT",
|
|
6
6
|
"repository": {
|
|
7
7
|
"type": "git",
|
|
@@ -16,9 +16,9 @@
|
|
|
16
16
|
"tunnel",
|
|
17
17
|
"reverse-proxy",
|
|
18
18
|
"webhook",
|
|
19
|
+
"ngrok",
|
|
19
20
|
"localhost",
|
|
20
21
|
"expose",
|
|
21
|
-
"ngrok",
|
|
22
22
|
"easytunnel"
|
|
23
23
|
],
|
|
24
24
|
"engines": {
|