Difference between revisions of "Deployment/howto"

Line 31:

[[File:Library screenshot.png|right|thumb|Screenshot of the library in Kiwix]]

Before deploying the solution, you have to put your content (the ZIM file(s)) with Kiwix (the software itself). Maybe The Kiwix project already did it for you, so check [http://download.kiwix.org/portable/ here] to see if you ~~have your package~~. Otherwise, you will have to do it by yourself~~. This~~ part of the process is the most complicated.

Before deploying the solution, you have to put your content (the ZIM file(s)) with Kiwix (the software itself). Maybe The Kiwix project already did it for you, so check [http://download.kiwix.org/portable/ here] to see if we already provide what you need. Otherwise, you will have to do it by yourself and this part of the process is the most complicated.

To ~~do that you will need the help of~~ 3 different console tools:

To build packages, 3 different console tools are available:

* [[kiwix-index]], a tool to create a fulltext search index

* [[kiwix-index]], a tool to create a fulltext search index,

* [[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.

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].

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.

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 open a port over 1024, otherwise, you will need root permission to run it.

= Deploying =

Difference between revisions of "Deployment/howto"

Navigation menu

Search

@@ Line 31: / Line 31: @@
 [[File:Library screenshot.png|right|thumb|Screenshot of the library in Kiwix]]
-Before deploying the solution, you have to put your content (the ZIM file(s)) with Kiwix (the software itself). Maybe The Kiwix project already did it for you, so check [http://download.kiwix.org/portable/ here] to see if you have your package. Otherwise, you will have to do it by yourself. This part of the process is the most complicated.
+Before deploying the solution, you have to put your content (the ZIM file(s)) with Kiwix (the software itself). Maybe The Kiwix project already did it for you, so check [http://download.kiwix.org/portable/ here] to see if we already provide what you need. Otherwise, you will have to do it by yourself and this part of the process is the most complicated.
-To do that you will need the help of 3 different console tools:
+To build packages, 3 different console tools are available:
-* [[kiwix-index]], a tool to create a fulltext search index
+* [[kiwix-index]], a tool to create a fulltext search index,
-* [[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.
@@ Line 49: / 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].
-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.
+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 open a port over 1024, otherwise, you will need root permission to run it.
 = Deploying =