From 0b36de35469009b32489b2ef5e13f5ed884c0987 Mon Sep 17 00:00:00 2001 From: Charlotte Vermandel Date: Wed, 6 Sep 2023 13:48:52 +0200 Subject: [PATCH] Update readme --- README.md | 19 +++++++++++++++++-- 1 file changed, 17 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index e1c4e8b..7ff04e7 100644 --- a/README.md +++ b/README.md @@ -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 @@ -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.