kiwix/zimit
1
0
Fork 0
mirror of https://github.com/openzim/zimit.git synced 2025-09-24 04:30:11 -04:00
Code Issues Packages Projects Releases Wiki Activity

Updated readme: warc2zim params can be passed

Browse Source
This commit is contained in:
renaud gaudin 2022-05-03 10:31:34 +00:00
parent efd8ca53b4
commit 98587045b4
1 changed files with 3 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
README.md
View File

@ -35,7 +35,7 @@ To build locally run:
docker build -t openzim/zimit . docker build -t openzim/zimit .
``` ```
The image accepts the following parameters: The image accepts the following parameters, **as well as any of the [warc2zim](https://github.com/openzim/warc2zim) ones**; useful for setting metadata, for instance:
- `--url URL` - the url to be crawled (required) - `--url URL` - the url to be crawled (required)
- `--workers N` - number of crawl workers to be run in parallel - `--workers N` - number of crawl workers to be run in parallel
@ -53,6 +53,8 @@ flags are [needed to run Chrome in Docker](https://github.com/puppeteer/puppetee
Example command: Example command:
```bash ```bash
docker run openzim/zimit zimit --help
docker run openzim/zimit warc2zim --help
docker run -v /output:/output --cap-add=SYS_ADMIN --cap-add=NET_ADMIN \ docker run -v /output:/output --cap-add=SYS_ADMIN --cap-add=NET_ADMIN \
--shm-size=1gb openzim/zimit zimit --url URL --name myzimfile --workers 2 --waitUntil domcontentloaded --shm-size=1gb openzim/zimit zimit --url URL --name myzimfile --workers 2 --waitUntil domcontentloaded
``` ```