2021-07-05 20:41:40 +02:00
|
|
|
<!--
|
|
|
|
|
N.B.: This README was automatically generated by https://github.com/YunoHost/apps/tree/master/tools/README-generator
|
|
|
|
|
It shall NOT be edited by hand.
|
|
|
|
|
-->
|
|
|
|
|
|
2020-06-10 10:23:26 +02:00
|
|
|
# Wiki.js for YunoHost
|
2019-01-29 21:56:56 +01:00
|
|
|
|
2020-06-10 10:23:26 +02:00
|
|
|
[](https://dash.yunohost.org/appci/app/wikijs)  
|
2020-12-19 10:34:22 +01:00
|
|
|
[](https://install-app.yunohost.org/?app=wikijs)
|
2019-01-29 21:56:56 +01:00
|
|
|
|
2021-07-05 20:41:40 +02:00
|
|
|
*[Lire ce readme en français.](./README_fr.md)*
|
|
|
|
|
|
|
|
|
|
> *This package allows you to install Wiki.js quickly and simply on a YunoHost server.
|
2020-06-03 23:48:48 +02:00
|
|
|
If you don't have YunoHost, please consult [the guide](https://yunohost.org/#/install) to learn how to install it.*
|
2019-01-29 21:56:56 +01:00
|
|
|
|
|
|
|
|
## Overview
|
2019-01-30 04:49:25 +01:00
|
|
|
|
2021-07-05 20:41:40 +02:00
|
|
|
Open source, modern and powerful wiki app built on Node.js, Git and Markdown.
|
2019-07-14 18:41:53 +02:00
|
|
|
|
2021-10-05 23:35:21 +02:00
|
|
|
**Shipped version:** 2.5.219~ynh1
|
2019-07-14 18:41:53 +02:00
|
|
|
|
2021-07-05 20:41:40 +02:00
|
|
|
**Demo:** https://docs-beta.requarks.io/
|
2019-04-03 23:35:22 +02:00
|
|
|
|
2019-02-04 19:57:16 +01:00
|
|
|
## Screenshots
|
|
|
|
|
|
2021-07-05 20:41:40 +02:00
|
|
|
|
|
|
|
|
|
2019-01-29 21:56:56 +01:00
|
|
|
|
2021-07-05 20:41:40 +02:00
|
|
|
## Disclaimers / important information
|
2019-01-29 21:56:56 +01:00
|
|
|
|
2021-07-05 20:41:40 +02:00
|
|
|
* 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...
|
2019-01-29 21:56:56 +01:00
|
|
|
|
2021-07-05 20:41:40 +02:00
|
|
|
* 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 ?
|
2019-01-29 21:56:56 +01:00
|
|
|
|
2021-07-05 20:41:40 +02:00
|
|
|
## Documentation and resources
|
2019-01-29 21:56:56 +01:00
|
|
|
|
2021-07-05 20:41:40 +02:00
|
|
|
* 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
|
2019-01-29 21:56:56 +01:00
|
|
|
|
2020-09-22 15:45:01 +02:00
|
|
|
## Developer info
|
2019-01-29 21:56:56 +01:00
|
|
|
|
2020-06-10 10:23:26 +02:00
|
|
|
Please send your pull request to the [testing branch](https://github.com/YunoHost-Apps/wikijs_ynh/tree/testing).
|
2019-01-29 21:56:56 +01:00
|
|
|
|
|
|
|
|
To try the testing branch, please proceed like that.
|
|
|
|
|
```
|
2020-06-10 10:23:26 +02:00
|
|
|
sudo yunohost app install https://github.com/YunoHost-Apps/wikijs_ynh/tree/testing --debug
|
2019-01-29 21:56:56 +01:00
|
|
|
or
|
2020-06-10 10:23:26 +02:00
|
|
|
sudo yunohost app upgrade wikijs -u https://github.com/YunoHost-Apps/wikijs_ynh/tree/testing --debug
|
2019-01-29 21:56:56 +01:00
|
|
|
```
|
2021-07-05 20:41:40 +02:00
|
|
|
|
|
|
|
|
**More info regarding app packaging:** https://yunohost.org/packaging_apps
|
