1
edit
Difference between revisions of "Kiwix-serve"
Jump to navigation
Jump to search
m
adding OPDS feature link, extending options
(typos found with languagetool.org) |
Spiritdude (talk | contribs) m (adding OPDS feature link, extending options) |
||
| (6 intermediate revisions by 4 users not shown) | |||
| Line 25: | Line 25: | ||
* Available as command line executable | * Available as command line executable | ||
* Embedded in Kiwix UI | * Embedded in Kiwix UI | ||
* Able to deal with one ZIM file or XML library files</translate> | * Able to deal with one ZIM file or XML library files | ||
* [[OPDS|RESTful API endpoint with OPDS (XML)]]</translate> | |||
== <translate><!--T:8--> | == <translate><!--T:8--> | ||
Get it</translate> == | Get it</translate> == | ||
<translate><!--T:9--> | <translate><!--T:9--> | ||
On Microsoft Windows, Apple Mac | 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--> | <translate><!--T:10--> | ||
We | 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--> | <translate><!--T:11--> | ||
| Line 46: | Line 47: | ||
Prerequisites: | Prerequisites: | ||
* kiwix-serve binary, available in the Kiwix application directory | * 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 | * A ZIM file or a library file (you can use the library.xml file available in your Kiwix data directory).</translate> | ||
<translate><!--T:15--> | <translate><!--T:15--> | ||
Unix command line (just use kiwix-serve.exe on Microsoft Windows) example to start kiwix-serve with | Unix command line (just use kiwix-serve.exe on Microsoft Windows) example to start kiwix-serve with an XML library file: | ||
<source lang="bash"> | <source lang="bash"> | ||
kiwix-serve --library ~/.www.kiwix.org/kiwix/efrnsupg.default/library.xml | kiwix-serve --library ~/.www.kiwix.org/kiwix/efrnsupg.default/data/library/library.xml | ||
</source></translate> | </source></translate> | ||
| Line 70: | Line 71: | ||
<translate><!--T:19--> | <translate><!--T:19--> | ||
Kiwix-serve provides a few options: | Kiwix-serve provides a few options: | ||
* --port=PORT to specify the port you want to open for listening (per default 80) | * <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 | |||
* --attachToProcess=PID to attach kiwix-serve process to other process | * <code>--verbose</code> to get a few logs | ||
* --verbose 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--> | == <translate><!--T:21--> | ||
See also</translate> == | See also</translate> == | ||
<translate><!--T:22--> | <translate><!--T:22--> | ||
* [[kiwix-manage]] | * [[kiwix-manage]] | ||
* [[kiwix-plug]]</translate> | * [[kiwix-plug]]</translate> | ||
* [http://kv5r.com/computers/offline-dictionary-server/ How-to setup kiwix.exe as a Windows service] | |||