diff --git a/roles/kiwix/README.rst b/roles/kiwix/README.rst index 4bc7670cc..e208742c7 100644 --- a/roles/kiwix/README.rst +++ b/roles/kiwix/README.rst @@ -1,16 +1,19 @@ ============ -KIWIX README +Kiwix README ============ -Kiwix is a set of Zim File readers from http://www.kiwix.org/wiki/Main_Page +Kiwix develops ZIM file creation & rendering tools for offline action, +as summarized at: http://wiki.kiwix.org/wiki/Software + We are using the kiwix-serve and kiwix-manage executables to setup and -render wikipedia and other web sources in zim format. +render Wikipedia and other web sources in ZIM format. Locations --------- -- The ZIM files are expected to be in /library/zims/content -- The ZIM index files are expected to be in directories under /library/zims/index -- The URL is /kiwix +- Your ZIM files are expected to be in /library/zims/content +- Your ZIM index files are expected to be in directories under /library/zims/index +- The URL is http://box:3000 -The library.xml file can be recalculated by running iiab-make-kiwix-lib. +Your local ZIM catalog (at /library/zims/library.xml) can be +regenerated by running: iiab-make-kiwix-lib