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: stories@kiwix.org. Thank you!

Changes

Jump to: navigation, search

Kiwix-serve

75 bytes added, 5 months ago
m
adding OPDS feature link, extending options
<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-->
* Available as command line executable
* 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-->
Prerequisites:
* 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 ~/.www.kiwix.org/kiwix/efrnsupg.default/data/library/library.xml
</source></translate>
<translate><!--T:17-->
One time 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 (xxx.xxx.xxx.xxx) 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">
http://xxx.xxx.xxx.xxx:80/
<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.idx 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</translate> * <translatecode><!--T:20--address=IP</code>You can also run kiwix-serve without index, but in this case you won't have access to the fulltext search enginebind a particular IP (per default 0.0.0.0 = all interfaces)</translate> 
== <translate><!--T:21-->
See also</translate> ==
<translate><!--T:22-->
* [http://library.kiwix.org kiwix-serve demonstration instance]
* [[kiwix-index]]
* [[kiwix-manage]]
* [[kiwix-plug]]</translate>
* [http://kv5r.com/computers/offline-dictionary-server/ How-to setup kiwix.exe as a Windows service]
1
edit

Navigation menu