Build your ZIM file

From openZIM
Jump to navigation Jump to 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 predined 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).

Two tools are currently able to create/fill this database.

buildZimFileFromDirectory.pl

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 http://kiwix.svn.sourceforge.net/viewvc/kiwix/dumping_tools/
  2. Install all necessary PERL modules
  3. run the script like following: ./builZimFileFromDirectory.pl --htmlPath=./html [--indexerPath=./zimindexer] [--zimFilePath=articles.zim]

Wiki2html

...

See also