From 58f63b75a3e1261e94970f2788d3e515ce115718 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?R=C3=A9my=20HUBSCHER?= Date: Sun, 10 Jan 2016 11:44:03 +0100 Subject: [PATCH] Improve the ZIMIT README. --- README.rst | 37 +++++++++++++++++++++++++++++++++++++ zimit.ini | 2 +- 2 files changed, 38 insertions(+), 1 deletion(-) diff --git a/README.rst b/README.rst index c065623..e130217 100644 --- a/README.rst +++ b/README.rst @@ -1,3 +1,4 @@ +##################################### Create ZIM files out of HTTP websites ##################################### @@ -16,6 +17,7 @@ Then, run it how you want, for instance with pserve:: $ pserve zimit.ini + In a separate process, you also need to run the worker:: $ rqworker @@ -25,3 +27,38 @@ To test it:: $ http POST http://0.0.0.0:6543/website url="https://refugeeinfo.eu/" title="Refugee Info" email="alexis@notmyidea.org" + + +Ubuntu dependencies +################### + +You will need to install the following packages: + +- zimwriterfs +- httrack + +Installing the dependencies +=========================== + +:: + + sudo apt-get install httrack libzim-dev libmagic-dev liblzma-dev libz-dev build-essential + +Installing zimwriterfs +====================== + +:: + + git clone https://github.com/wikimedia/openzim.git + cd openzim/zimwriterfs + ./autogen.sh + ./configure + make + +Then upgrade the path to zimwriterfs executable in zimit.ini + +:: + + $ rqworker & pserve zimit.ini + +That's it! diff --git a/zimit.ini b/zimit.ini index 762ddfe..7fcc6a2 100644 --- a/zimit.ini +++ b/zimit.ini @@ -8,7 +8,7 @@ pyramid.debug_routematch = false pyramid.debug_templates = true pyramid.default_locale_name = en -zimit.zimwriterfs_bin = /home/alexis/dev/openzim/zimwriterfs/zimwriterfs +zimit.zimwriterfs_bin = /home/rhubscher/git/openzim/zimwriterfs/zimwriterfs zimit.httrack_bin = /usr/bin/httrack [server:main]