Skip to content

Commit 5ac2fdf

Browse files
committed
suggest to rename the worker
1 parent 1ff2ab1 commit 5ac2fdf

File tree

1 file changed

+13
-0
lines changed

1 file changed

+13
-0
lines changed

README.md

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -40,6 +40,8 @@ It takes just under 10 minutes to set up.
4040

4141
## Security
4242

43+
### Secret token
44+
4345
The tool uses cryptographically random unique tunnel IDs (UUID v4) to avoid collisions, but also to provide basic security out of the box. It's not possible to connect to the worker without knowing the tunnel ID. But we all know that security through obscurity can get us only so far. You can significantly increase the security by generating a secret token that the client will use to authenticate with the worker. This way without knowing the secret token it is impossible to connect to any tunnel disregarding the tunnel ID.
4446

4547
```bash
@@ -48,6 +50,17 @@ npm run generate-secret
4850

4951
This automatically redeploys the worker with the new secret token set as an environment variable. This enables the worker to authenticate the client requests. The client will automatically pick the token from `.env` and send it on websocket connection to the worker.
5052

53+
### Rename the worker
54+
55+
You can rename the worker by updating the `name` field in the [`worker/wrangler.jsonc`](worker/wrangler.jsonc#L7) file. This will change the public endpoint URL to reflect the new name. A good way is to append a random string to the name, e.g. `webhooks-proxy-tunnel-123abc`.
56+
57+
```jsonc
58+
{
59+
"name": "webhooks-proxy-tunnel-123abc"
60+
// ...
61+
}
62+
```
63+
5164
## About
5265

5366
This tunneling solution is free. It's expected that you self host it on your Cloudflare Free plan. It should take under 10 minutes to deploy the whole thing from scratch and will cost you nothing, require no EULA agreement, no fine text attached, no data protection issues. Just your laptop and your trusty Cloudfare account.

0 commit comments

Comments
 (0)