Kiwix for YunoHost

Lire ce readme en français.

This package allows you to install Kiwix quickly and simply on a YunoHost server. If you don't have YunoHost, please consult the guide to learn how to install it.

Overview

Kiwix is an offline reader for online content like Wikipedia, Project Gutenberg, or TED Talks. It makes knowledge available to people with no or limited internet access. The software as well as the content is free to use for anyone.

Features

• 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
• RESTful API endpoint with OPDS (XML)

Shipped version: 3.1.2~ynh2

Demo: http://library.kiwix.org/

Screenshots

Disclaimers / important information

How to add zim files?

• Download one or more ZIM files, e.g. from https://download.kiwix.org/zim/
• Put the ZIM files into /home/yunohost.app/kiwix/
• Add them to the library with the following command:

/var/www/kiwix/kiwix-manage /home/yunohost.app/kiwix/library.xml add /home/yunohost.app/kiwix/*.zim

• Restart the service:

yunohost service restart kiwix

Documentation and resources

• Official app website: https://www.kiwix.org/
• Official admin documentation: https://wiki.kiwix.org/wiki/Kiwix-serve/
• Upstream app code repository: https://github.com/kiwix/kiwix-tools
• YunoHost documentation for this app: https://yunohost.org/app_kiwix
• Report a bug: https://github.com/YunoHost-Apps/kiwix_ynh/issues

Developer info

Please send your pull request to the testing branch.

To try the testing branch, please proceed like that.

sudo yunohost app install https://github.com/YunoHost-Apps/kiwix_ynh/tree/testing --debug
or
sudo yunohost app upgrade kiwix -u https://github.com/YunoHost-Apps/kiwix_ynh/tree/testing --debug

More info regarding app packaging: https://yunohost.org/packaging_apps