YunoHost-Apps/kiwix_ynh
1
0
Fork 0
mirror of https://github.com/YunoHost-Apps/kiwix_ynh.git synced 2024-09-03 19:35:56 +02:00
Code Issues Activity Actions
Kiwix package for YunoHost
5 commits 2 branches 0 tags 366 KiB
Shell 100%
Find a file
ericgaspar d2230bcbec
Revert "Update amd64.src" 
This reverts commit 897b89c677.
2022-01-18 11:44:58 +01:00
conf Revert "Update amd64.src" 2022-01-18 11:44:58 +01:00
doc First commit 2022-01-18 11:02:42 +01:00
scripts Fix 2022-01-18 11:18:11 +01:00
sources First commit 2022-01-18 11:02:42 +01:00
check_process First commit 2022-01-18 11:02:42 +01:00
config_panel.toml.example First commit 2022-01-18 11:02:42 +01:00
LICENSE First commit 2022-01-18 11:02:42 +01:00
manifest.json First commit 2022-01-18 11:02:42 +01:00
README.md Auto-update README 2022-01-18 10:02:48 +00:00
README_fr.md Auto-update README 2022-01-18 10:02:48 +00:00

README.md

Kiwix for YunoHost

Integration level
Install Kiwix with 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~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

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