Skip to content

Commit

Permalink
Merge pull request #86 from meilisearch/update_readme
Browse files Browse the repository at this point in the history
Update readme with docker usage
  • Loading branch information
tpayet authored Jan 31, 2024
2 parents 222f210 + 0b36de3 commit ee25490
Showing 1 changed file with 17 additions and 2 deletions.
19 changes: 17 additions & 2 deletions README.md
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.

0 comments on commit ee25490

Please sign in to comment.