mirror of
https://github.com/YunoHost-Apps/wikijs_ynh.git
synced 2024-09-03 20:36:09 +02:00
Auto-update README
This commit is contained in:
Yunohost-Bot
Yunohost-Bot
parent
55fcd670bf
commit
3fc125854f
2 changed files with 94 additions and 38 deletions
72
README.md
72
README.md
|
|
@ -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
|
||||
|
||||
[](https://dash.yunohost.org/appci/app/wikijs)  
|
||||
[](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
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
## 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 - [](https://ci-apps.yunohost.org/ci/apps/wikijs/)
|
||||
* ARMv8-A - [](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
|
||||
60
README_fr.md
Normal file
60
README_fr.md
Normal file
|
|
@ -0,0 +1,60 @@
|
|||
# Wiki.js pour YunoHost
|
||||
|
||||
[](https://dash.yunohost.org/appci/app/wikijs)  
|
||||
[](https://install-app.yunohost.org/?app=wikijs)
|
||||
|
||||
*[Read this readme in english.](./README.md)*
|
||||
*[Lire ce readme en français.](./README_fr.md)*
|
||||
|
||||
> *Ce package vous permet d'installer Wiki.js rapidement et simplement sur un serveur YunoHost.
|
||||
Si vous n'avez pas YunoHost, regardez [ici](https://yunohost.org/#/install) pour savoir comment l'installer et en profiter.*
|
||||
|
||||
## Vue d'ensemble
|
||||
|
||||
Wiki moderne et open source propulsé Node.js, Git et Markdown.
|
||||
|
||||
**Version incluse :** 2.5.201~ynh3
|
||||
|
||||
**Démo :** https://docs-beta.requarks.io/
|
||||
|
||||
## Captures d'écran
|
||||
|
||||
|
||||
|
||||
|
||||
## Avertissements / informations importantes
|
||||
|
||||
* 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...
|
||||
|
||||
* 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 ?
|
||||
|
||||
## Documentations et ressources
|
||||
|
||||
* Site officiel de l'app : https://wiki.js.org/
|
||||
* Documentation officielle utilisateur : https://docs-beta.requarks.io/
|
||||
* Documentation officielle de l'admin : https://yunohost.org/en/app_wikijs
|
||||
* Dépôt de code officiel de l'app : https://github.com/Requarks/wiki
|
||||
* Documentation YunoHost pour cette app : https://yunohost.org/app_wikijs
|
||||
* Signaler un bug : https://github.com/YunoHost-Apps/wikijs_ynh/issues
|
||||
|
||||
## Informations pour les développeurs
|
||||
|
||||
Merci de faire vos pull request sur la [branche testing](https://github.com/YunoHost-Apps/wikijs_ynh/tree/testing).
|
||||
|
||||
Pour essayer la branche testing, procédez comme suit.
|
||||
```
|
||||
sudo yunohost app install https://github.com/YunoHost-Apps/wikijs_ynh/tree/testing --debug
|
||||
ou
|
||||
sudo yunohost app upgrade wikijs -u https://github.com/YunoHost-Apps/wikijs_ynh/tree/testing --debug
|
||||
```
|
||||
|
||||
**Plus d'infos sur le packaging d'applications :** https://yunohost.org/packaging_apps
|
||||
Loading…
Reference in a new issue