mirror of https://github.com/YunoHost-Apps/kiwix_ynh.git synced 2024-09-03 19:35:56 +02:00

Kiwix package for YunoHost

Find a file

Éric Gaspar c97716a0f9 cleaning		2023-08-16 11:30:45 +02:00
.github	Add .github	2022-02-24 00:10:56 +01:00
conf	systemd: Fix daemonize option which leaves the service as "exited"	2023-08-13 13:30:54 +02:00
doc	Cleaning	2023-08-13 14:40:03 +02:00
scripts	cleaning	2023-08-16 11:30:45 +02:00
config_panel.toml	Update config_panel.toml	2023-08-13 14:15:54 +02:00
LICENSE	First commit	2022-01-18 11:02:42 +01:00
manifest.toml	Update manifest.toml	2023-08-13 14:32:59 +02:00
README.md	Auto-update README	2023-08-13 12:24:53 +00:00
README_fr.md	Auto-update README	2023-08-13 12:24:53 +00:00
tests.toml	v2	2023-05-01 12:44:37 +02:00

README.md

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
Compatible with almost all browsers
Available as command line executable
Embedded in Kiwix UI
Able to deal with one ZIM file or XML library files

Shipped version: 3.5.0~ynh4

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

Screenshots

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