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
|
|
|
|
2020-06-10 10:23:26 +02:00
|
|
|
> *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
|
2020-09-22 15:45:01 +02:00
|
|
|
Wiki.js is a copylefted libre software, modern and powerful wiki app built on Node.js, Git and Markdown for YunoHost.
|
2019-01-30 04:49:25 +01:00
|
|
|
|
2021-03-30 00:10:01 +02:00
|
|
|
**Shipped version:** 2.5.197
|
2019-07-14 18:41:53 +02:00
|
|
|
|
2020-01-23 23:33:06 +01:00
|
|
|
## Important points before installing
|
2019-07-14 18:41:53 +02:00
|
|
|
|
2020-01-23 23:33:06 +01:00
|
|
|
**Wiki.js** requires a dedicated **root domain**, e.g. wikijs.domain.tld
|
2019-04-03 23:35:22 +02:00
|
|
|
|
2019-02-04 19:57:16 +01:00
|
|
|
## Screenshots
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
2019-01-29 21:56:56 +01:00
|
|
|
## Demo
|
|
|
|
|
|
|
|
|
|
* [Official demo](https://docs-beta.requarks.io/)
|
|
|
|
|
|
|
|
|
|
## Documentation
|
|
|
|
|
|
|
|
|
|
* Official documentation: https://docs-beta.requarks.io/
|
2020-09-22 15:45:01 +02:00
|
|
|
* YunoHost documentation: https://yunohost.org/#/app_wikijs
|
2019-01-29 21:56:56 +01:00
|
|
|
|
|
|
|
|
## YunoHost specific features
|
|
|
|
|
|
2020-01-23 23:33:06 +01:00
|
|
|
#### Multi-user support
|
2019-01-29 21:56:56 +01:00
|
|
|
|
2020-01-23 23:33:06 +01:00
|
|
|
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 can be used by multiple users.
|
2019-01-29 21:56:56 +01:00
|
|
|
|
|
|
|
|
#### Supported architectures
|
|
|
|
|
|
2020-06-10 10:23:26 +02:00
|
|
|
* x86-64 - [](https://ci-apps.yunohost.org/ci/apps/wikijs/)
|
|
|
|
|
* ARMv8-A - [](https://ci-apps-arm.yunohost.org/ci/apps/wikijs/)
|
2019-01-29 21:56:56 +01:00
|
|
|
|
|
|
|
|
## Limitations
|
|
|
|
|
|
|
|
|
|
* No known limitations.
|
|
|
|
|
|
|
|
|
|
## Links
|
|
|
|
|
|
|
|
|
|
* Report a bug: https://github.com/YunoHost-Apps/wikijs_ynh/issues
|
|
|
|
|
* App website: https://wiki.js.org/
|
2020-06-03 23:48:48 +02:00
|
|
|
* Upstream app repository: https://github.com/Requarks/wiki
|
2019-01-29 21:56:56 +01:00
|
|
|
* YunoHost website: https://yunohost.org/
|
|
|
|
|
|
|
|
|
|
---
|
|
|
|
|
|
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
|
|
|
```
|
