2021-05-24 18:27:31 +02:00
<!--
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.
-->
2019-07-29 19:50:23 +02:00
2021-05-24 18:27:31 +02:00
# BookStack for YunoHost
2019-07-29 19:50:23 +02:00
2021-06-22 08:41:26 +02:00
[](https://dash.yunohost.org/appci/app/bookstack)  
[](https://install-app.yunohost.org/?app=bookstack)
2019-07-29 19:50:23 +02:00
2021-05-24 18:27:31 +02:00
*[Lire ce readme en français.](./README_fr.md)*
2019-07-29 19:50:23 +02:00
2021-06-22 08:41:26 +02:00
> *This package allows you to install BookStack quickly and simply on a YunoHost server.
2021-05-24 18:27:31 +02:00
If you don't have YunoHost, please consult [the guide ](https://yunohost.org/#/install ) to learn how to install it.*
2019-07-29 19:50:23 +02:00
2021-05-24 18:27:31 +02:00
## Overview
2019-07-29 19:50:23 +02: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.
2019-07-29 19:50:23 +02: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
**Shipped version:** 22.04.2~ynh1
2021-02-01 14:42:41 +01:00
2021-05-24 18:27:31 +02:00
**Demo:** https://demo.bookstackapp.com
2021-02-01 14:42:41 +01:00
2021-05-24 18:27:31 +02:00
## Screenshots
2021-02-01 14:42:41 +01:00
2021-06-22 08:41:26 +02:00
2021-02-01 14:42:41 +01:00
2021-05-24 18:27:31 +02:00
## Disclaimers / important information
2021-02-01 14:42:41 +01:00
2021-05-24 18:27:31 +02:00
## Configuration
2021-02-01 14:42:41 +01:00
2022-02-01 16:43:20 +01:00
BookStack uses LDAP authentication by default.
2021-02-01 14:42:41 +01:00
2022-03-22 09:35:39 +01:00
You can switch to standard authentication in the webadmin -> bookstack -> config panel setting.
2022-02-01 16:43:20 +01:00
For the first time Login with standard authentication, use the default credentials `admin@admin.com` and `password` . You should change these details immediately after logging in for the first time.
2021-05-24 18:27:31 +02:00
## Documentation and resources
2021-02-01 14:42:41 +01:00
2021-05-24 18:27:31 +02:00
* Official app website: https://www.bookstackapp.com
2022-02-07 19:29:35 +01:00
* Official user documentation: https://www.bookstackapp.com/docs/user/
* Official admin documentation: https://www.bookstackapp.com/docs/admin/
2021-06-22 08:41:26 +02:00
* Upstream app code repository: https://github.com/BookStackApp/BookStack
2021-05-24 18:27:31 +02:00
* YunoHost documentation for this app: https://yunohost.org/app_bookstack
* Report a bug: https://github.com/YunoHost-Apps/bookstack_ynh/issues
2021-02-01 14:42:41 +01:00
## Developer info
Please send your pull request to the [testing branch ](https://github.com/YunoHost-Apps/bookstack_ynh/tree/testing ).
To try the testing branch, please proceed like that.
```
sudo yunohost app install https://github.com/YunoHost-Apps/bookstack_ynh/tree/testing --debug
or
sudo yunohost app upgrade bookstack -u https://github.com/YunoHost-Apps/bookstack_ynh/tree/testing --debug
```
2021-05-24 18:27:31 +02:00
**More info regarding app packaging:** https://yunohost.org/packaging_apps
