You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/get-started/setup.md
+11Lines changed: 11 additions & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -111,6 +111,17 @@ You can skip this if you don't want to add emails to Kit.
111
111
3. Get your Kit tag ID. You can find this in the URL of the tag page
112
112
4. Add the API secret and tag ID to your `.env` file
113
113
114
+
### Ngrok (optional)
115
+
116
+
Ngrok exposes local networked services behinds NATs and firewalls to the public internet over a secure tunnel. It allows us to create an agent endpoint that forwards public traffic to localhost Compass API during development so that we can test our webhook endpoints(Gcal etc.) without needing access to a deployed instance..
117
+
118
+
You can skip this if you're not working on, or going to test the webhook functionalities.
119
+
120
+
1. Create a free [Ngrok account](https://dashboard.ngrok.com/signup/)
121
+
2. Get your [Authtoken](https://dashboard.ngrok.com/get-started/your-authtoken) from the Ngrok Dashboard
122
+
3. Create a [Static Domain](https://dashboard.ngrok.com/domains) from the Ngrok Dashboard
123
+
4. Add the Authtoken(`NGROK_AUTHTOKEN`) and Static Domain(`NGROK_DOMAIN`) to your `.env` file
124
+
114
125
## Start in Dev Mode
115
126
116
127
Pfew! That was a lot of setup. Now for the fun part. Run these commands from the root `compass` directory
0 commit comments