2021-02-01 14:42:41 +01:00
# BookStack pour YunoHost
2021-06-22 08:41:26 +02:00
[![Niveau d'intégration ](https://dash.yunohost.org/integration/bookstack.svg )](https://dash.yunohost.org/appci/app/bookstack) ![](https://ci-apps.yunohost.org/ci/badges/bookstack.status.svg) ![](https://ci-apps.yunohost.org/ci/badges/bookstack.maintain.svg)
[![Installer BookStack avec YunoHost ](https://install-app.yunohost.org/install-with-yunohost.svg )](https://install-app.yunohost.org/?app=bookstack)
2021-02-01 14:42:41 +01:00
2021-05-24 18:27:31 +02:00
*[Read this readme in english.](./README.md)*
*[Lire ce readme en français.](./README_fr.md)*
2021-02-01 14:42:41 +01:00
2021-06-22 08:41:26 +02:00
> *Ce package vous permet d'installer BookStack 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.*
2021-02-01 14:42:41 +01:00
2021-05-24 18:27:31 +02:00
## Vue d'ensemble
2021-02-01 14:42:41 +01:00
2022-01-29 15:29:42 +01:00
BookStack is an opinionated wiki system that provides a pleasant and simple out of the box experience. New users to an instance should find the experience intuitive and only basic word-processing skills should be required to get involved in creating content on BookStack. The platform should provide advanced power features to those that desire it but they should not interfere with the core simple user experience.
2021-02-01 14:42:41 +01:00
2022-02-07 19:29:35 +01:00
### Features
2022-03-02 08:28:16 +01:00
2022-02-07 19:29:35 +01:00
- Multi-Factor Authentication
- Dark & Light Modes
- LDAP Authentication
- Optional Markdown Editor
- Multi-Lingual
2022-01-29 15:29:42 +01:00
2022-02-07 19:29:35 +01:00
2022-05-09 22:39:19 +02:00
**Version incluse :** 22.04.2~ynh1
2021-02-01 14:42:41 +01:00
2021-06-22 08:41:26 +02:00
**Démo :** https://demo.bookstackapp.com
2021-02-01 14:42:41 +01:00
2021-05-24 18:27:31 +02:00
## Captures d'écran
2021-02-01 14:42:41 +01:00
2021-06-22 08:41:26 +02:00
![](./doc/screenshots/bookstack-hero-screenshot.jpg)
2021-02-01 14:42:41 +01:00
2021-05-24 18:27:31 +02:00
## Avertissements / informations importantes
2021-02-01 14:42:41 +01:00
2022-03-02 08:28:16 +01:00
## Configuration
BookStack utilise l'authentification LDAP par défaut.
2021-02-01 14:42:41 +01:00
2022-03-22 09:35:39 +01:00
Vous pouvez passer à l'authentification standard dans le webadmin -> Bookstack -> paramètre du panneau de configuration.
2022-03-02 08:28:16 +01:00
Pour la première connexion avec une authentification standard, utilisez les informations d'identification par défaut `admin@admin.com` et `password` . Vous devez modifier ces informations immédiatement après vous être connecté pour la première fois.
2021-02-01 14:42:41 +01:00
2021-05-24 18:27:31 +02:00
## Documentations et ressources
2021-02-01 14:42:41 +01:00
2021-06-22 08:41:26 +02:00
* Site officiel de l'app : https://www.bookstackapp.com
2022-02-07 19:29:35 +01:00
* Documentation officielle utilisateur : https://www.bookstackapp.com/docs/user/
* Documentation officielle de l'admin : https://www.bookstackapp.com/docs/admin/
2021-06-22 08:41:26 +02:00
* Dépôt de code officiel de l'app : https://github.com/BookStackApp/BookStack
* Documentation YunoHost pour cette app : https://yunohost.org/app_bookstack
* Signaler un bug : https://github.com/YunoHost-Apps/bookstack_ynh/issues
2021-02-01 14:42:41 +01:00
## Informations pour les développeurs
2021-05-24 18:27:31 +02:00
Merci de faire vos pull request sur la [branche testing ](https://github.com/YunoHost-Apps/bookstack_ynh/tree/testing ).
2021-02-01 14:42:41 +01:00
2021-05-24 18:27:31 +02:00
Pour essayer la branche testing, procédez comme suit.
2021-02-01 14:42:41 +01:00
```
sudo yunohost app install https://github.com/YunoHost-Apps/bookstack_ynh/tree/testing --debug
2021-06-22 08:41:26 +02:00
ou
2021-02-01 14:42:41 +01:00
sudo yunohost app upgrade bookstack -u https://github.com/YunoHost-Apps/bookstack_ynh/tree/testing --debug
```
2021-05-24 18:27:31 +02:00
2021-06-22 08:41:26 +02:00
**Plus d'infos sur le packaging d'applications :** https://yunohost.org/packaging_apps