mirror of
https://github.com/YunoHost-Apps/bookstack_ynh.git
synced 2024-09-03 18:16:02 +02:00
67af6e0761
* restart config panel * Update manifest.toml * Standard (#119) * fix * Update manifest.toml * Update manifest.toml * Update POST_INSTALL.md * Update POST_INSTALL_fr.md * fix * Update manifest.toml * Auto-update README * Update tests.toml * Update tests.toml * remove standard * Update manifest.toml * Auto-update README * Update tests.toml * Update manifest.toml * Update manifest.toml * Update install * Update manifest.toml * Auto-update README * Update manifest.toml * Auto-update README * cleaning * Update manifest.toml * Auto-update README * Update manifest.toml * Auto-update README * Upgrade to v23.6.2 (#128) * Upgrade to v23.6.2 * Auto-update README * Auto-update README * Update manifest.toml * Add maintenance * Update config_panel.toml * Update config * Update config_panel.toml * Update config * Update manifest.toml * Update config * Update config * fix * Update manifest.toml * Auto-update README * Update manifest.toml * Auto-update README * Update manifest.toml * Auto-update README * Update manifest.toml * Update manifest.toml * Auto-update README * Update manifest.toml * Auto-update README * Mail (#139) * fix mail * Auto-update README * Update .env.example * Update .env.example * Update .env.example * Update .env.example * Update .env.example --------- Co-authored-by: yunohost-bot <yunohost@yunohost.org> * Update manifest.toml * Auto-update README * Update manifest.toml * Update install * fix * fix * Auto-update README * Update systemd.service * Update manifest.toml * Update manifest.toml * Auto-update README * Update manifest.toml * Update manifest.toml * Auto-update README --------- Co-authored-by: yunohost-bot <yunohost@yunohost.org> Co-authored-by: YunoHost Bot <yunohost-bot@users.noreply.github.com>
61 lines
2.5 KiB
Markdown
61 lines
2.5 KiB
Markdown
<!--
|
|
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
|
|
|
|
[![Integration level](https://dash.yunohost.org/integration/bookstack.svg)](https://dash.yunohost.org/appci/app/bookstack) ![Working status](https://ci-apps.yunohost.org/ci/badges/bookstack.status.svg) ![Maintenance status](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)
|
|
|
|
*[Lire ce readme en français.](./README_fr.md)*
|
|
|
|
> *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.*
|
|
|
|
## Overview
|
|
|
|
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.
|
|
|
|
### Features
|
|
|
|
- Multi-Factor Authentication
|
|
- Dark & Light Modes
|
|
- LDAP Authentication
|
|
- Markdown Editor
|
|
- WYSIWYG Editing
|
|
- Multi-Lingual
|
|
- Diagrams.net Integration
|
|
|
|
|
|
**Shipped version:** 23.10.2~ynh1
|
|
|
|
**Demo:** https://demo.bookstackapp.com
|
|
|
|
## Screenshots
|
|
|
|
![Screenshot of BookStack](./doc/screenshots/screenshot.png)
|
|
|
|
## Documentation and resources
|
|
|
|
* Official app website: <https://www.bookstackapp.com>
|
|
* Official user documentation: <https://www.bookstackapp.com/docs/user/>
|
|
* Official admin documentation: <https://www.bookstackapp.com/docs/admin/>
|
|
* Upstream app code repository: <https://github.com/BookStackApp/BookStack>
|
|
* YunoHost Store: <https://apps.yunohost.org/app/bookstack>
|
|
* Report a bug: <https://github.com/YunoHost-Apps/bookstack_ynh/issues>
|
|
|
|
## 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.
|
|
|
|
``` bash
|
|
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
|
|
```
|
|
|
|
**More info regarding app packaging:** <https://yunohost.org/packaging_apps>
|