mirror of https://github.com/YunoHost-Apps/wikijs_ynh.git synced 2024-09-03 20:36:09 +02:00

Modern and powerful wiki app package for YunoHost

Find a file

yunohost-bot b69e5d323d Auto-update README		2024-01-13 08:27:56 +00:00
.github	Update updater.sh	2023-08-04 21:00:04 +02:00
conf	Upgrade to v2.5.300	2023-08-11 06:18:41 +00:00
doc	fix	2024-01-13 09:27:50 +01:00
scripts	fix linter	2024-01-12 21:38:28 +01:00
.DS_Store	fix	2024-01-13 09:27:50 +01:00
.gitignore	Fix bad path for the application	2019-01-29 22:09:48 +01:00
check_process	Update check_process	2023-10-27 16:52:49 +02:00
LICENSE	first commit	2019-01-29 21:56:56 +01:00
manifest.json	Update manifest.json	2023-11-18 18:23:09 +01:00
README.md	Auto-update README	2024-01-13 08:27:56 +00:00
README_fr.md	Auto-update README	2024-01-13 08:27:56 +00:00

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.300~ynh2

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/
Upstream app code repository: https://github.com/Requarks/wiki
YunoHost Store: https://apps.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