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

Open source powerful wiki app built on Node.js, Git and Markdown

Shipped version: 2.5.219~ynh1

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

Screenshots

Disclaimers / important information

• Any known limitations, constrains or stuff not working, such as (but not limited to):

  • 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.
  • 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://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