openstatus.dev
Openstatus
www.openstatus.dev
#553 Add Tunnelmole as an open source alternative to ngrok (#579)
* #553 Add Tunnelmole as an open source alternative to ngrok
* #553 Add url path
+17
-2
+17
-2
README.md
+17
-2
README.md
···
68
68
69
69
3. Set up your .env file
70
70
71
-
from `apps/web` and `packages/db` you will find .env.example create your own.
71
+
From `apps/web` and `packages/db`, you will find .env.example. Create your own copy.
72
72
73
73
4. Follow the steps to run your sqlite database locally inside of
74
74
[README.md](https://github.com/openstatusHQ/openstatus/blob/main/packages/db/README.md)
···
83
83
the result.
84
84
85
85
For [clerk](https://clerk.com), you will need to create a webhook endpoint. To
86
-
access the link via ngrok (free), after login, append `/api/webhook/clerk` to
86
+
access the link, you can use tunneling tools like [Tunnelmole](https://github.com/robbie-cahill/tunnelmole-client), an open source tunnelling tool or ngrok, a popular closed source tunnelling tool.
87
+
88
+
### Using Tunnelmole
89
+
1. Install Tunnelmole with `curl -O https://install.tunnelmole.com/384HK/install && sudo bash install`. (On Windows, download [tmole.exe](https://tunnelmole.com/downloads/tmole.exe))
90
+
2. Run `tmole 3000`. In the output, you'll see two URLs, one HTTP, and an HTTPS URL. It's best to use the HTTPS URL for privacy and security.
91
+
```
92
+
➜ ~ tmole 3000
93
+
http://bvdo5f-ip-49-183-170-144.tunnelmole.net is forwarding to localhost:3000
94
+
https://bvdo5f-ip-49-183-170-144.tunnelmole.net is forwarding to localhost:3000
95
+
```
96
+
97
+
Append `/api/webhook/clerk` to the HTTPs URL.
98
+
99
+
### Using ngrok
100
+
After login, append `/api/webhook/clerk` to
87
101
the link you get after entering:
88
102
89
103
```
···
91
105
```
92
106
93
107
### Videos
108
+
94
109
95
110
Videos to better understand the OpenStatus codebase:
96
111