Build your ZIM file

From openZIM
Revision as of 22:58, 23 September 2009 by Ijon (talk | contribs) (Fixed typos and added clarification)
Jump to: navigation, search
Schema ZIM File Creation.png

There is currently only one binary to build a ZIM file, the ZIMwriter. This binary uses a pre-filled Postgres Database with a predefined scheme. For example :

zimwriter -s 1024 
  --db "postgresql:dbname=mydb" my_zim_file

We want to provide in the future a binary able to work with other input (for example: Wikimedia Foundation XML dumps, or HTML directory).

One tool is currently able to create/fill this database:

This script is part of the Kiwix tools and allows to build a ZIM file from a HTML directory containing all necessary ressources.

You need:

  1. Checkout the dumping tools : svn co
  2. Install all necessary Perl modules
  3. run the script like following: ./ --htmlPath=./html [--indexerPath=./zimindexer] [--zimFilePath=articles.zim]


(can be used to prepare static HTML files from a running Mediawiki instance.)

See also