Kiwix for YunoHost

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~ynh1

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

Screenshots

Disclaimers / important information

Any known limitations, constrains or stuff not working, such as (but not limited to):
- requiring a full dedicated domain ?
- architectures not supported ?
- not-working single-sign on or LDAP integration ?
- the app requires an important amount of RAM / disk / .. to install or to work properly
- etc...
Other infos that people should be aware of, such as:
- any specific step to perform after installing (such as manually finishing the install, specific admin credentials, ...)
- how to configure / administrate the application if it ain't obvious
- upgrade process / specificities / things to be aware of ?
- security considerations ?

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
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

3 KiB Raw Blame History