1
edit
Difference between revisions of "Kiwix-serve"
Jump to navigation
Jump to search
m
adding OPDS feature link, extending options
(Kiwix-serve moved to Kiwix-serve/en: ) |
Spiritdude (talk | contribs) m (adding OPDS feature link, extending options) |
||
| (14 intermediate revisions by 4 users not shown) | |||
| Line 1: | Line 1: | ||
{{translations}} | |||
[[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 its help you can deliver ZIM file content over your network.</translate> | |||
<translate><!--T:4--> | |||
Based on the well known HTTP protocol, kiwix-serve allows you to share the [[Special:MyLanguage/Wikipedia_in_all_languages|ZIM files available]] on your computer easily with others connected to your network. You simply need to start kiwix-serve and your content will be 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 | |||
* Search suggestions | |||
* Really small and efficient | |||
* Compatible with almost all browsers | |||
* Available on all platforms | |||
* 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 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 newly provide kiwix-serve as part of the Kiwix tools and [https://download.kiwix.org/release/kiwix-tools/ pre-compiled binaries for many 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> | |||
<translate><!--T:14--> | |||
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 data directory).</translate> | |||
<translate><!--T:15--> | |||
Unix command line (just use kiwix-serve.exe on Microsoft Windows) example to start kiwix-serve with an XML library file: | |||
<source lang="bash"> | |||
kiwix-serve --library ~/.www.kiwix.org/kiwix/efrnsupg.default/data/library/library.xml | |||
</source></translate> | |||
<translate><!--T:16--> | |||
Unix command line example to start kiwix-serve with a ZIM file: | |||
<source lang="bash"> | |||
kiwix-serve --port=8080 wikipedia.zim | |||
</source></translate> | |||
<translate><!--T:17--> | |||
Once kiwix-serve is started, anyone with access to this computer 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/ | |||
</source></translate> | |||
== <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) | |||
* <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 | |||
* <code>--address=IP</code> to bind a particular IP (per default 0.0.0.0 = all interfaces) | |||
</translate> | |||
== <translate><!--T:21--> | |||
See also</translate> == | |||
<translate><!--T:22--> | |||
* [[kiwix-manage]] | |||
* [[kiwix-plug]]</translate> | |||
* [http://kv5r.com/computers/offline-dictionary-server/ How-to setup kiwix.exe as a Windows service] | |||