Skip to content

Commit 6dda8cf

Browse files
📝 docs(setup-ngrok): add ngrok setup guidelines to docs (#38)
1 parent 945a7f3 commit 6dda8cf

1 file changed

Lines changed: 11 additions & 0 deletions

File tree

docs/get-started/setup.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -111,6 +111,17 @@ You can skip this if you don't want to add emails to Kit.
111111
3. Get your Kit tag ID. You can find this in the URL of the tag page
112112
4. Add the API secret and tag ID to your `.env` file
113113

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+
114125
## Start in Dev Mode
115126

116127
Pfew! That was a lot of setup. Now for the fun part. Run these commands from the root `compass` directory

0 commit comments

Comments
 (0)