wikijs_ynh/README.md

Wiki.js for YunoHost

Lire ce readme en français.

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

Overview

Wiki.js is a copylefted libre software, modern and powerful wiki app built on Node.js, Git and Markdown for YunoHost.

Shipped version: 2.5.268~ynh1

Demo: https://docs-beta.requarks.io/

Screenshots

Disclaimers / important information

• Wiki.js requires a dedicated root domain, e.g. wikijs.domain.tld
• LDAP is implemented, root will receive an e-mail at the end of the installation or the upgrade with the info on how to configure LDAP.
• No HTTP auth for now, but planned for the future.

Documentation and resources

• Official app website: https://wiki.js.org/
• Official user documentation: https://docs-beta.requarks.io/
• Official admin documentation: https://yunohost.org/en/app_wikijs
• Upstream app code repository: https://github.com/Requarks/wiki
• YunoHost documentation for this app: https://yunohost.org/app_wikijs
• Report a bug: https://github.com/YunoHost-Apps/wikijs_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/wikijs_ynh/tree/testing --debug
or
sudo yunohost app upgrade wikijs -u https://github.com/YunoHost-Apps/wikijs_ynh/tree/testing --debug

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