@rexaray008/nodeproxy 2.0.0 → 2.0.1
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 +8 -16
- package/package.json +13 -1
package/README.md
CHANGED
|
@@ -27,18 +27,9 @@ pm2 keeps your project running (and restarts it if it crashes). nodeproxy forwar
|
|
|
27
27
|
|
|
28
28
|
---
|
|
29
29
|
|
|
30
|
-
## Step 1 — Get the files and link the command
|
|
31
30
|
|
|
32
|
-
```bash
|
|
33
|
-
unzip nodeproxy.zip
|
|
34
|
-
cd nodeproxy
|
|
35
|
-
npm link
|
|
36
|
-
nodeproxy help # confirms it worked
|
|
37
|
-
```
|
|
38
|
-
|
|
39
|
-
(You can also just run `node bin/cli.js ...` instead of `nodeproxy ...` everywhere below, without `npm link`.)
|
|
40
31
|
|
|
41
|
-
## Step
|
|
32
|
+
## Step 1 — Register your project so nodeproxy starts it for you
|
|
42
33
|
|
|
43
34
|
This is the part that removes the "start your project manually first" step. Point it at your project's start command:
|
|
44
35
|
|
|
@@ -54,7 +45,7 @@ This just registers it in `nodeproxy.config.json` — nothing starts yet. Repeat
|
|
|
54
45
|
|
|
55
46
|
**Already running your project some other way (Docker, a different process manager, always-on already)?** Skip this step entirely — nodeproxy will just proxy to whatever's listening on the port, same as before.
|
|
56
47
|
|
|
57
|
-
## Step
|
|
48
|
+
## Step 2 — Point the proxy at it
|
|
58
49
|
|
|
59
50
|
By default nodeproxy forwards port 8080 → `http://localhost:3000`. If your project runs on a different port:
|
|
60
51
|
|
|
@@ -62,7 +53,7 @@ By default nodeproxy forwards port 8080 → `http://localhost:3000`. If your pro
|
|
|
62
53
|
nodeproxy add "*" http://localhost:YOUR_PORT
|
|
63
54
|
```
|
|
64
55
|
|
|
65
|
-
## Step
|
|
56
|
+
## Step 3 — First full local start
|
|
66
57
|
|
|
67
58
|
```bash
|
|
68
59
|
nodeproxy start
|
|
@@ -91,7 +82,7 @@ nodeproxy app stop myapp
|
|
|
91
82
|
|
|
92
83
|
Stop everything with `Ctrl+C` (nodeproxy) — your app keeps running under pm2 in the background even after that, exactly as pm2 is designed to. Use `nodeproxy app stop myapp` to actually stop it.
|
|
93
84
|
|
|
94
|
-
## Step
|
|
85
|
+
## Step 4 — One-time Cloudflare login and tunnel creation
|
|
95
86
|
|
|
96
87
|
Only needed if you want a real public domain (skip to Step 9 if you're only using this locally).
|
|
97
88
|
|
|
@@ -112,14 +103,14 @@ Expected output:
|
|
|
112
103
|
[tunnel] From now on, just run: nodeproxy start --tunnel --name app-yourdomain-com
|
|
113
104
|
```
|
|
114
105
|
|
|
115
|
-
## Step
|
|
106
|
+
## Step 5 — Check DNS propagated
|
|
116
107
|
|
|
117
108
|
```bash
|
|
118
109
|
dig app.yourdomain.com
|
|
119
110
|
```
|
|
120
111
|
Should resolve to Cloudflare IPs within a minute or so.
|
|
121
112
|
|
|
122
|
-
## Step
|
|
113
|
+
## Step 6 — **Go live: the one command you'll use from now on**
|
|
123
114
|
|
|
124
115
|
```bash
|
|
125
116
|
nodeproxy start --tunnel
|
|
@@ -127,7 +118,7 @@ nodeproxy start --tunnel
|
|
|
127
118
|
|
|
128
119
|
This starts, in order: your registered app(s) via pm2 → the local proxy → the Cloudflare tunnel. Visit `https://app.yourdomain.com` — it should serve your project. TLS is handled by Cloudflare's edge automatically.
|
|
129
120
|
|
|
130
|
-
## Step
|
|
121
|
+
## Step 7 — Verify from more than one place
|
|
131
122
|
|
|
132
123
|
This matters — testing only from the machine running nodeproxy can hide DNS problems:
|
|
133
124
|
|
|
@@ -315,3 +306,4 @@ lib/pm2.js pm2 install/start/stop/list helpers
|
|
|
315
306
|
- Round-robin load balancing only
|
|
316
307
|
- The Cloudflare browser-login click is inherently manual and one-time per machine — Cloudflare's security design, not a gap here
|
|
317
308
|
- `tunnel doctor` diagnoses the most common public-access failure (unproxied DNS); it isn't an exhaustive network debugger
|
|
309
|
+
|
package/package.json
CHANGED
|
@@ -1,7 +1,19 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@rexaray008/nodeproxy",
|
|
3
|
-
"version": "2.0.
|
|
3
|
+
"version": "2.0.1",
|
|
4
4
|
"description": "A lightweight, zero-dependency reverse proxy / web server for Node.js, with pm2 app management and Cloudflare Tunnel integration to expose local projects on a real domain. One command to install, configure and run.",
|
|
5
|
+
"keywords": [
|
|
6
|
+
"node-proxy",
|
|
7
|
+
"nodeproxy",
|
|
8
|
+
"proxy",
|
|
9
|
+
"http-proxy",
|
|
10
|
+
"reverse-proxy",
|
|
11
|
+
"networking",
|
|
12
|
+
"server-proxy",
|
|
13
|
+
"api-proxy",
|
|
14
|
+
"nodejs",
|
|
15
|
+
"javascript"
|
|
16
|
+
],
|
|
5
17
|
"main": "lib/server.js",
|
|
6
18
|
"bin": {
|
|
7
19
|
"nodeproxy": "./bin/cli.js"
|