YunoHost-Apps/wikijs_ynh
1
0
Fork 0
mirror of https://github.com/YunoHost-Apps/wikijs_ynh.git synced 2024-09-03 20:36:09 +02:00
Code Issues Activity Actions 1

wikijs_ynh readme reworked

Browse source
This commit is contained in:
Allan Nordhøy 2020-01-23 23:33:06 +01:00 committed by GitHub
parent cd74f3b514
commit df9f2c17c4
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 12 additions and 12 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

24
README.md
View file

@ -3,19 +3,19 @@
[![Integration level](https://dash.yunohost.org/integration/wikijs.svg)](https://dash.yunohost.org/appci/app/wikijs) [![Integration level](https://dash.yunohost.org/integration/wikijs.svg)](https://dash.yunohost.org/appci/app/wikijs)
[![Install wikijs with YunoHost](https://install-app.yunohost.org/install-with-yunohost.png)](https://install-app.yunohost.org/?app=wikijs) [![Install wikijs with YunoHost](https://install-app.yunohost.org/install-with-yunohost.png)](https://install-app.yunohost.org/?app=wikijs)
> *This package allow you to install wikijs quickly and simply on a YunoHost server. > *This package allows you to install wikijs easily and quickly on a YunoHost server.
If you don't have YunoHost, please see [here](https://yunohost.org/#/install) to know how to install and enjoy it.* If you don't have YunoHost, please look at [the guide](https://yunohost.org/#/install) to learn how to install it.*
## Overview ## Overview
An open source, modern and powerful wiki app built on Node.js, Git and Markdown for YunoHost. A copylefted libre software, modern and powerful wiki app built on Node.js, Git and Markdown for YunoHost.
**Shipped version:** 2.0.12 **Shipped version:** 2.0.12
## Important points to read before installing ## Important points before installing
**Wiki.js is still under development, all features not already implemented.** **Wiki.js is still under development, not all features are implemented yet.**
**Wiki.js** require a dedicated **root domain**, eg. wikijs.domain.tld **Wiki.js** requires a dedicated **root domain**, e.g. wikijs.domain.tld
## Screenshots ## Screenshots
@ -33,15 +33,15 @@ An open source, modern and powerful wiki app built on Node.js, Git and Markdown
## YunoHost specific features ## YunoHost specific features
#### Multi-users support #### Multi-user support
LDAP is implemented, root will receive a mail at the end of the installation or the upgrade with the informations to configure LDAP. 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 to be supported. No HTTP auth for now, but planned for the future.
The app can be used by multiple users The app can be used by multiple users.
#### Supported architectures #### Supported architectures
* x86-64b - [![Build Status](https://ci-apps.yunohost.org/ci/logs/wikijs%20%28Apps%29.svg)](https://ci-apps.yunohost.org/ci/apps/wikijs/) * x86-64 - [![Build Status](https://ci-apps.yunohost.org/ci/logs/wikijs%20%28Apps%29.svg)](https://ci-apps.yunohost.org/ci/apps/wikijs/)
* ARMv8-A - [![Build Status](https://ci-apps-arm.yunohost.org/ci/logs/wikijs%20%28Apps%29.svg)](https://ci-apps-arm.yunohost.org/ci/apps/wikijs/) * ARMv8-A - [![Build Status](https://ci-apps-arm.yunohost.org/ci/logs/wikijs%20%28Apps%29.svg)](https://ci-apps-arm.yunohost.org/ci/apps/wikijs/)
## Limitations ## Limitations
@ -60,7 +60,7 @@ The app can be used by multiple users
Developers info Developers info
---------------- ----------------
Please do your pull request to the [testing branch](https://github.com/YunoHost-Apps/wikijs_ynh/tree/testing). 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. To try the testing branch, please proceed like that.
``` ```