github-featured/triggerdotdev--trigger.dev
2
0
Fork 0
Code Issues Pull Requests Deployments Models Agent Notes Packages Projects Releases Wiki Activity

Change how ngrok is being used again, and update DEVELOPMENT instructions

Browse Source
This commit is contained in:
Eric Allam
2022-12-30 11:44:53 +00:00
parent 96cd333746
commit 1f1195a0d6
7 changed files with 76 additions and 37 deletions
Download Patch File Download Diff File Expand all files Collapse all files
.docker/pizzly-server.env.example
+1 -7
View File
@@ -1,7 +1 @@
SERVER_HOST=http://localhost
SERVER_PORT=3004
NODE_ENV=development
NANGO_DB_HOST=db
NANGO_DB_USER=postgres
NANGO_DB_PASSWORD=postgres
NANGO_DB_NAME=postgres
AUTH_CALLBACK_URL=https://<ngrok subdomain>.eu.ngrok.io/oauth/callback
.docker/pizzly_proxy.env.example
-5
View File
@@ -1,5 +0,0 @@
NGROK_SUBDOMAIN=<custom subdomain>
NGROK_AUTH=<auth token>
NGROK_PORT=3004
NGROK_PROTOCOL=http
NGROK_DEBUG=true
.docker/webapp_proxy.env.example
-5
View File
@@ -1,5 +0,0 @@
NGROK_SUBDOMAIN=<custom subdomain>
NGROK_AUTH=<auth token>
NGROK_PORT=3004
NGROK_PROTOCOL=http
NGROK_DEBUG=true
DEVELOPMENT.md
+21 -12
View File
@@ -37,7 +37,18 @@ export PULSAR_CPP_DIR=/opt/homebrew/Cellar/libpulsar/3.1.0
```bash
pnpm install
```
2. Environment variables. You will need to create copies of the `.env.example` files in `app/webapp`
2. Optionally, if you are testing auth (pizzly) or webhooks (webapp) then you'll need to use ngrok to proxy internet traffic to your local machine
Get access to ngrok and then follow the instructions here to get it setup: https://ngrok.com/download (use homebrew) and make sure to authenticate.
Then run the following scripts to start proxying:
```sh
./scripts/proxy-pizzly.sh dan-pizzly-dev
./scripts/proxy-webapp.sh dan-trigger-dev
```
3. Environment variables. You will need to create copies of the `.env.example` files in `app/webapp`
```sh
cp ./apps/webapp/.env.example ./apps/webapp/.env
@@ -45,21 +56,19 @@ export PULSAR_CPP_DIR=/opt/homebrew/Cellar/libpulsar/3.1.0
Then you will need to fill in the fields with real values.
You also need to create three `.env` files under the `.docker` directory:
You also need to create the `pizzly-server.env` files under the `.docker` directory:
```sh
cp ./.docker/pizzly-server.env.example ./.docker/pizzly-server.env
cp ./.docker/pizzly_proxy.env.example ./.docker/pizzly_proxy.env
cp ./.docker/webapp_proxy.env.example ./.docker/webapp_proxy.env
```
In `webapp_proxy` and `pizzly_proxy` make sure you fill in the `NGROK_SUBDOMAIN` and `NGROK_AUTH` environment variables. For example, in `webapp_proxy` and `pizzly_proxy` you could have something like `dan-trigger-dev` and `dan-pizzly-dev` respectively for the `NGROK_SUBDOMAIN` env var.
Next, update the `AUTH_CALLBACK_URL` env var in the `pizzly-server.env` env file with the value provided to the `./scripts/proxy-pizzly.sh` command. Using the example above the `AUTH_CALLBACK_URL` would be `AUTH_CALLBACK_URL=https://dan-pizzly-dev.eu.ngrok.io/oauth/callback`.
Next, update the `SERVER_HOST` env var in the `pizzly-server.env` env file with the value provided to the `NGROK_SUBDOMAIN` in the `pizzly_proxy.env` file. Using the example above the `SERVER_HOST` would be `SERVER_HOST=https://dan-pizzly-dev.ngrok.io`
If you aren't proxying pizzly according to step 2, then leave the `pizzly-server.env` file empty.
Also, in `webapp/.env`, set the `APP_ORIGIN` to the `NGROK_SUBDOMAIN` provided to the `webapp_proxy.env` file, e.g. `APP_ORIGIN=https://dan-trigger-dev.ngrok.io`
If you are proxying the webapp accroding to step 2 then in `webapp/.env`, set the `APP_ORIGIN` to the `NGROK_SUBDOMAIN` provided to the `./scripts/proxy-webapp.sh` command, e.g. `APP_ORIGIN=https://dan-trigger-dev.eu.ngrok.io`
3. Start postgresql, pulsar, pizzly server, and the two ngrok proxies
4. Start postgresql, pulsar, and pizzly server
```bash
pnpm run docker:db
@@ -67,17 +76,17 @@ export PULSAR_CPP_DIR=/opt/homebrew/Cellar/libpulsar/3.1.0
> **Note:** The npm script will complete while Docker sets up the container in the background. Ensure that Docker has finished and your container is running before proceeding.
4. Generate prisma schema
5. Generate prisma schema
```bash
pnpm run generate
```
5. Run the Prisma migration to the database
6. Run the Prisma migration to the database
```bash
pnpm run db:migrate:deploy
```
6. Run the first build (with dependencies via the `...` option)
7. Run the first build (with dependencies via the `...` option)
```bash
pnpm run build --filter=webapp...
@@ -85,7 +94,7 @@ export PULSAR_CPP_DIR=/opt/homebrew/Cellar/libpulsar/3.1.0
**Running simply `pnpm run build` will build everything, including the Remix app.**
7. Run the Remix dev server
8. Run the Remix dev server
```bash
pnpm run dev --filter=webapp
docker-compose.yml
+8 -8
View File
@@ -26,20 +26,20 @@ services:
restart: always
env_file:
- .docker/pizzly-server.env
environment:
- SERVER_HOST=http://localhost
- SERVER_PORT=3004
- NODE_ENV=development
- NANGO_DB_HOST=db
- NANGO_DB_USER=postgres
- NANGO_DB_PASSWORD=postgres
- NANGO_DB_NAME=postgres
ports:
- "3004:3004"
depends_on:
- db
networks:
- app_network
pizzly_proxy:
image: wernight/ngrok
env_file:
- .docker/pizzly_proxy.env
webapp_proxy:
image: wernight/ngrok
env_file:
- .docker/webapp_proxy.env
pulsar:
image: apachepulsar/pulsar:2.10.2
ports:
scripts/proxy-pizzly.sh
Executable
+23
View File
@@ -0,0 +1,23 @@
#!/usr/bin/env bash
#
# Licensed to the Apache Software Foundation (ASF) under one
# or more contributor license agreements. See the NOTICE file
# distributed with this work for additional information
# regarding copyright ownership. The ASF licenses this file
# to you under the Apache License, Version 2.0 (the
# "License"); you may not use this file except in compliance
# with the License. You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing,
# software distributed under the License is distributed on an
# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
# KIND, either express or implied. See the License for the
# specific language governing permissions and limitations
# under the License.
#
set -e -x
ngrok http --subdomain=${1:-$NGROK_SUBDOMAIN} --region eu 3004
scripts/proxy-webapp.sh
Executable
+23
View File
@@ -0,0 +1,23 @@
#!/usr/bin/env bash
#
# Licensed to the Apache Software Foundation (ASF) under one
# or more contributor license agreements. See the NOTICE file
# distributed with this work for additional information
# regarding copyright ownership. The ASF licenses this file
# to you under the Apache License, Version 2.0 (the
# "License"); you may not use this file except in compliance
# with the License. You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing,
# software distributed under the License is distributed on an
# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
# KIND, either express or implied. See the License for the
# specific language governing permissions and limitations
# under the License.
#
set -e -x
ngrok http --subdomain=${1:-$NGROK_SUBDOMAIN} --region eu 3000