mirror of https://github.com/YunoHost-Apps/bookstack_ynh.git synced 2024-09-03 18:16:02 +02:00

BookStack package for YunoHost

bookstack personal-knowledge-base yunohost

Find a file

Éric Gaspar d5e9deea96 Update .env.example.complete		2022-07-07 14:29:40 +02:00
.github	Testing (#69 )	2022-05-25 18:35:13 +02:00
conf	Update .env.example.complete	2022-07-07 14:29:40 +02:00
doc	Update DESCRIPTION.md	2022-06-28 13:52:32 +02:00
scripts	Update upgrade	2022-06-25 18:27:11 +02:00
check_process	Testing (#62 )	2022-03-22 09:35:39 +01:00
config_panel.toml	Testing (#52 )	2022-02-01 16:43:20 +01:00
LICENSE	Initial commit	2019-07-29 12:00:26 +02:00
manifest.json	22.06.2	2022-06-28 13:27:51 +02:00
README.md	Auto-update README	2022-06-28 11:52:38 +00:00
README_fr.md	Auto-update README	2022-06-28 11:27:56 +00:00

README.md

BookStack for YunoHost

Lire ce readme en français.

This package allows you to install BookStack quickly and simply on a YunoHost server. If you don't have YunoHost, please consult the guide 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: 22.06.2~ynh1

Demo: https://demo.bookstackapp.com

Screenshots

Disclaimers / important information

Configuration

BookStack uses LDAP authentication by default.

You can switch to standard authentication in the webadmin -> bookstack -> config panel setting.

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.

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 documentation for this app: https://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.

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

More info regarding app packaging: https://yunohost.org/packaging_apps