Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update README.md #560

Merged
merged 2 commits into from
Mar 12, 2024
Merged

Update README.md #560

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
bc0e178
Fix Issue in Dev Env Setup for Mac
yashkohli88 Feb 20, 2024
97c40bc
Fix Issue in Dev Env Setup for Mac
yashkohli88 Feb 22, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 4 additions & 4 deletions README.md
100644 → 100755
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -133,7 +133,7 @@ If a CRAWLER_ID is specified, then each instance must have this setting globally
## Run Docker image from Docker Hub

You can run the image as is from docker (this is w/o any port forwarding, which means the only way you can interact with the crawler locally is through the queue. See below for examples of how to run with ports exposed to do curl based testing).
`docker run --env-file ../<env_name>.env.list clearlydefined/crawler`
`docker run --platform linux/amd64 --env-file ../<env_name>.env.list clearlydefined/crawler`

See `local.env.list`, `dev.env.list` and `prod.env.list` tempate files.

Expand All @@ -145,13 +145,13 @@ See `local.env.list`, `dev.env.list` and `prod.env.list` tempate files.

## Build and run Docker image locally

`docker build -t cdcrawler:latest .`
`docker build --platform linux/amd64 -t cdcrawler:latest .`

`docker run --rm --env-file ../dev.env.list -p 5000:5000 -p 9229:9229 cdcrawler:latest`
`docker run --platform linux/amd64 --rm --env-file ../dev.env.list -p 5000:5000 -p 9229:9229 cdcrawler:latest`

With a debugger:

`docker run --rm -d --env-file ../dev.env.list -p 9229:9229 -p 5000:5000 --entrypoint node cdcrawler:latest --inspect-brk=0.0.0.0:9229 index.js`
`docker run --platform linux/amd64 --rm -d --env-file ../dev.env.list -p 9229:9229 -p 5000:5000 --entrypoint node cdcrawler:latest --inspect-brk=0.0.0.0:9229 index.js`

At this point you can attach VS Code with the built in debugging profile (see .vscode/launch.json)

Expand Down