# Wiki.js for YunoHost
[![Integration level](https://dash.yunohost.org/integration/wikijs.svg)](https://dash.yunohost.org/appci/app/wikijs) ![Working status](https://ci-apps.yunohost.org/ci/badges/wikijs.status.svg) ![Maintenance status](https://ci-apps.yunohost.org/ci/badges/wikijs.maintain.svg)
[![Install Wiki.js with YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=wikijs)
*[Lire ce readme en français.](./README_fr.md)*
> *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](https://yunohost.org/#/install) 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
![Screenshot of Wiki.js](./doc/screenshots/screenshot1.png)
## 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:
* Official user documentation:
* Upstream app code repository:
* YunoHost Store:
* Report a bug:
## Developer info
Please send your pull request to the [testing branch](https://github.com/YunoHost-Apps/wikijs_ynh/tree/testing).
To try the testing branch, please proceed like that.
``` bash
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:**