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

removed references to docker.io

Browse Source
This commit is contained in:
renaud gaudin 2023-03-22 13:55:07 +00:00
parent 6324b7c7c5
commit b8714d1260
2 changed files with 8 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
.github/workflows/docker.yml vendored
View File

@ -14,7 +14,7 @@ jobs:
steps:
- name: Retrieve source code
uses: actions/checkout@v3
uses: actions/checkout@v3.4.0
- name: Build and push
uses: openzim/docker-publish-action@v9
@ -24,9 +24,8 @@ jobs:
tag-pattern: /^v([0-9.]+)$/
latest-on-tag: true
restrict-to: openzim/zimit
registries: ghcr.io
credentials:
DOCKERIO_USERNAME=${{ secrets.DOCKERHUB_USERNAME }}
DOCKERIO_TOKEN=${{ secrets.DOCKERHUB_PASSWORD }}
GHCRIO_USERNAME=${{ secrets.GHCR_USERNAME }}
GHCRIO_TOKEN=${{ secrets.GHCR_TOKEN }}
repo_description: auto

12
README.md
View File

@ -3,7 +3,7 @@ Zimit
Zimit is a scraper allowing to create ZIM file from any Web site.
[![Docker](https://img.shields.io/docker/v/openzim/zimit?label=docker&sort=semver)](https://hub.docker.com/r/openzim/zimit)
[![Docker](https://ghcr-badge.deta.dev/openzim/zimit/latest_tag?label=docker)](https://ghcr.io/openzim/zimit)
[![Build](https://github.com/openzim/zimit/workflows/CI/badge.svg?query=branch%3Amain)](https://github.com/openzim/zimit/actions?query=branch%3Amain)
[![CodeFactor](https://www.codefactor.io/repository/github/openzim/zimit/badge)](https://www.codefactor.io/repository/github/openzim/zimit)
[![License: GPL v3](https://img.shields.io/badge/License-GPLv3-blue.svg)](https://www.gnu.org/licenses/gpl-3.0)
@ -33,7 +33,7 @@ Usage
To build locally run:
```bash
docker build -t openzim/zimit .
docker build -t ghcr.io/openzim/zimit .
```
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:
@ -53,16 +53,16 @@ The following is an example usage. The `--shm-size` flags is [needed to run Chro
Example command:
```bash
docker run openzim/zimit zimit --help
docker run openzim/zimit warc2zim --help
docker run ghcr.io/openzim/zimit zimit --help
docker run ghcr.io/openzim/zimit warc2zim --help
docker run -v /output:/output \
--shm-size=1gb openzim/zimit zimit --url URL --name myzimfile --workers 2 --waitUntil domcontentloaded
--shm-size=1gb ghcr.ioopenzim/zimit zimit --url URL --name myzimfile --workers 2 --waitUntil domcontentloaded
```
The puppeteer-cluster provides monitoring output which is enabled by
default and prints the crawl status to the Docker log.
**Note**: Image automatically filters out a large number of ads by using the 3 blocklists from [anudeepND](https://github.com/anudeepND/blacklist). If you don't want this filtering, disable the image's entrypoint in your container (`docker run --entrypoint="" openzim/zimit ...`).
**Note**: Image automatically filters out a large number of ads by using the 3 blocklists from [anudeepND](https://github.com/anudeepND/blacklist). If you don't want this filtering, disable the image's entrypoint in your container (`docker run --entrypoint="" ghcr.io/openzim/zimit ...`).
Nota bene
---------