yeray/custom_nodejs_ynh
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Auto-update README

Browse Source
This commit is contained in:
Yunohost-Bot
2021-07-05 18:41:40 +00:00
committed by Yunohost-Bot
parent 55fcd670bf
commit 3fc125854f
2 changed files with 94 additions and 38 deletions
Download Patch File Download Diff File Expand all files Collapse all files

72
README.md
View File

@@ -1,60 +1,54 @@
<!--
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.
-->
# Wiki.js for YunoHost
[![Integration level](https://dash.yunohost.org/integration/wikijs.svg)](https://dash.yunohost.org/appci/app/wikijs) ![](https://ci-apps.yunohost.org/ci/badges/wikijs.status.svg) ![](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)
> *This package allows you to install Wiki.js quickly and simply on a YunoHost server.
*[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.201
Open source, modern and powerful wiki app built on Node.js, Git and Markdown.
## Important points before installing
**Shipped version:** 2.5.201~ynh3
**Wiki.js** requires a dedicated **root domain**, e.g. wikijs.domain.tld
**Demo:** https://docs-beta.requarks.io/
## Screenshots
![wikijs-screenshot1](https://user-images.githubusercontent.com/30271971/52230053-b9ed3400-28b6-11e9-945e-355a752b8391.png)
![](./doc/screenshots/screenshot2.png)
![](./doc/screenshots/screenshot1.png)
![wikijs-screenshot2](https://user-images.githubusercontent.com/30271971/52230062-beb1e800-28b6-11e9-99c1-2bd04857600e.png)
## Disclaimers / important information
## Demo
* 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...
* [Official demo](https://docs-beta.requarks.io/)
* 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
## Documentation and resources
* Official documentation: https://docs-beta.requarks.io/
* YunoHost documentation: https://yunohost.org/en/app_wikijs
## YunoHost specific features
#### Multi-user support
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.
#### Supported architectures
* x86-64 - [![Build Status](https://ci-apps.yunohost.org/ci/logs/wikijs.svg)](https://ci-apps.yunohost.org/ci/apps/wikijs/)
* ARMv8-A - [![Build Status](https://ci-apps-arm.yunohost.org/ci/logs/wikijs.svg)](https://ci-apps-arm.yunohost.org/ci/apps/wikijs/)
## Limitations
* No known limitations.
## Links
* Report a bug: https://github.com/YunoHost-Apps/wikijs_ynh/issues
* App website: https://wiki.js.org/
* Upstream app repository: https://github.com/Requarks/wiki
* YunoHost website: https://yunohost.org/
---
* 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
@@ -66,3 +60,5 @@ sudo yunohost app install https://github.com/YunoHost-Apps/wikijs_ynh/tree/testi
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