Tell us your story
Tell us your story
How has offline Wikipedia affected you? The Wikimedia Foundation (the non-profit that supports Wikipedia) is looking for personal, diverse and inspiring stories about how offline Wikipedia affects the world. If you have a personal story that you would like to share, please contact: Thank you!


Jump to: navigation, search


820 bytes added, 4 months ago
adding OPDS feature link, extending options
[[File:Kiwix_0.9_rc2_article_served_en_screenshot.png|right|thumb|<translate><!--T:1-->Kiwix-serve, embedded in Kiwix, on a Microsoft Windows computer</translate>]][[File:Two_kiwix-plugs.jpg|right|thumb|<translate><!--T:2-->With [[Kiwix-plug]], kiwix-serve runs on pretty small hardwares</translate>]]
<translate><!--T:3-->'''Kiwix-serve is a ZIM compatible Web server.''' With it's its help you can deliver ZIM file content over your network.</translate>
<translate><!--T:4-->Based on the well known HTTP protocol HTTP, kiwix-serve allows you to share the [[Special:MyLanguage/Wikipedia_in_all_languages|ZIM files available]] on your computer easily with the other computers others connected to your network. You simply need to start kiwix-serve on and your computer and others content will be able to access it with available for anybody through their own Web browser.</translate>
<translate><!--T:5-->Kiwix-serve is a good solution if you have a LAN network and don't want to install Kiwix on all computers. It's a good alternative if you don't have a shared network disk from which everybody can start Kiwix.</translate>
== <translate><!--T:6-->Features </translate> ==<translate><!--T:7-->
Kiwix-serve has not so many features like Kiwix, but provides the most important ones:
* Full text search engine
* Embedded in Kiwix UI
* Able to deal with one ZIM file or XML library files
* [[OPDS|RESTful API endpoint with OPDS (XML)]]</translate>
== <translate><!--T:8-->Get it </translate> ==<translate><!--T:9-->On Microsoft Windows, Apple Mac OSX OS X and GNU/Linux, kiwix-serve is packaged and distributed with Kiwix. You simply need to [[Special:MyLanguage/Software|download the Kiwix installer corresponding to your Operating System]].</translate>
<translate><!--T:10-->We also newly provide kiwix-serve as part of the Kiwix tools and [https://sourceforgedownload.kiwix.netorg/projectsrelease/kiwix/files-tools/ pre-compiled binaries for ARM GNU/Linuxmany systems are available].</translate>
<translate><!--T:11-->For other systems, you will have to [[compilation|download and compile kiwix-serve source code on your own]].</translate>
== <translate><!--T:12-->Use it </translate> ==<translate><!--T:13-->Kiwix-serve is directly available in the Kiwix menu "Tools > server", but for people wanting to use it from the command line, here is how it works.</translate>
* kiwix-serve binary, available in the Kiwix application directory
* A ZIM file or a library file (you can use the library.xml file available in your Kiwix user profiledata directory).</translate>
<translate><!--T:15-->Unix command line (just use kiwix-serve.exe on Microsoft Windows) example to start kiwix-serve with a an XML library file:
<source lang="bash">
kiwix-serve --library ~/</source></translate>
Unix command line example to start kiwix-serve with a ZIM file:
<source lang="bash">
kiwix-serve --port=8080 wikipedia.zim
One time <translate><!--T:17-->Once kiwix-serve is started, everybody, who has anyone with access to this computer per over the network, will be able to connect to it. You need to retrieve the IP ( of your computer and remember the port (per default 80) you have used and then people will only have to type in their browser address bar:
<source lang="bash">
== <translate><!--T:18-->Options </translate> ==<translate><!--T:19-->
Kiwix-serve provides a few options:
* <code>--port=PORT </code> to specify the port you want to open for listening (per default 80)* --index=foobar.ix to specify an fulltext index directory* <code>--daemon </code> to execute the software in background* <code>--attachToProcess=PID </code> to attach kiwix-serve process to other process* <code>--verbose </code> to get a few logs You can also run kiwix* <code>--serve without index, but in this case you won't have access address=IP</code> to the fulltext search enginebind a particular IP (per default = all interfaces)</translate>== <translate><!--T:21-->See also </translate> ==* [http<translate><!--T:// kiwix22-serve demonstration instance]* [[kiwix-index]]>
* [[kiwix-manage]]
* [[kiwix-plug]]</translate>* [ How-to setup kiwix.exe as a Windows service]

Navigation menu