Contribute a ZIM file

From openZIM
Revision as of 12:42, 25 September 2026 by Benoit74B (talk | contribs)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to navigation Jump to search

There are two distinct ways to contribute ZIM files to the Kiwix ecosystem:

  • help us in creating and maintaining recipes on the Zimfarm; or
  • create ZIM files on your own and propose them to Kiwix for public release to the community.

In both cases, Kiwix/openZIM rules continue to apply, especially Content_team#Publishing content team publishing policies.

Creating and maintaining recipes

Kiwix will start onboarding power users to help with the backlog of MediaWiki-based websites that have been suggested for inclusion in the Kiwix catalogue.

If you are interested, feel free to reach out on the #mwoffliner channel on Slack..

ZIMs contributed this way will join the official collection and be available to all Kiwix readers. We therefore require ZIMs created through this path to meet all quality expectations before they can reach a production stage.

Contributing your own ZIM files

Kiwix has launched a new community collection on the CMS, visible at https://community.library.kiwix.org.

The goal is to recognize the added value of community-generated ZIMs that cover content we don't yet publish.

This being said Kiwix will, at its sole discretion, ensure that only ZIMs matching its publication policy and a minimum quality will be published.

If you have generated you own ZIM files already and would like to share them with the community, process is:

  • [User]: create a user account on https://cms.openzim.org
  • [User]: open an Github issue on Github indicating the ZIM name, description, and your user name on CMS
  • [Kiwix]: create the title(s) and grant access to upload to the user
  • [Kiwix]: confirm link to title(s) in Github issue
  • [User]: upload ZIM(s)
  • [Kiwix]: review, provide feedback for iterations if needed in Github issue
  • [User]: optional, fix ZIM based on feedback and re-upload
  • [Kiwix]: review and promote to production ; close Github issue

Next time user has updated his ZIM:

  • [User]: upload ZIM(s)
  • [Kiwix]: review and promote to production

Only if a new issue is detected in the review, a new Github issue is opened. No need for a new issue each time a ZIM is uploaded.

Retrieved from "https://wiki.openzim.org/w/index.php?title=Contribute_a_ZIM_file&oldid=31510"