{"id":13493510,"url":"https://github.com/openzim/zimit","last_synced_at":"2026-01-21T22:03:06.184Z","repository":{"id":37502890,"uuid":"61637575","full_name":"openzim/zimit","owner":"openzim","description":"Make a ZIM file from any Web site and surf offline!","archived":false,"fork":false,"pushed_at":"2025-12-16T16:34:00.000Z","size":1070,"stargazers_count":661,"open_issues_count":67,"forks_count":42,"subscribers_count":19,"default_branch":"main","last_synced_at":"2025-12-20T07:37:43.766Z","etag":null,"topics":["docker","scraper","webscraping","zim"],"latest_commit_sha":null,"homepage":"","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"gpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/openzim.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":".github/FUNDING.yml","license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null},"funding":{"github":"kiwix","patreon":null,"open_collective":null,"ko_fi":null,"tidelift":null,"community_bridge":null,"liberapay":null,"issuehunt":null,"otechie":null,"custom":null}},"created_at":"2016-06-21T13:50:33.000Z","updated_at":"2025-12-19T23:38:42.000Z","dependencies_parsed_at":"2023-11-16T08:30:06.282Z","dependency_job_id":"81667017-8067-4711-b219-3d68a86ce64b","html_url":"https://github.com/openzim/zimit","commit_stats":null,"previous_names":[],"tags_count":44,"template":false,"template_full_name":null,"purl":"pkg:github/openzim/zimit","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/openzim%2Fzimit","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/openzim%2Fzimit/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/openzim%2Fzimit/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/openzim%2Fzimit/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/openzim","download_url":"https://codeload.github.com/openzim/zimit/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/openzim%2Fzimit/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":28644707,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-01-21T21:29:11.980Z","status":"ssl_error","status_checked_at":"2026-01-21T21:24:31.872Z","response_time":86,"last_error":"SSL_connect returned=1 errno=0 peeraddr=140.82.121.5:443 state=error: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["docker","scraper","webscraping","zim"],"created_at":"2024-07-31T19:01:16.033Z","updated_at":"2026-01-21T22:03:06.179Z","avatar_url":"https://github.com/openzim.png","language":"Python","funding_links":["https://github.com/sponsors/kiwix"],"categories":["Python","Apps"],"sub_categories":["Tools"],"readme":"Zimit\n=====\n\nZimit is a scraper allowing to create [ZIM file](https://en.wikipedia.org/wiki/ZIM_(file_format)) from any Web site.\n\n[![CodeFactor](https://www.codefactor.io/repository/github/openzim/zimit/badge)](https://www.codefactor.io/repository/github/openzim/zimit)\n[![License: GPL v3](https://img.shields.io/badge/License-GPLv3-blue.svg)](https://www.gnu.org/licenses/gpl-3.0)\n[![Docker](https://ghcr-badge.egpl.dev/openzim/zimit/latest_tag?label=docker)](https://ghcr.io/openzim/zimit)\n\nZimit adheres to openZIM's [Contribution Guidelines](https://github.com/openzim/overview/wiki/Contributing).\n\nZimit has implemented openZIM's [Python bootstrap, conventions and policies](https://github.com/openzim/_python-bootstrap/blob/main/docs/Policy.md) **v1.0.1**.\n\nCapabilities and known limitations\n--------------------\n\nWhile we would like to support as many websites as possible, making an offline archive of any website with a versatile tool obviously has some limitations.\n\nMost capabilities and known limitations are documented in [warc2zim README](https://github.com/openzim/warc2zim/blob/main/README.md). There are also some limitations in Browsertrix Crawler (used to fetch the website) and wombat (used to properly replay dynamic web requests), but these are not (yet?) clearly documented.\n\nTechnical background\n--------------------\n\nZimit runs a fully automated browser-based crawl of a website property and produces a ZIM of the crawled content. Zimit runs in a Docker container.\n\nThe system:\n- runs a website crawl with [Browsertrix Crawler](https://github.com/webrecorder/browsertrix-crawler), which produces WARC files\n- converts the crawled WARC files to a single ZIM using [warc2zim](https://github.com/openzim/warc2zim)\n\nThe `zimit.py` is the entrypoint for the system.\n\nAfter the crawl is done, warc2zim is used to write a zim to the `/output` directory, which should be mounted as a volume to not loose the ZIM created when container stops.\n\nUsing the `--keep` flag, the crawled WARCs and few other artifacts will also be kept in a temp directory inside `/output`\n\nUsage\n-----\n\n`zimit` is intended to be run in Docker. Docker image is published at https://github.com/orgs/openzim/packages/container/package/zimit.\n\nThe image accepts the following parameters, **as well as any of the [Browsertrix crawler](https://crawler.docs.browsertrix.com/user-guide/cli-options/) and [warc2zim](https://github.com/openzim/warc2zim) ones**:\n\n- Required: `--seeds URL` - the url to start crawling from ; multiple URLs can be separated by a comma (even if **usually not needed**, these are just the **seeds** of the crawl) ; first seed URL is used as ZIM homepage\n- Required: `--name` - Name of ZIM file\n- `--output` - output directory (defaults to `/output`)\n- `--pageLimit U` - Limit capture to at most U URLs\n- `--scopeExcludeRx \u003cregex\u003e` - skip URLs that match the regex from crawling. Can be specified multiple times. An example is `--scopeExcludeRx=\"(\\?q=|signup-landing\\?|\\?cid=)\"`, where URLs that contain either `?q=` or `signup-landing?` or `?cid=` will be excluded.\n- `--workers N` - number of crawl workers to be run in parallel\n- `--waitUntil` - Puppeteer setting for how long to wait for page load. See [page.goto waitUntil options](https://github.com/puppeteer/puppeteer/blob/main/docs/api.md#pagegotourl-options). The default is `load`, but for static sites, `--waitUntil domcontentloaded` may be used to speed up the crawl (to avoid waiting for ads to load for example).\n- `--keep` - in case of failure, WARC files and other temporary files (which are stored as a subfolder of output directory) are always kept, otherwise they are automatically deleted. Use this flag to always keep WARC files, even in case of success.\n\nExample command:\n\n```bash\ndocker run ghcr.io/openzim/zimit zimit --help\ndocker run ghcr.io/openzim/zimit warc2zim --help\ndocker run  -v /output:/output ghcr.io/openzim/zimit zimit --seeds URL --name myzimfile\n```\n\n**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 ...`).\n\nTo re-build the Docker image locally run:\n\n```bash\ndocker build -t ghcr.io/openzim/zimit .\n```\n\nFAQ\n---\n\nThe Zimit contributor's team maintains [a page with most Frequently Asked Questions](https://github.com/openzim/zimit/wiki/Frequently-Asked-Questions).\n\nNota bene\n---------\n\nWhile Zimit 1.x relied on a Service Worker to display the ZIM content, this is not anymore the case\nsince Zimit 2.x which does not have any special requirements anymore.\n\nIt should also be noted that a first version of a generic HTTP scraper was created in 2016 during\nthe [Wikimania Esino Lario\nHackathon](https://wikimania2016.wikimedia.org/wiki/Programme/Kiwix-dedicated_Hackathon).\n\nThat version is now considered outdated and [archived in `2016`\nbranch](https://github.com/openzim/zimit/tree/2016).\n\nLicense\n-------\n\n[GPLv3](https://www.gnu.org/licenses/gpl-3.0) or later, see\n[LICENSE](LICENSE) for more details.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fopenzim%2Fzimit","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fopenzim%2Fzimit","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fopenzim%2Fzimit/lists"}