1
0
Fork 0
mirror of https://github.com/maybe-finance/maybe.git synced 2025-08-09 07:25:19 +02:00

Add instructions for adding static domain from Ngrok

Add env variable for static domain to docker compose file
This commit is contained in:
David Neuman 2024-01-16 14:58:59 -05:00
parent 27f810c230
commit 2b24582aff
3 changed files with 12 additions and 3 deletions

View file

@ -14,6 +14,7 @@ NX_NEXTAUTH_URL=http://localhost:4200
# We use ngrok to expose a local development environment to the internet
# You can sign up for a free account and get an API key at https://ngrok.com
NGROK_AUTH_TOKEN=
NGROK_DOMAIN=
########################################################################
# DATABASE
@ -57,4 +58,4 @@ NX_POSTMARK_API_TOKEN=
########################################################################
NX_PLAID_SECRET=
NX_FINICITY_APP_KEY=
NX_FINICITY_PARTNER_SECRET=
NX_FINICITY_PARTNER_SECRET=

View file

@ -72,7 +72,15 @@ To test this locally/during development, you will need to setup `ngrok`.
1. Visit [ngrok.com](https://ngrok.com/)
2. Create a free account
3. Visit [this page](https://dashboard.ngrok.com/get-started/your-authtoken) to access your auth token
4. Paste it into your `.env` file: `NGROK_AUTH_TOKEN={your_auth_token}`
4. Paste it into your `.env` file: `NGROK_AUTH_TOKEN=your_auth_token`
You should claim your free static domain to avoid needing to change the URL each time you start/stop the server.
To do so:
1. Visit the [domains](https://dashboard.ngrok.com/cloud-edge/domains) page
2. Click on Create Domain
3. Copy the domain and paste it into your `.env` file: `NGROK_DOMAIN=your_domain`
That's it! As long as you run the project locally using `docker` with `yarn dev:services:all` you'll be good to go.

View file

@ -31,7 +31,7 @@ services:
ports:
- 4551:4551
environment:
- DOMAIN=host.docker.internal
- DOMAIN=${NGROK_DOMAIN}
- PORT=3333
- AUTH_TOKEN=${NGROK_AUTH_TOKEN}
- DEBUG=true