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

Auto-update README

Browse source
This commit is contained in:
Yunohost-Bot 2021-05-24 13:16:05 +00:00 committed by Yunohost-Bot
parent cc9cda7802
commit 426258ad6a
2 changed files with 62 additions and 86 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

72
README.md
View file

@ -1,27 +1,40 @@
---
<!--
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.
-->
# BookStack for YunoHost # BookStack for YunoHost
[![Integration level](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) [![Integration level](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)
[![Install BookStack with YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=bookstack) [![Install bookstack with YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=bookstack)
*[Lire ce readme en français.](./README_fr.md)* *[Lire ce readme en français.](./README_fr.md)*
> *This package allows you to install BookStack quickly and simply on a YunoHost server. > *This package allows you to install bookstack 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.* If you don't have YunoHost, please consult [the guide](https://yunohost.org/#/install) to learn how to install it.*
## Overview ## Overview
BookStack is a simple, self-hosted, easy-to-use platform for organising and storing information. It is an opinionated wiki system that provides a pleasant and simple out of the box experience.
BookStack is built using PHP, on top of the Laravel framework and it uses MySQL to store data. Platform to create documentation/wiki content
**Shipped version:** 21.04.6~ynh1
**Demo:** https://demo.bookstackapp.com
**Shipped version:** 21.04.6
## Screenshots ## Screenshots
![](https://www.bookstackapp.com/images/bookstack-hero-screenshot.jpg)
## Demo ![](./doc/screenshots/bookstack-hero-screenshot.jpg)
* [Official demo](https://demo.bookstackapp.com/)
## Disclaimers / important information
## Configuration ## Configuration
@ -29,39 +42,16 @@ For the first time Login, use the default credentials `admin@admin.com` and `pas
* How to configure this app: From an admin panel, a plain file with SSH, or any other way. * How to configure this app: From an admin panel, a plain file with SSH, or any other way.
## Documentation
* Official documentation: https://www.bookstackapp.com/docs/
* YunoHost documentation: https://yunohost.org/en/app_bookstack
## YunoHost specific features ## Documentation and resources
#### Multi-user support * Official app website: https://www.bookstackapp.com
* Official user documentation: https://yunohost.org/en/app_bookstack
* Are LDAP and HTTP auth supported? **Yes** * Official admin documentation: https://www.bookstackapp.com/docs
* Can the app be used by multiple users? **Yes** * Upstream app code repository: https://github.com/BookStackApp/BookStack
* YunoHost documentation for this app: https://yunohost.org/app_bookstack
#### Supported architectures * Report a bug: https://github.com/YunoHost-Apps/bookstack_ynh/issues
* x86-64 - [![Build Status](https://ci-apps.yunohost.org/ci/logs/bookstack.svg)](https://ci-apps.yunohost.org/ci/apps/bookstack/)
* ARMv8-A - [![Build Status](https://ci-apps-arm.yunohost.org/ci/logs/bookstack.svg)](https://ci-apps-arm.yunohost.org/ci/apps/bookstack/)
## Limitations
* Any known limitations.
## Additional information
* Other info you would like to add about this app.
## Links
* Report a bug: https://github.com/YunoHost-Apps/bookstack_ynh/issues
* App website: https://www.bookstackapp.com/
* Upstream app repository: https://github.com/BookStackApp/BookStack
* YunoHost website: https://yunohost.org/
---
## Developer info ## Developer info
@ -73,3 +63,5 @@ sudo yunohost app install https://github.com/YunoHost-Apps/bookstack_ynh/tree/te
or or
sudo yunohost app upgrade bookstack -u https://github.com/YunoHost-Apps/bookstack_ynh/tree/testing --debug sudo yunohost app upgrade bookstack -u https://github.com/YunoHost-Apps/bookstack_ynh/tree/testing --debug
``` ```
**More info regarding app packaging:** https://yunohost.org/packaging_apps

76
README_fr.md
View file

@ -1,73 +1,57 @@
# BookStack pour YunoHost # BookStack pour YunoHost
[![Integration level](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) [![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) [![Installer bookstack avec YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=bookstack)
*[Read this readme in english.](./README.md)* *[Read this readme in english.](./README.md)*
*[Lire ce readme en français.](./README_fr.md)*
> *Ce package vous permet d'installer BookStack rapidement et simplement sur un serveur YunoHost. > *This package allows you to install bookstack quickly and simply on a YunoHost server.
Si vous n'avez pas YunoHost, consultez [le guide](https://yunohost.org/install) pour apprendre comment l'installer.* If you don't have YunoHost, please consult [the guide](https://yunohost.org/#/install) to learn how to install it.*
## Overview ## Vue d'ensemble
BookStack est une plate-forme simple, auto-hébergée et facile à utiliser pour organiser et stocker des informations.
**Version incluse :** 21.04.6 Plateforme pour créer du contenu de documentation/wiki
## Screenshots **Version incluse:** 21.04.6~ynh1
![](https://www.bookstackapp.com/images/bookstack-hero-screenshot.jpg) **Démo:** https://demo.bookstackapp.com
## Démo
* [Démo officielle](https://demo.bookstackapp.com/) ## Captures d'écran
![](./doc/screenshots/bookstack-hero-screenshot.jpg)
## Avertissements / informations importantes
## Configuration ## Configuration
Login using the default admin details `admin@admin.com` with a password of `password`. You should change these details immediately after logging in for the first time. Login using the default admin details `admin@admin.com` with a password of `password`. You should change these details immediately after logging in for the first time.
* How to configure this app: From an admin panel, a plain file with SSH, or any other way.
## Documentation
* Documentation officielle : https://www.bookstackapp.com/docs/ ## Documentations et ressources
* Documentation YunoHost : https://yunohost.org/fr/app_bookstack
## Caractéristiques spécifiques YunoHost * Site official de l'app : https://www.bookstackapp.com
* Documentation officielle utilisateur: https://yunohost.org/en/app_bookstack
#### Support multi-utilisateur * Documentation officielle de l'admin: https://www.bookstackapp.com/docs
* Dépôt de code officiel de l'app: https://github.com/BookStackApp/BookStack
* L'authentification LDAP et HTTP est-elle prise en charge ? **Oui** * Documentation YunoHost pour cette app: https://yunohost.org/app_bookstack
* L'application peut-elle être utilisée par plusieurs utilisateurs ? **Oui** * Signaler un bug: https://github.com/YunoHost-Apps/bookstack_ynh/issues
#### Architectures supportées
* x86-64 - [![Build Status](https://ci-apps.yunohost.org/ci/logs/bookstack.svg)](https://ci-apps.yunohost.org/ci/apps/bookstack/)
* ARMv8-A - [![Build Status](https://ci-apps-arm.yunohost.org/ci/logs/bookstack.svg)](https://ci-apps-arm.yunohost.org/ci/apps/bookstack/)
## Limitations
* Limitations connues.
## Informations additionnelles
* Autres informations que vous souhaitez ajouter sur cette application.
## Liens
* Signaler un bug : https://github.com/YunoHost-Apps/bookstack_ynh/issues
* Site de l'application : https://www.bookstackapp.com/
* Dépôt de l'application principale : https://github.com/BookStackApp/BookStack
* Site web YunoHost : https://yunohost.org/
---
## Informations pour les développeurs ## Informations pour les développeurs
Please send your pull request to the [testing branch](https://github.com/YunoHost-Apps/bookstack_ynh/tree/testing). Merci de faire vos pull request sur la [branche testing](https://github.com/YunoHost-Apps/bookstack_ynh/tree/testing).
To try the testing branch, please proceed like that. Pour essayer la branche testing, procédez comme suit.
``` ```
sudo yunohost app install https://github.com/YunoHost-Apps/bookstack_ynh/tree/testing --debug sudo yunohost app install https://github.com/YunoHost-Apps/bookstack_ynh/tree/testing --debug
or or
sudo yunohost app upgrade bookstack -u https://github.com/YunoHost-Apps/bookstack_ynh/tree/testing --debug sudo yunohost app upgrade bookstack -u https://github.com/YunoHost-Apps/bookstack_ynh/tree/testing --debug
``` ```
**Plus d'infos sur le packaging d'applications:** https://yunohost.org/packaging_apps