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 with docker usage #86

Merged
merged 1 commit into from
Jan 31, 2024
Merged

Update readme with docker usage #86

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
19 changes: 17 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,9 +13,9 @@ Usage: yarn start [options]

Options:
-c, --config JSON string with the scrapix configuration
-p, --config-path Path to the scrapix configuration JSON file
-p, --config-path Path to the scrapix configuration JSON file
-b, --browser-path Path to the browser binary
```
```

## Endpoint

Expand Down Expand Up @@ -221,3 +221,18 @@ Here is the Webhook payload:
```

It is possible to add additional information in the webhook payload through the `webhook_payload` configuration

## Docker

### Usage

```
docker run --rm --env-file .env getmeili/scrapix
docker run -rm --env CRAWLER_CONFIG=$CRAWLER_CONFIG getmeili/scrapix
```

⚠️ Avoid any whitespace inside your CRAWLER_CONFIG.

## Publish

The CI handles the publishing.