8,236
edits
Difference between revisions of "Deployment/howto"
Jump to navigation
Jump to search
→Building your package
| Line 37: | Line 37: | ||
* [[kiwix-manage]], a tool to manipulate library XML file | * [[kiwix-manage]], a tool to manipulate library XML file | ||
* [[kiwix-install]], a tool which offers a simple way to create a data directory (beside the kiwix binary) with everything necessary (ZIM, index and library) and directly usable by kiwix. | * [[kiwix-install]], a tool which offers a simple way to create a data directory (beside the kiwix binary) with everything necessary (ZIM, index and library) and directly usable by kiwix. | ||
Kiwix knows about the available contents and indexes (to allow the fulltext search) by reading one (or many) so called ''library file(s)'' which are XML files ([[FeedFormat|more information about the XML format]]). In kiwix, you have the so called "[[library]]" (see screenshot beside) which is the visualisation of the information available about contents. Each time kiwix starts, it try to find thes XML library file to know more about available content. So, library XML files should be located to [[Library#Location|specific places]] and in general kiwix data storage follow [[Build_a_DVD#File_structure|these rules]]. | Kiwix knows about the available contents and indexes (to allow the fulltext search) by reading one (or many) so called ''library file(s)'' which are XML files ([[FeedFormat|more information about the XML format]]). In kiwix, you have the so called "[[library]]" (see screenshot beside) which is the visualisation of the information available about contents. Each time kiwix starts, it try to find thes XML library file to know more about available content. So, library XML files should be located to [[Library#Location|specific places]] and in general kiwix data storage follow [[Build_a_DVD#File_structure|these rules]]. | ||
| Line 53: | Line 49: | ||
At kiwix.org we have a PERL script to do that (and a few additional small things) quickly. If you are a PERL hacker you may [http://kiwix.svn.sourceforge.net/viewvc/kiwix/tools/scripts/buildDistributionFile.pl?view=markup have a look at it]. | At kiwix.org we have a PERL script to do that (and a few additional small things) quickly. If you are a PERL hacker you may [http://kiwix.svn.sourceforge.net/viewvc/kiwix/tools/scripts/buildDistributionFile.pl?view=markup have a look at it]. | ||
But, because kiwix-serve is less developed as kiwix, both still work a little bit differently. [[Kiwix-serve]] does not work with libraries, we still do not have implemented that. To run kiwix-serve, you simply need to have a ZIM file and a fulltext search index in option. To build the fulltext search index, you need the kiwix-index binary which is trivial to use. Currently, kiwix-serve only runs on GNU/Linux. If you have a permission issue, please you a port over 1024, otherwise, you will need root permission to run it. | |||
[[Kiwix-serve]] does not work with libraries, we still do not have implemented that. | |||
= Deploying == | = Deploying == | ||